Class ModelBehavior
Model behavior base class.
Defines the Behavior interface, and contains common model interaction functionality. Behaviors allow you to simulate mixins, and create reusable blocks of application logic, that can be reused across several models. Behaviors also provide a way to hook into model callbacks and augment their behavior.
Mixin methods
Behaviors can provide mixin like features by declaring public methods. These methods should expect the model instance to be shifted onto the parameter list.
function doSomething(Model $model, $arg1, $arg2) { //do something }
Would be called like $this->Model->doSomething($arg1, $arg2);.
Mapped methods
Behaviors can also define mapped methods. Mapped methods use pattern matching for method invocation. This
allows you to create methods similar to Model::findAllByXXX methods on your behaviors. Mapped methods need to
be declared in your behaviors $mapMethods array. The method signature for a mapped method is slightly different
than a normal behavior mixin method.
public $mapMethods = array('/do(\w+)/' => 'doSomething'); function doSomething(Model $model, $method, $arg1, $arg2) { //do something }
The above will map every doXXX() method call to the behavior. As you can see, the model is still the first parameter, but the called method name will be the 2nd parameter. This allows you to munge the method name for additional information, much like Model::findAllByXX.
- Object
-
ModelBehavior
Direct Subclasses
See: Model::$actsAs
See: BehaviorCollection::load()
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Model/ModelBehavior.php
Properties summary
-
$mapMethodspublicarrayAllows the mapping of preg-compatible regular expressions to public or private methods in this class, where the array key is a /-delimited regular expression, and the value is a class method. Similar to the functionality of the findBy* / findAllBy* magic methods.
-
$settingspublicarrayContains configuration settings for use with individual model objects. This is used because if multiple models use this Behavior, each will use the same object instance. Individual model settings should be stored as an associative array, keyed off of the model name.
Method Summary
-
_addToWhitelist() protected
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.
-
afterDelete() public
After delete is called after any delete occurs on the attached model. -
afterFind() public
After find callback. Can be used to modify any results returned by find. -
afterSave() public
afterSave is called after a model is saved. -
afterValidate() public
afterValidate is called just after model data was validated, you can use this callback to perform any data cleanup or preparation if needed
-
beforeDelete() public
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.
-
beforeFind() public
beforeFind can be used to cancel find operations, or modify the query that will be executed. By returning null/false you can abort a find. By returning an array you can modify/replace the query that is going to be run.
-
beforeSave() public
beforeSave is called before a model is saved. Returning false from a beforeSave callback will abort the save operation.
-
beforeValidate() public
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.
-
cleanup() public
Clean up any initialization this behavior has done on a model. Called when a behavior is dynamically detached from a model using Model::detach().
-
onError() public
DataSource error callback -
setup() public
Setup this behavior with the specified configuration settings.
Method Detail
_addToWhitelist() 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
afterDelete() public ¶
afterDelete( Model $model )
After delete is called after any delete occurs on the attached model.
Parameters
-
Model$model - Model using this behavior
afterFind() 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
An array value will replace the value of $results - any other value will be ignored.
afterSave() 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
See
afterValidate() 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
False will stop this event from being passed to other behaviors
beforeDelete() 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
False if the operation should abort. Any other result will continue.
beforeFind() public ¶
beforeFind( Model $model , array $query )
beforeFind can be used to cancel find operations, or modify the query that will be executed. By returning null/false you can abort a find. By returning an array you can modify/replace the query that is going to be run.
Parameters
-
Model$model - Model using this behavior
- array $query
- Data used to execute this query, i.e. conditions, order, etc.
Returns
False or null will abort the operation. You can return an array to replace the $query that will be eventually run.
beforeSave() 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
False if the operation should abort. Any other result will continue.
See
beforeValidate() 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
False or null will abort the operation. Any other result will continue.
See
cleanup() 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
Methods inherited from Object
_mergeVars() 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.
_set() 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.
_stop() 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
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
Returns the result of the method call
log() 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
Success of log write
requestAction() 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
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
$mapMethods ¶
Allows the mapping of preg-compatible regular expressions to public or private methods in this class, where the array key is a /-delimited regular expression, and the value is a class method. Similar to the functionality of the findBy* / findAllBy* magic methods.
array()
$settings ¶
Contains configuration settings for use with individual model objects. This is used because if multiple models use this Behavior, each will use the same object instance. Individual model settings should be stored as an associative array, keyed off of the model name.
See
array()