Class ControllerTask

Task class for creating and updating controller files.

AppShell

BakeTask

ControllerTask

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

Properties summary

$path public

array

path to Controller directory
$tasks public

array

Tasks to be loaded by this Task

Inherited Properties

connection, interactive, plugin

Method Summary

_askAboutMethods() protected

Interact with the user and ask about which methods (admin or regular they want to bake)
_doPropertyChoices() protected

Common code for property choice handling.
_interactive() protected

Interactive
all() public

Bake All the controllers at once. Will only bake controllers for models that exist.
bake() public

Assembles and writes a Controller file
bakeActions() public

Bake scaffold actions
bakeTest() public

Assembles and writes a unit test file
confirmController() public

Confirm a to be baked controller with the user
doComponents() public

Interact with the user and get a list of additional components
doHelpers() public

Interact with the user and get a list of additional helpers
execute() public

Execution method always used for tasks
getName() public

Forces the user to specify the controller he wants to bake, and returns the selected controller name.
getOptionParser() public

get the option parser.
initialize() public

Override initialize
listAll() public

Outputs and gets the list of possible controllers from database

Method Detail

_askAboutMethods() protected ¶

_askAboutMethods( )

Interact with the user and ask about which methods (admin or regular they want to bake)

Returns

array
Array containing (bakeRegular, bakeAdmin) answers

_doPropertyChoices() protected ¶

_doPropertyChoices( string $prompt , string $example )

Common code for property choice handling.

Parameters

string $prompt: A yes/no question to precede the list
string $example: A question for a comma separated list, with examples.

Returns

array
Array of values for property.

_interactive() protected ¶

_interactive( )

Interactive

all() public ¶

all( )

Bake All the controllers at once. Will only bake controllers for models that exist.

bake() public ¶

bake( string $controllerName , string $actions = '' , array $helpers = null , array $components = null )

Assembles and writes a Controller file

Parameters

string $controllerName: Controller name already pluralized and correctly cased.
string $actions optional '': Actions to add, or set the whole controller to use $scaffold (set $actions to 'scaffold')
array $helpers optional null: Helpers to use in controller
array $components optional null: Components to use in controller

Returns

string
Baked controller

bakeActions() public ¶

bakeActions( string $controllerName , string $admin = null , boolean $wannaUseSession = true )

Bake scaffold actions

Parameters

string $controllerName: Controller name
string $admin optional null: Admin route to use
boolean $wannaUseSession optional true: Set to true to use sessions, false otherwise

Returns

string
Baked actions

bakeTest() public ¶

bakeTest( string $className )

Assembles and writes a unit test file

Parameters

string $className: Controller class name

Returns

string
Baked test

confirmController() public ¶

confirmController( string $controllerName , string $useDynamicScaffold , array $helpers , array $components )

Confirm a to be baked controller with the user

Parameters

string $controllerName
string $useDynamicScaffold
array $helpers
array $components

doComponents() public ¶

doComponents( )

Interact with the user and get a list of additional components

Returns

array
Components the user wants to use.

doHelpers() public ¶

doHelpers( )

Interact with the user and get a list of additional helpers

Returns

array
Helpers that the user wants to use.

execute() public ¶

execute( )

Execution method always used for tasks

Overrides

BakeTask::execute()

getName() public ¶

getName( string $useDbConfig = null )

Forces the user to specify the controller he wants to bake, and returns the selected controller name.

Parameters

string $useDbConfig optional null: Connection name to get a controller name for.

Returns

string
Controller name

getOptionParser() public ¶

getOptionParser( )

get the option parser.

initialize() public ¶

initialize( )

Override initialize

listAll() public ¶

listAll( string $useDbConfig = null )

Outputs and gets the list of possible controllers from database

Parameters

string $useDbConfig optional null: Database configuration name

Returns

array
Set of controllers

Methods inherited from BakeTask

getPath() public ¶

getPath( )

Gets the path for output. Checks the plugin property and returns the correct path.

Returns

string
Path to output.

startup() public ¶

startup( )

Disable caching and enable debug for baking. This forces the most current database schema to be used.

Properties detail

`$path` ¶

public array

path to Controller directory

null

`$tasks` ¶

public array

Tasks to be loaded by this Task

array('Model', 'Test', 'Template', 'DbConfig', 'Project')

Packages

Classes

Class ControllerTask

Properties summary

Inherited Properties

Method Summary

_askAboutMethods() protected

_doPropertyChoices() protected

_interactive() protected

all() public

bake() public

bakeActions() public

bakeTest() public

confirmController() public

doComponents() public

doHelpers() public

execute() public

getName() public

getOptionParser() public

initialize() public

listAll() public

Method Detail

_askAboutMethods() protected ¶

Returns

_doPropertyChoices() protected ¶

Parameters

Returns

_interactive() protected ¶

all() public ¶

bake() public ¶

Parameters

Returns

bakeActions() public ¶

Parameters

Returns

bakeTest() public ¶

Parameters

Returns

confirmController() public ¶

Parameters

doComponents() public ¶

Returns

doHelpers() public ¶

Returns

execute() public ¶

Overrides

getName() public ¶

Parameters

Returns

getOptionParser() public ¶

initialize() public ¶

listAll() public ¶

Parameters

Returns

Methods inherited from BakeTask

getPath() public ¶

Returns

startup() public ¶

Properties detail

$path ¶

$tasks ¶

`$path` ¶

`$tasks` ¶