Class TranslateBehavior

Translate behavior

Object

TranslateBehavior

Package: cake\cake\libs\model\behaviors
Link: http://book.cakephp.org/1.3/en/The-Manual/Core-Behaviors/Translate.html#Translate
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: model/behaviors/translate.php

Properties summary

$_joinTable public

object

Stores the joinTable object for generating joins.
$_runtimeModel public

Model

Stores the runtime model for generating joins.
$runtime public

array

Used for runtime configuration of model

Inherited Properties

mapMethods, settings

Method Summary

_addJoin() public

Appends a join for translated fields and possibly a field.
_checkConditions() public

Check a query's conditions for translated fields. Return an array of translated fields found in the conditions.
_getLocale() public

Get selected locale for model
_setRuntimeData() public

Sets the runtime data.
afterDelete() public

afterDelete Callback
afterFind() public

afterFind Callback
afterSave() public

afterSave Callback
beforeFind() public

beforeFind Callback
beforeSave() public

beforeSave callback.
beforeValidate() public

beforeValidate Callback
bindTranslation() public

Bind translation for fields, optionally with hasMany association for fake field
cleanup() public

Cleanup Callback unbinds bound translations and deletes setting information.
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

_addJoin() public ¶

_addJoin( Model $model , object $query , array $field , string $locale , mixed $addField = false , boolean $addField ,… )

Appends a join for translated fields and possibly a field.

Parameters

Model $model: The model being worked on.
object $query: $joinTable The jointable object.
array $field: $query The query array to append a join to.
string $locale: $field The field name being joined.
mixed $addField optional false: $locale The locale(s) having joins added.
boolean $addField ,…: Whether or not to add a field.

Returns

array
The modfied query

_checkConditions() public ¶

_checkConditions( Model $model , array $query )

Check a query's conditions for translated fields. Return an array of translated fields found in the conditions.

Parameters

Model $model: The model being read.
array $query: The query array.

Returns

array
The list of translated fields that are in the conditions.

_getLocale() public ¶

_getLocale( Model $model )

Get selected locale for model

Parameters

Model $model: Model the locale needs to be set/get on.

Returns

mixed
string or false

_setRuntimeData() public ¶

_setRuntimeData( Model $model )

Sets the runtime data.

Used from beforeValidate() and beforeSave() for compatibility issues, and to allow translations to be persisted even when validation is disabled.

Parameters

Model $model

afterDelete() public ¶

afterDelete( Model $model )

afterDelete Callback

Parameters

Model $model: Model the callback was run on.

Overrides

ModelBehavior::afterDelete()

afterFind() public ¶

afterFind( Model $model , array $results , boolean $primary )

afterFind Callback

Parameters

Model $model: Model find was run on
array $results: Array of model results.
boolean $primary: Did the find originate on $model.

Returns

array
Modified results

Overrides

ModelBehavior::afterFind()

afterSave() public ¶

afterSave( Model $model , boolean $created )

afterSave Callback

Parameters

Model $model: Model the callback is called on
boolean $created: Whether or not the save created a record.

Overrides

ModelBehavior::afterSave()

beforeFind() public ¶

beforeFind( Model $model , array $query )

beforeFind Callback

Parameters

Model $model: Model find is being run on.
array $query: Array of Query parameters.

Returns

array
Modified query

Overrides

ModelBehavior::beforeFind()

beforeSave() public ¶

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

beforeSave callback.

Copies data into the runtime property when $options['validate'] is disabled. Or the runtime data hasn't been set yet.

Parameters

Model $model: Model save was called on.
$options optional array()

Returns

boolean
true.

Overrides

ModelBehavior::beforeSave()

beforeValidate() public ¶

beforeValidate( Model $model )

beforeValidate Callback

Parameters

Model $model: Model invalidFields was called on.

Returns

boolean

Overrides

ModelBehavior::beforeValidate()

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

boolean

cleanup() public ¶

cleanup( Model $model )

Cleanup Callback unbinds bound translations and deletes setting information.

Parameters

Model $model: Model being detached.

Overrides

ModelBehavior::cleanup()

setup() public ¶

setup( Model $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

Model $model: Model the behavior is being attached to.
array $config optional array(): Array of configuration information.

Returns

mixed

Overrides

ModelBehavior::setup()

translateModel() public ¶

translateModel( Model $model )

Get instance of model for translations.

If the model has a translateModel property set, this will be used as the class name to find/use. If no translateModel property is found 'I18nModel' will be used.

Parameters

Model $model: Model to get a translatemodel for.

Returns

object

unbindTranslation() public ¶

unbindTranslation( object $model , mixed $fields = null )

Unbind translation for fields, optionally unbinds hasMany association for fake field

Parameters

object $model: instance of model
mixed $fields optional null: string with field, or array(field1, field2=>AssocName, field3), or null for unbind all original translations

Returns

boolean

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

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

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

mixed

See

Object::dispatchMethod

Overrides

Object::dispatchMethod()

onError() public ¶

onError( object $model , string $error )

DataSource error callback

Parameters

object $model: Model using this behavior
string $error: Error generated in DataSource

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

Object

__construct() public ¶

__construct( )

Class constructor, overridden in descendant classes.

__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

boolean
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

boolean
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. 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() public ¶

_stop( $status = 0 )

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

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

error
message

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience 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_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

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

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

mixed

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

string
The name of this class

array()

Classes

Functions

Class TranslateBehavior

Properties summary

Inherited Properties

Method Summary

_addJoin() public

_checkConditions() public

_getLocale() public

_setRuntimeData() public

afterDelete() public

afterFind() public

afterSave() public

beforeFind() public

beforeSave() public

beforeValidate() public

bindTranslation() public

cleanup() public

setup() public

translateModel() public

unbindTranslation() public

Method Detail

_addJoin() public ¶

Parameters

Returns

_checkConditions() public ¶

Parameters

Returns

_getLocale() public ¶

Parameters

Returns

_setRuntimeData() public ¶

Parameters

afterDelete() public ¶

Parameters

Overrides

afterFind() public ¶

Parameters

Returns

Overrides

afterSave() public ¶

Parameters

Overrides

beforeFind() public ¶

Parameters

Returns

Overrides

beforeSave() public ¶

Parameters

Returns

Overrides

beforeValidate() public ¶

Parameters

Returns

Overrides

bindTranslation() public ¶

Parameters

Returns

cleanup() public ¶

Parameters

Overrides

setup() public ¶

Parameters

Returns

Overrides

translateModel() public ¶

Parameters

Returns

unbindTranslation() public ¶

Parameters

Returns

Methods inherited from ModelBehavior

_addToWhitelist() public ¶

Parameters

beforeDelete() public ¶

Parameters

Returns

dispatchMethod() public ¶

Parameters

Returns

`$_joinTable` ¶

`$_runtimeModel` ¶

`$runtime` ¶