CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.6 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.6
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • BakeTask
  • CommandTask
  • ControllerTask
  • DbConfigTask
  • ExtractTask
  • FixtureTask
  • ModelTask
  • PluginTask
  • ProjectTask
  • TemplateTask
  • TestTask
  • ViewTask

Class DbConfigTask

Task class for creating and updating the database configuration file.

AppShell
Extended by DbConfigTask
Package: Cake\Console\Command\Task
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Console/Command/Task/DbConfigTask.php

Properties summary

  • $_defaultConfig protected
    array
    Default configuration settings to use
  • $databaseClassName public
    string

    String name of the database config class name. Used for testing.

  • $path public
    string
    path to CONFIG directory

Method Summary

  • _interactive() protected
    Interactive interface
  • _verify() protected
    Output verification message and bake if it looks good
  • bake() public
    Assembles and writes database.php
  • execute() public
    Execution method always used for tasks
  • getConfig() public
    Get a user specified Connection name
  • getOptionParser() public
    Gets the option parser instance and configures it.
  • initialize() public
    initialization callback

Method Detail

_interactive() protected ¶

_interactive( )

Interactive interface

_verify() protected ¶

_verify( array $config )

Output verification message and bake if it looks good

Parameters
array $config
The config data.
Returns
boolean
True if user says it looks good, false otherwise

bake() public ¶

bake( array $configs )

Assembles and writes database.php

Parameters
array $configs
Configuration settings to use
Returns
boolean
Success

execute() public ¶

execute( )

Execution method always used for tasks

getConfig() public ¶

getConfig( )

Get a user specified Connection name

getOptionParser() public ¶

getOptionParser( )

Gets the option parser instance and configures it.

Returns
ConsoleOptionParser

initialize() public ¶

initialize( )

initialization callback

Properties detail

$_defaultConfig ¶

protected array

Default configuration settings to use

array(
    'name' => 'default',
    'datasource' => 'Database/Mysql',
    'persistent' => 'false',
    'host' => 'localhost',
    'login' => 'root',
    'password' => 'password',
    'database' => 'project_name',
    'schema' => null,
    'prefix' => null,
    'encoding' => null,
    'port' => null
)

$databaseClassName ¶

public string

String name of the database config class name. Used for testing.

'DATABASE_CONFIG'

$path ¶

public string

path to CONFIG directory

null
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs