Class ViewTask
Task class for creating and updating view files.
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: tasks/view.php
Properties summary
-
$controllerNamepublicstringName of the controller being used -
$controllerPathpublicstringPath to controller to put views -
$pathpublicarraypath to VIEWS directory -
$pluginpublicstringName of plugin -
$scaffoldActionspublicarrayActions to use for scaffolding -
$taskspublicarrayTasks to be loaded by this Task -
$templatepublicstringThe template file to use
Inherited Properties
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'
-
bake() public
Assembles and writes bakes the view file. -
execute() public
Execution method always used for tasks -
getContent() public
Builds content from template and variables -
help() public
Displays help contents -
initialize() public
Override initialize
Method Detail
__associations() public ¶
__associations( $model )
Returns associations for controllers models.
Returns
$associations
__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
Returns an variables to be made available to a view template
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
Success
getContent() public ¶
getContent( string $template = null , array $vars = null )
Builds content from template and variables
Parameters
- string $template optional null
- file to use
- array $vars optional null
- passed for use in templates
Returns
content from template
Methods inherited from Shell
_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
_controllerName() public ¶
_controllerName( string $name )
Creates the proper controller plural name for the specified controller class name
Parameters
- string $name
- Controller class name
Returns
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
Path to controller
_loadDbConfig() public ¶
_loadDbConfig( )
Loads database file and constructs DATABASE_CONFIG class makes $this->DbConfig available to subclasses
Returns
_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
_modelKey() public ¶
_modelKey( string $name )
Creates the proper singular model key for associations
Parameters
- string $name
- Controller class name
Returns
Singular model key
_modelName() public ¶
_modelName( string $name )
Creates the proper controller camelized name (singularized) for the specified name
Parameters
- string $name
- Name
Returns
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
Model name
_pluralHumanName() public ¶
_pluralHumanName( string $name )
Creates the plural human name used in views
Parameters
- string $name
- Controller name
Returns
Plural human name
_pluralName() public ¶
_pluralName( string $name )
Creates the plural name for views
Parameters
- string $name
- Name to use
Returns
Plural name for views
_singularHumanName() public ¶
_singularHumanName( string $name )
Creates the singular human name used in views
Parameters
- string $name
- Controller name
Returns
Singular human name
_singularName() public ¶
_singularName( string $name )
creates the singular name for use in views.
Parameters
- string $name
Returns
$name
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
Success
err() public ¶
err( string $string )
Outputs to the stderr filehandle.
Parameters
- string $string
- Error text to output.
error() public ¶
error( string $title , string $msg )
Displays a formatted error message and exits the application
Parameters
- string $title
- Title of the error message
- string $msg
- Error message
getAdmin() public ¶
getAdmin( )
Checks for Configure::read('Routing.admin') and forces user to input it if not enabled
Returns
Admin route to use
hr() public ¶
hr( boolean $newline = false )
Outputs a series of minus characters to the standard output, acts as a visual separator.
Parameters
- boolean $newline optional false
- If true, the outputs gets an added newline.
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
the default value, or the user-provided input.
out() public ¶
out( string $string , boolean $newline = true )
Outputs to the stdout filehandle.
Parameters
- string $string
- String to output.
- boolean $newline optional true
- If true, the outputs gets an added newline.
shortPath() public ¶
shortPath( string $file )
Makes absolute file path easier to read
Parameters
- string $file
- Absolute file path
Returns
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
__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
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
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.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
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
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, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
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
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
The name of this class
Properties detail
$scaffoldActions ¶
Actions to use for scaffolding
array('index', 'view', 'add', 'edit')