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. (https://cakefoundation.org)
License: MIT License
Location: Cake/Console/Command/Task/DbConfigTask.php

Properties summary

  • $_defaultConfig protected
    array
    Default configuration settings to use
  • 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
  • Gets the option parser instance and configures it.
  • initialize() public
    initialization callback

Method Detail

_interactive()source protected

_interactive( )

Interactive interface

_verify()source 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()source public

bake( array $configs )

Assembles and writes database.php

Parameters

array $configs
Configuration settings to use

Returns

boolean
Success

execute()source public

execute( )

Execution method always used for tasks

getConfig()source public

getConfig( )

Get a user specified Connection name

getOptionParser()source public

getOptionParser( )

Gets the option parser instance and configures it.

Returns

ConsoleOptionParser

initialize()source public

initialize( )

initialization callback

Properties detail

$_defaultConfigsource

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
)

$databaseClassNamesource

public string

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

'DATABASE_CONFIG'

$pathsource

public string

path to CONFIG directory

null

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-DbConfigTask.html