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.

Package: Cake\Controller
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Controller/Scaffold.php

Properties summary

$_passedVars protected

array

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

boolean

Valid session.
$controller public

Controller

Controller object
$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
$request public

CakeRequest

Request object
$scaffoldTitle public

string

Title HTML element for current scaffolded view
$viewPath public

string

Path to View.

Method Summary

__construct() public

Construct and set up given controller with given parameters.
_associations() protected

Returns associations for controllers models.
_scaffold() protected

When methods are now present in a controller scaffoldView is used to call default Scaffold methods if: public $scaffold; is placed in the controller's class definition.
_scaffoldDelete() protected

Performs a delete on given scaffolded Model.
_scaffoldError() protected

Show a scaffold error
_scaffoldForm() protected

Renders an add or edit action for scaffolded model.
_scaffoldIndex() protected

Renders index action of scaffolded model.
_scaffoldSave() protected

Saves or updates the scaffolded model.
_scaffoldView() protected

Renders a view action of scaffolded model.
_sendMessage() protected

Sends a message to the user. Either uses Sessions or flash messages depending on the availability of a session

Method Detail

__construct() public ¶

__construct( Controller $controller , CakeRequest $request )

Construct and set up given controller with given parameters.

Parameters

Controller $controller: Controller to scaffold
CakeRequest $request: Request parameters.

Throws

MissingModelException

_associations() protected ¶

_associations( )

Returns associations for controllers models.

Returns

array
Associations for model

_scaffold() protected ¶

_scaffold( CakeRequest $request )

When methods are now present in a controller scaffoldView is used to call default Scaffold methods if: public $scaffold; is placed in the controller's class definition.

Parameters

CakeRequest $request: Request object for scaffolding

Throws

MissingActionException
When methods are not scaffolded.
MissingDatabaseException
When the database connection is undefined.

_scaffoldDelete() protected ¶

_scaffoldDelete( CakeRequest $request )

Performs a delete on given scaffolded Model.

Parameters

CakeRequest $request: Request for scaffolding

Returns

mixed
Success on delete, error if delete fails

Throws

MethodNotAllowedException
When HTTP method is not a DELETE
NotFoundException
When id being deleted does not exist.

_scaffoldError() protected ¶

_scaffoldError( )

Show a scaffold error

Returns

mixed
A rendered view showing the error

_scaffoldForm() protected ¶

_scaffoldForm( string $action = 'edit' )

Renders an add or edit action for scaffolded model.

Parameters

string $action optional 'edit': Action (add or edit)

_scaffoldIndex() protected ¶

_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() protected ¶

_scaffoldSave( CakeRequest $request , string $action = 'edit' )

Saves or updates the scaffolded model.

Parameters

CakeRequest $request: Request Object for scaffolding
string $action optional 'edit': add or edit

Returns

mixed
Success on save/update, add/edit form if data is empty or error if save or update fails

Throws

NotFoundException

_scaffoldView() protected ¶

_scaffoldView( CakeRequest $request )

Renders a view action of scaffolded model.

Parameters

CakeRequest $request: Request Object for scaffolding

Returns

mixed
A rendered view of a row from Models database table

Throws

NotFoundException

_sendMessage() protected ¶

_sendMessage( string $message )

Sends a message to the user. Either uses Sessions or flash messages depending on the availability of a session

Parameters

string $message: Message to display

Properties detail

`$_passedVars` ¶

protected array

List of variables to collect from the associated controller

array(
    'layout', 'name', 'viewPath', 'request'
)

`$_validSession` ¶

protected boolean

Valid session.

null

`$controller` ¶

public Controller

Controller object

null

`$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

`$request` ¶

public CakeRequest

Request object

`$scaffoldTitle` ¶

public string

Title HTML element for current scaffolded view

null

`$viewPath` ¶

public string

Path to View.

Packages

Classes

Class Scaffold

Properties summary

Method Summary

__construct() public

_associations() protected

_scaffold() protected

_scaffoldDelete() protected

_scaffoldError() protected

_scaffoldForm() protected

_scaffoldIndex() protected

_scaffoldSave() protected

_scaffoldView() protected

_sendMessage() protected

Method Detail

__construct() public ¶

Parameters

Throws

_associations() protected ¶

Returns

_scaffold() protected ¶

Parameters

Throws

_scaffoldDelete() protected ¶

Parameters

Returns

Throws

_scaffoldError() protected ¶

Returns

_scaffoldForm() protected ¶

Parameters

_scaffoldIndex() protected ¶

Parameters

Returns

_scaffoldSave() protected ¶

Parameters

Returns

Throws

_scaffoldView() protected ¶

Parameters

Returns

Throws

_sendMessage() protected ¶

Parameters

Properties detail