Class ContainableBehavior

beforeFindsource public

beforeFind( Model $Model , array $query )

Runs before a find() operation. Used to allow 'contain' setting as part of the find call, like this:

Model->find('all', array('contain' => array('Model1', 'Model2')));

Model->find('all', array('contain' => array(
        'Model1' => array('Model11', 'Model12'),
        'Model2',
        'Model3' => array(
                'Model31' => 'Model311',
                'Model32',
                'Model33' => array('Model331', 'Model332')
)));

Parameters

Model $Model

Model using the behavior

array $query

Query parameters as set by cake

Returns

array
array

Overrides

ModelBehavior::beforeFind()

containsource public

contain( Model $Model )

Unbinds all relations from a model except the specified ones. Calling this function without parameters unbinds all related models.

Parameters

Model $Model

Model on which binding restriction is being applied

Link

http://book.cakephp.org/2.0/en/core-libraries/behaviors/containable.html#using-containable

containmentssource public

containments( Model $Model , array $contain , array $containments array() , boolean $throwErrors null )

Process containments for model.

Parameters

Model $Model

Model on which binding restriction is being applied

array $contain

Parameters to use for restricting this model

array $containments optional array()

Current set of containments

boolean $throwErrors optional null

Whether non-existent bindings show throw errors

Returns

array
Containments

containmentsMapsource public

containmentsMap( array $containments )

Build the map of containments

Parameters

array $containments

Containments

Returns

array
Built containments

fieldDependenciessource public

fieldDependencies( Model $Model , array $map , array|boolean $fields array() )

Calculate needed fields to fetch the required bindings for the given model.

Parameters

Model $Model

Model

array $map

Map of relations for given model

array|boolean $fields optional array()

If array, fields to initially load, if false use $Model as primary model

Returns

array
Fields

resetBindingssource public

resetBindings( Model $Model )

Permanently restore the original binding settings of given model, useful for restoring the bindings after using 'reset' => false as part of the contain call.

Parameters

Model $Model

Model on which to reset bindings

setupsource public

setup( Model $Model , array $settings array() )

Initiate behavior for the model using specified settings.

Available settings:

• recursive: (boolean, optional) set to true to allow containable to automatically determine the recursiveness level needed to fetch specified models, and set the model recursiveness to this level. setting it to false disables this feature. DEFAULTS TO: true
• notices: (boolean, optional) issues E_NOTICES for bindings referenced in a containable call that are not valid. DEFAULTS TO: true
• autoFields: (boolean, optional) auto-add needed fields to fetch requested bindings. DEFAULTS TO: true

Parameters

Model $Model

Model using the behavior

array $settings optional array()

Settings to override for model.

Overrides

ModelBehavior::setup()

_addToWhitelistsource protected

_addToWhitelist( Model $model , string $field )

If $model's whitelist property is non-empty, $field will be added to it. Note: this method should only be used in beforeValidate or beforeSave to ensure that it only modifies the whitelist for the current save operation. Also make sure you explicitly set the value of the field which you are allowing.

Parameters

Model $model

Model using this behavior

string $field

Field to be added to $model's whitelist

afterDeletesource public

afterDelete( Model $model )

After delete is called after any delete occurs on the attached model.

Parameters

Model $model

Model using this behavior

afterFindsource public

afterFind( Model $model , mixed $results , boolean $primary false )

After find callback. Can be used to modify any results returned by find.

Parameters

Model $model

Model using this behavior

mixed $results

The results of the find operation

boolean $primary optional false

Whether this model is being queried directly (vs. being queried as an association)

Returns

mixed
An array value will replace the value of $results - any other value will be ignored.

afterSavesource public

afterSave( Model $model , boolean $created , array $options array() )

afterSave is called after a model is saved.

Parameters

Model $model

Model using this behavior

boolean $created

True if this save created a new record

array $options optional array()

Options passed from Model::save().

Returns

boolean
bool

See

Model::save()

afterValidatesource public

afterValidate( Model $model )

afterValidate is called just after model data was validated, you can use this callback to perform any data cleanup or preparation if needed

Parameters

Model $model

Model using this behavior

Returns

mixed
False will stop this event from being passed to other behaviors

beforeDeletesource public

beforeDelete( Model $model , boolean $cascade true )

Before delete is called before any delete occurs on the attached model, but after the model's beforeDelete is called. Returning false from a beforeDelete will abort the delete.

Parameters

Model $model

Model using this behavior

boolean $cascade optional true

If true records that depend on this record will also be deleted

Returns

mixed
False if the operation should abort. Any other result will continue.

beforeSavesource public

beforeSave( Model $model , array $options array() )

beforeSave is called before a model is saved. Returning false from a beforeSave callback will abort the save operation.

Parameters

Model $model

Model using this behavior

array $options optional array()

Options passed from Model::save().

Returns

mixed
False if the operation should abort. Any other result will continue.

See

Model::save()

beforeValidatesource public

beforeValidate( Model $model , array $options array() )

beforeValidate is called before a model is validated, you can use this callback to add behavior validation rules into a models validate array. Returning false will allow you to make the validation fail.

Parameters

Model $model

Model using this behavior

array $options optional array()

Options passed from Model::save().

Returns

mixed
False or null will abort the operation. Any other result will continue.

See

Model::save()

cleanupsource public

cleanup( Model $model )

Clean up any initialization this behavior has done on a model. Called when a behavior is dynamically detached from a model using Model::detach().

Parameters

Model $model

Model using this behavior

See

BehaviorCollection::detach()

onErrorsource public

onError( Model $model , string $error )

DataSource error callback

Parameters

Model $model

Model using this behavior

string $error

Error generated in DataSource

__constructsource public

__construct( )

Constructor, no-op

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.

Parameters

array $properties

The name of the properties to merge.

string $class

The class to merge the property with.

boolean $normalize optional true

Set to true to run the properties through Hash::normalize() before merging.

_setsource protected

_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.

_stopsource protected

_stop( integer|string $status 0 )

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

Parameters

integer|string $status optional 0

see http://php.net/exit for values

dispatchMethodsource 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

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Convenience 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_ERR

Error type constant. Defined in app/Config/core.php.

null|string|array $scope optional null

The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.

Returns

boolean
Success of log write

requestActionsource public

requestAction( string|array $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.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.

Parameters

string|array $url

String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.

array $extra optional array()

if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.

Returns

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

toStringsource public

toString( )

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

Returns

string
The name of this class

array()

array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany')

array()

array()