Class TranslateBehavior
Short description for file.
Long description for file
- Object
-
ModelBehavior
-
TranslateBehavior
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: model/behaviors/translate.php
Properties summary
-
$runtimepublicarrayUsed for runtime configuration of model
Inherited Properties
Method Summary
-
_getLocale() public
Get selected locale for model -
afterDelete() public
afterDelete Callback -
afterFind() public
afterFind Callback -
afterSave() public
afterSave Callback -
beforeFind() public
beforeFind Callback -
beforeValidate() public
beforeValidate Callback -
bindTranslation() public
Bind translation for fields, optionally with hasMany association for fake field
-
cleanup() public
Callback -
setup() public
Callback -
translateModel() public
Get instance of model for translations -
unbindTranslation() public
Unbind translation for fields, optionally unbinds hasMany association for fake field
Method Detail
_getLocale() public ¶
_getLocale( $model )
Get selected locale for model
Returns
string or false
afterDelete() public ¶
afterDelete( object $model )
afterDelete Callback
Parameters
- object $model
- Model using this behavior
Overrides
afterFind() public ¶
afterFind( array $model , boolean $results , boolean $primary )
afterFind Callback
Parameters
- array $model
- $results
- boolean $results
- $primary
- boolean $primary
- Whether this model is being queried directly (vs. being queried as an association)
Returns
Modified results
Overrides
afterSave() public ¶
afterSave( boolean $model , boolean $created )
afterSave Callback
Parameters
- boolean $model
- $created
- boolean $created
- True if this save created a new record
Overrides
beforeFind() public ¶
beforeFind( array $model , array $query )
beforeFind Callback
Parameters
- array $model
- $query
- array $query
- $queryData Data used to execute this query, i.e. conditions, order, etc.
Returns
Modified query
Overrides
beforeValidate() public ¶
beforeValidate( object $model )
beforeValidate Callback
Parameters
- object $model
- Model using this behavior
Returns
Overrides
bindTranslation() public ¶
bindTranslation( object $model , mixed $fields , boolean $reset = true )
Bind translation for fields, optionally with hasMany association for fake field
Parameters
- object $model
- of model
- mixed $fields
- with field or array(field1, field2=>AssocName, field3)
- boolean $reset optional true
Returns
setup() public ¶
setup( array $model , array $config = array() )
Callback
$config for TranslateBehavior should be array( 'fields' => array('field_one', 'field_two' => 'FieldAssoc', 'field_three'))
With above example only one permanent hasMany will be joined (for field_two as FieldAssoc)
$config could be empty - and translations configured dynamically by bindTranslation() method
Parameters
- array $model
- $config
- array $config optional array()
- Configuration settings for $model
Returns
Overrides
translateModel() public ¶
translateModel( $model )
Get instance of model for translations
Returns
unbindTranslation() public ¶
unbindTranslation( object $model , mixed $fields = null )
Unbind translation for fields, optionally unbinds hasMany association for fake field
Parameters
- object $model
- of model
- mixed $fields optional null
- with field, or array(field1, field2=>AssocName, field3), or null for unbind all original translations
Returns
Methods inherited from ModelBehavior
_addToWhitelist() public ¶
_addToWhitelist( object $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
- object $model
- Model using this behavior
- string $field
- Field to be added to $model's whitelist
beforeDelete() public ¶
beforeDelete( object $model , boolean $cascade = true )
Before delete callback
Parameters
- object $model
- Model using this behavior
- boolean $cascade optional true
- If true records that depend on this record will also be deleted
Returns
True if the operation should continue, false if it should abort
beforeSave() public ¶
beforeSave( object $model )
Before save callback
Parameters
- object $model
- Model using this behavior
Returns
True if the operation should continue, false if it should abort
dispatchMethod() public ¶
dispatchMethod( string $model , array $method , $params = array() )
Overrides Object::dispatchMethod to account for PHP4's broken reference support
Parameters
- string $model
- $method Name of the method to call
- array $method
- $params Parameter list to use when calling $method
- $params optional array()
Returns
See
Overrides
Methods inherited from Object
Object() public ¶
Object( )
A 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()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks 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
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used 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
- 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
Returns
message
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
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