Class ViewTask

Task class for creating and updating view files.

Object

Shell

BakeTask

ViewTask

Package: cake\cake\console\libs\tasks
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: tasks/view.php

Properties summary

$controllerName public

string

Name of the controller being used
$controllerPath public

string

Path to controller to put views
$noTemplateActions public

array

An array of action names that don't require templates. These actions will not emit errors when doing bakeActions()
$path public

array

path to VIEWS directory
$scaffoldActions public

array

Actions to use for scaffolding
$tasks public

array

Tasks to be loaded by this Task
$template public

string

The template file to use

Inherited Properties

connection, interactive, plugin DbConfig, Dispatch, alias, args, className, command, name, params, shell, taskNames, uses

Method Summary

__associations() public

Returns associations for controllers models.
__interactive() public

Handles interactive baking
__loadController() public

Loads Controller and sets variables for the template Available template variables 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar', 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys', 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'
_methodsToBake() public

Get a list of actions that can / should have views baked for them.
all() public

Bake All views for All controllers.
bake() public

Assembles and writes bakes the view file.
bakeActions() public

Bake a view file for each of the supplied actions
customAction() public

handle creation of baking a custom action view file
execute() public

Execution method always used for tasks
getContent() public

Builds content from template and variables
getTemplate() public

Gets the template name based on the action name
help() public

Displays help contents
initialize() public

Override initialize

Method Detail

__associations() public ¶

__associations( $model )

Returns associations for controllers models.

Returns

array
$associations

__interactive() public ¶

__interactive( )

Handles interactive baking

__loadController() public ¶

__loadController( )

Loads Controller and sets variables for the template Available template variables 'modelClass', 'primaryKey', 'displayField', 'singularVar', 'pluralVar', 'singularHumanName', 'pluralHumanName', 'fields', 'foreignKeys', 'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'

Returns

array
Returns an variables to be made available to a view template

_methodsToBake() public ¶

_methodsToBake( )

Get a list of actions that can / should have views baked for them.

Returns

array
Array of action names that should be baked

all() public ¶

all( )

Bake All views for All controllers.

bake() public ¶

bake( string $action , string $content = '' )

Assembles and writes bakes the view file.

Parameters

string $action: Action to bake
string $content optional '': Content to write

Returns

boolean
Success

bakeActions() public ¶

bakeActions( array $actions , $vars )

Bake a view file for each of the supplied actions

Parameters

array $actions: Array of actions to make files for.
$vars

customAction() public ¶

customAction( )

handle creation of baking a custom action view file

execute() public ¶

execute( )

Execution method always used for tasks

getContent() public ¶

getContent( string $action , array $vars = null )

Builds content from template and variables

Parameters

string $action: name to generate content to
array $vars optional null: passed for use in templates

Returns

string
content from template

getTemplate() public ¶

getTemplate( string $action )

Gets the template name based on the action name

Parameters

string $action: name

Returns

string
template name

help() public ¶

help( )

Displays help contents

Overrides

Shell::help()

initialize() public ¶

initialize( )

Override initialize

Overrides

Shell::initialize()

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 for baking. This forces the most current database schema to be used.

Overrides

Shell::startup()

Methods inherited from Shell

__construct() public ¶

__construct( $dispatch )

Constructs this Shell instance.

Overrides

Object::__construct()

_checkArgs() public ¶

_checkArgs( integer $expectedNum , string $command = null )

Will check the number args matches otherwise throw an error

Parameters

integer $expectedNum: Expected number of paramters
string $command optional null: Command

_checkUnitTest() public ¶

_checkUnitTest( )

Action to create a Unit Test

Returns

boolean
Success

_controllerName() public ¶

_controllerName( string $name )

Creates the proper controller plural name for the specified controller class name

Parameters

string $name: Controller class name

Returns

string
Controller plural name

_controllerPath() public ¶

_controllerPath( string $name )

Creates the proper controller path for the specified controller class name

Parameters

string $name: Controller class name

Returns

string
Path to controller

_loadDbConfig() public ¶

_loadDbConfig( )

Loads database file and constructs DATABASE_CONFIG class makes $this->DbConfig available to subclasses

Returns

boolean

_loadModels() public ¶

_loadModels( )

if var $uses = true Loads AppModel file and constructs AppModel class makes $this->AppModel available to subclasses if var $uses is an array of models will load those models

Returns

boolean

_modelKey() public ¶

_modelKey( string $name )

Creates the proper underscored model key for associations

Parameters

string $name: Model class name

Returns

string
Singular model key

_modelName() public ¶

_modelName( string $name )

Creates the proper controller camelized name (singularized) for the specified name

Parameters

string $name: Name

Returns

string
Camelized and singularized controller name

_modelNameFromKey() public ¶

_modelNameFromKey( string $key )

Creates the proper model name from a foreign key

Parameters

string $key: Foreign key

