Behavior to allow for dynamic and atomic manipulation of a Model's associations used for a find call. Most useful for limiting the amount of associations and data returned.
$runtime
public array
$types
public array
Runs before a find() operation. Used to allow 'contain' setting as part of the find call, like this:
Unbinds all relations from a model except the specified ones. Calling this function without parameters unbinds all related models.
Permanently restore the original binding settings of given model, useful for restoring the bindings after using 'reset' => false as part of the contain call.
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') )));
Model
$Model
$query
ModelBehavior::beforeFind()
contain( Model $Model )
Unbinds all relations from a model except the specified ones. Calling this function without parameters unbinds all related models.
Model
$Model
containments( Model $Model , array $contain , array $containments array() , boolean $throwErrors null )
Process containments for model.
Model
$Model
$contain
$containments
optional array() $throwErrors
optional null containmentsMap( array $containments )
Build the map of containments
$containments
fieldDependencies( Model $Model , array $map , array|boolean $fields array() )
Calculate needed fields to fetch the required bindings for the given model.
Model
$Model
$map
$fields
optional array() 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.
Model
$Model
setup( Model $Model , array $settings array() )
Initiate behavior for the model using specified settings.
Available settings:
Model
$Model
$settings
optional array() ModelBehavior::setup()
_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.
Model
$model
$field
afterDelete( Model $model )
After delete is called after any delete occurs on the attached model.
Model
$model
afterFind( Model $model , mixed $results , boolean $primary false )
After find callback. Can be used to modify any results returned by find.
Model
$model
$results
$primary
optional false afterSave( Model $model , boolean $created , array $options array() )
afterSave is called after a model is saved.
Model
$model
$created
$options
optional array() 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
Model
$model
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.
Model
$model
$cascade
optional true 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.
Model
$model
$options
optional array() 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.
Model
$model
$options
optional array() 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().
Model
$model
onError( Model $model , string $error )
DataSource error callback
Model
$model
$error
_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.
$properties
$class
$normalize
optional true _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.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 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
$method
$params
optional array() 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.
$msg
$type
optional LOG_ERR $scope
optional null The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
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()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$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.
$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.
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString( )
CakeObject-to-string conversion. Each class can override this method as necessary.
public array
Types of relationships available for models
array('belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany')
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-ContainableBehavior.html