BehaviorCollection Class Info:
- Class Declaration:
class BehaviorCollection extends Object
- File name:
- cake/libs/model/model_behavior.php
- Description:
Model behavior collection class.
Defines the Behavior interface, and contains common model interaction functionality.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.model
Properties:
-
__mappedMethods array
Keeps a list of all methods which have been mapped with regular expressions
-
__methods array
Keeps a list of all methods of attached behaviors
-
modelName string
Stores a reference to the attached name
Method Summary:
- attach( $behavior, $config = array ( ) )
- attached( $name = NULL )
- cakeError( $method, $messages = array ( ) )
- __construct( )
- detach( $name )
- disable( $name )
- dispatchMethod( $model, $method, $params = array ( ), $strict = false )
- enable( $name )
- enabled( $name = NULL )
- init( $modelName, $behaviors = array ( ) )
- log( $msg, $type = 2 )
- methods( )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- toString( )
- trigger( $model, $callback, $params = array ( ), $options = array ( ) )
attach
topAttaches a behavior to a model
- Parameters:
-
-
string $behavior required
CamelCased name of the behavior to load
-
array $config optional array ( )
Behavior configuration parameters
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 281
- Return
boolean True on success, false on failure
- Access
public
attached
topGets the list of attached behaviors, or, whether the given behavior is attached
- Parameters:
-
-
string $name optional NULL
Optional. The name of the behavior to check the status of. If omitted, returns an array of currently-attached behaviors
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 527
- Return
mixed If $name is specified, returns the boolean status of the corresponding behavior. Otherwise, returns an array of all attached behaviors.
- Access
public
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
detach
topDetaches a behavior from a model
- Parameters:
-
-
string $name required
CamelCased name of the behavior to unload
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 374
- Return
void
- Access
public
disable
topDisables callbacks on a behavior or array of behaviors. Public behavior methods are still callable as normal.
- Parameters:
-
-
mixed $name required
CamelCased name of the behavior(s) to disable (string or array)
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 407
- Return
void
- Access
public
dispatchMethod
topDispatches a behavior method
- Parameters:
-
-
$model required
-
$method required
-
$params optional array ( )
-
$strict optional false
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 437
- Return
array All methods for all behaviors attached to this object
- Access
public
enable
topEnables callbacks on a behavior or array of behaviors
- Parameters:
-
-
mixed $name required
CamelCased name of the behavior(s) to enable (string or array)
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 395
- Return
void
- Access
public
enabled
topGets the list of currently-enabled behaviors, or, the current status of a single behavior
- Parameters:
-
-
string $name optional NULL
Optional. The name of the behavior to check the status of. If omitted, returns an array of currently-enabled behaviors
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 424
- Return
mixed If $name is specified, returns the boolean status of the corresponding behavior. Otherwise, returns an array of all enabled behaviors.
- Access
public
init
topAttaches a model object and loads a list of behaviors
- Parameters:
-
-
$modelName required
-
$behaviors optional array ( )
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 263
- Access
public
- Return
void
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
methods
topGets the method list for attached behaviors, i.e. all public, non-callback methods
- Method defined in:
- cake/libs/model/model_behavior.php on line 514
- Return
array All public methods for all behaviors attached to this collection
- Access
public
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls 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 required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows 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.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
trigger
topDispatches a behavior callback on all attached behavior objects
- Parameters:
-
-
model $model required
-
string $callback required
-
array $params optional array ( )
-
array $options optional array ( )
-
- Method defined in:
- cake/libs/model/model_behavior.php on line 482
- Return
mixed
- Access
public
