Class Scaffold

Scaffolding is a set of automatic actions 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

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

Properties summary

$__passedVars public

array

List of variables to collect from the associated controller
$_validSession public

boolean

valid session.
$action public

string

Action to be performed.
$base public

string

Path parts for creating links in views.
$controller public

Controller

Controller object
$ext public

array

File extension. Defaults to Cake's template ".ctp".
$layout public

string

Name of layout to use with this View.
$model public

string

Name of current model this view context is attached to
$name public

string

Name of the controller to scaffold
$params public

array

Array of parameter data
$plugin public

string

Plugin name.
$scaffoldTitle public

string

Title HTML element for current scaffolded view
$subDir public

string

Sub-directory for this view file.
$viewPath public

string

Path to View.

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

array
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

Object::__construct()

__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

mixed
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

mixed
Success on delete, error if delete fails

__scaffoldError() public ¶

__scaffoldError( )

Show a scaffold error

Returns

mixed
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

mixed
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

mixed
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

mixed
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

mixed
A rendered view of a row from Models database table

_output() public ¶

_output( )

Outputs the content of a scaffold method passing it through the Controller::afterFilter()

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

`$__passedVars` ¶

public array

List of variables to collect from the associated controller

array(
    'action', 'base', 'webroot', 'layout', 'name',
    'viewPath', 'ext', 'params', 'data', 'plugin', 'cacheAction'
)

`$_validSession` ¶

public boolean

valid session.

null

`$action` ¶

public string

Action to be performed.

null

`$base` ¶

public string

Path parts for creating links in views.

null

`$controller` ¶

public Controller

Controller object

null

`$ext` ¶

public array

File extension. Defaults to Cake's template ".ctp".

'.ctp'

`$layout` ¶

public string

Name of layout to use with this View.

'default'

`$model` ¶

public string

Name of current model this view context is attached to

null

`$name` ¶

public string

Name of the controller to scaffold

null

`$params` ¶

public array

Array of parameter data

`$plugin` ¶

public string

Plugin name.

null

`$scaffoldTitle` ¶

public string

Title HTML element for current scaffolded view

null

`$subDir` ¶

public string

Sub-directory for this view file.

null

`$viewPath` ¶

public string

Path to View.

Classes

Functions

Class Scaffold

Properties summary

Method Summary

__associations() public

__construct() public

__scaffold() public

__scaffoldDelete() public

__scaffoldError() public

__scaffoldForm() public

__scaffoldIndex() public

__scaffoldSave() public

__scaffoldView() public

_output() public

Method Detail

__associations() public ¶

Returns

__construct() public ¶

Parameters

Overrides

__scaffold() public ¶

Parameters

Returns

__scaffoldDelete() public ¶

Parameters

Returns

__scaffoldError() public ¶

Returns

__scaffoldForm() public ¶

Parameters

Returns

__scaffoldIndex() public ¶

Parameters

Returns

__scaffoldSave() public ¶

Parameters

Returns

__scaffoldView() public ¶

Parameters

Returns

_output() public ¶

Methods inherited from Object

Object() public ¶

Returns

__openPersistent() public ¶

Parameters

_persist() public ¶

Parameters

Returns

_savePersistent() public ¶

Parameters

Returns

_set() public ¶

Parameters

_stop() public ¶

Parameters

cakeError() public ¶

Parameters

Returns

dispatchMethod() public ¶

Parameters

Returns

log() public ¶

Parameters

Returns

requestAction() public ¶

Parameters

Returns

toString() public ¶

Returns

Properties detail