Returns

string
Model name

_pluginPath() public ¶

_pluginPath( string $pluginName )

Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.

Parameters

string $pluginName: Name of the plugin you want ie. DebugKit

Returns

string
$path path to the correct plugin.

_pluralHumanName() public ¶

_pluralHumanName( string $name )

Creates the plural human name used in views

Parameters

string $name: Controller name

Returns

string
Plural human name

_pluralName() public ¶

_pluralName( string $name )

Creates the plural name for views

Parameters

string $name: Name to use

Returns

string
Plural name for views

_singularHumanName() public ¶

_singularHumanName( string $name )

Creates the singular human name used in views

Parameters

string $name: Controller name

Returns

string
Singular human name

_singularName() public ¶

_singularName( string $name )

creates the singular name for use in views.

Parameters

string $name

Returns

string
$name

_welcome() public ¶

_welcome( )

Displays a header for the shell

createFile() public ¶

createFile( string $path , string $contents )

Creates a file at given path

Parameters

string $path: Where to put the file.
string $contents: Content to put in the file.

Returns

boolean
Success

err() public ¶

err( mixed $message = null , integer $newlines = 1 )

Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.

Parameters

mixed $message optional null: A string or a an array of strings to output
integer $newlines optional 1: Number of newlines to append

error() public ¶

error( string $title , string $message = null )

Displays a formatted error message and exits the application with status code 1

Parameters

string $title: Title of the error
string $message optional null: An optional error message

hr() public ¶

hr( integer $newlines = 0 )

Outputs a series of minus characters to the standard output, acts as a visual separator.

Parameters

integer $newlines optional 0: Number of newlines to pre- and append

in() public ¶

in( string $prompt , mixed $options = null , string $default = null )

Prompts the user for input, and returns it.

Parameters

string $prompt: Prompt text.
mixed $options optional null: Array or string of options.
string $default optional null: Default input value.

Returns

Either
the default value, or the user-provided input.

loadTasks() public ¶

loadTasks( )

Loads tasks defined in var $tasks

Returns

boolean

nl() public ¶

nl( integer $multiplier = 1 )

Returns a single or multiple linefeeds sequences.

Parameters

integer $multiplier optional 1: Number of times the linefeed sequence should be repeated

Returns

string

out() public ¶

out( mixed $message = null , integer $newlines = 1 )

Outputs a single or multiple messages to stdout. If no parameters are passed outputs just a newline.

Parameters

mixed $message optional null: A string or a an array of strings to output
integer $newlines optional 1: Number of newlines to append

Returns

integer
Returns the number of bytes returned from writing to stdout.

shortPath() public ¶

shortPath( string $file )

Makes absolute file path easier to read

Parameters

string $file: Absolute file path

Returns

sting
short path

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$controllerName` ¶

public string

Name of the controller being used

null

`$controllerPath` ¶

public string

Path to controller to put views

null

`$noTemplateActions` ¶

public array

An array of action names that don't require templates. These actions will not emit errors when doing bakeActions()

array('delete')

`$path` ¶

public array

path to VIEWS directory

VIEWS

`$scaffoldActions` ¶

public array

Actions to use for scaffolding

array('index', 'view', 'add', 'edit')

`$tasks` ¶

public array

Tasks to be loaded by this Task

array('Project', 'Controller', 'DbConfig', 'Template')

`$template` ¶

public string

The template file to use

null

Classes

Functions

Class ViewTask

Properties summary

Inherited Properties

Method Summary

__associations() public

__interactive() public

__loadController() public

_methodsToBake() public

all() public

bake() public

bakeActions() public

customAction() public

execute() public

getContent() public

getTemplate() public

help() public

initialize() public

Method Detail

__associations() public ¶

Returns

__interactive() public ¶

__loadController() public ¶

Returns

_methodsToBake() public ¶

Returns

all() public ¶

bake() public ¶

Parameters

Returns

bakeActions() public ¶

Parameters

customAction() public ¶

execute() public ¶

getContent() public ¶

Parameters

Returns

getTemplate() public ¶

Parameters

Returns

help() public ¶

Overrides

initialize() public ¶

Overrides

Methods inherited from BakeTask

getPath() public ¶

Returns

startup() public ¶

Overrides

Methods inherited from Shell

__construct() public ¶

Overrides

_checkArgs() public ¶

Parameters

_checkUnitTest() public ¶

Returns

_controllerName() public ¶

Parameters

Returns

_controllerPath() public ¶

Parameters

Returns

_loadDbConfig() public ¶

Returns

_loadModels() public ¶

Returns

_modelKey() public ¶

Parameters

Returns

_modelName() public ¶

Parameters

Returns

_modelNameFromKey() public ¶

Parameters

Returns

_pluginPath() public ¶

Parameters

Returns

_pluralHumanName() public ¶

`$controllerName` ¶

`$controllerPath` ¶