Class Scaffold
Scaffolding is a set of automatic views, forms and controllers for starting web development work faster.
Scaffold inspects your database tables, and making educated guesses, sets up a number of pages for each of your Models. These pages have data forms that work, and afford the web developer an early look at the data, and the possibility to over-ride scaffolded actions with custom-made ones.
- Object
-
Scaffold
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: controller/scaffold.php
Properties summary
-
$__passedVarspublicarrayList of variables to collect from the associated controller -
$actionpublicstringAction to be performed. -
$basepublicstringPath parts for creating links in views. -
$controllerpublicController object -
$extpublicarrayFile extension. Defaults to Cake's template ".ctp". -
$layoutpublicstringName of layout to use with this View. -
$modelpublicstringName of current model this view context is attached to -
$namepublicstringName of the controller to scaffold -
$paramspublicarrayArray of parameter data -
$pluginpublicstringPlugin name. -
$scaffoldTitlepublicstringTitle HTML element for current scaffolded view -
$subDirpublicstringSub-directory for this view file. -
$viewPathpublicstringPath to View.
Inherited Properties
Method Summary
-
__associations() public
Returns associations for controllers models. -
__construct() public
Construct and set up given controller with given parameters. -
__scaffold() public
When methods are now present in a controller scaffoldView is used to call default Scaffold methods if:
var $scaffold;
is placed in the controller's class definition.
-
__scaffoldDelete() public
Performs a delete on given scaffolded Model. -
__scaffoldError() public
Show a scaffold error -
__scaffoldForm() public
Renders an add or edit action for scaffolded model. -
__scaffoldIndex() public
Renders index action of scaffolded model. -
__scaffoldSave() public
Saves or updates the scaffolded model. -
__scaffoldView() public
Renders a view action of scaffolded model. -
_output() public
Outputs the content of a scaffold method passing it through the Controller::afterFilter()
Method Detail
__associations() public ¶
__associations( )
Returns associations for controllers models.
Returns
Associations for model
__construct() public ¶
__construct( string $controller , array $params )
Construct and set up given controller with given parameters.
Parameters
- string $controller
- $controller_class Name of controller
- array $params
- Parameters for scaffolding
Overrides
__scaffold() public ¶
__scaffold( array $params )
When methods are now present in a controller scaffoldView is used to call default Scaffold methods if:
var $scaffold;
is placed in the controller's class definition.
Parameters
- array $params
- Parameters for scaffolding
Returns
A rendered view of scaffold action, or showing the error
__scaffoldDelete() public ¶
__scaffoldDelete( array $params = array() )
Performs a delete on given scaffolded Model.
Parameters
- array $params optional array()
- Parameters for scaffolding
Returns
Success on delete, error if delete fails
__scaffoldError() public ¶
__scaffoldError( )
Show a scaffold error
Returns
A rendered view showing the error
__scaffoldForm() public ¶
__scaffoldForm( string $action = 'edit' )
Renders an add or edit action for scaffolded model.
Parameters
- string $action optional 'edit'
- Action (add or edit)
Returns
A rendered view with a form to edit or add a record in the Models database table
__scaffoldIndex() public ¶
__scaffoldIndex( array $params )
Renders index action of scaffolded model.
Parameters
- array $params
- Parameters for scaffolding
Returns
A rendered view listing rows from Models database table
__scaffoldSave() public ¶
__scaffoldSave( array $params = array() , string $action = 'edit' )
Saves or updates the scaffolded model.
Parameters
- array $params optional array()
- Parameters for scaffolding
- string $action optional 'edit'
- add or edt
Returns
Success on save/update, add/edit form if data is empty or error if save or update fails
__scaffoldView() public ¶
__scaffoldView( array $params )
Renders a view action of scaffolded model.
Parameters
- array $params
- Parameters for scaffolding
Returns
A rendered view of a row from Models database table
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
$__passedVars ¶
List of variables to collect from the associated controller
array('action', 'base', 'webroot', 'layout', 'name', 'viewPath', 'ext', 'params', 'data', 'plugin', 'cacheAction')