TranslateBehavior (class)
Class TranslateBehavior
This behavior provides a way to translate dynamic data by keeping translations in a separate table linked to the original record from another one. Translated fields can be configured to override those in the main table when fetched or put aside into another property for the same entity.
If you wish to override fields, you need to call the locale
method in this behavior for setting the language you want to fetch from the translations table.
If you want to bring all or certain languages for each of the fetched records, you can use the custom translations
finders that is exposed to the table.
- Cake\ORM\Behavior implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\ORM\Behavior\TranslateBehavior implements Cake\ORM\PropertyMarshalInterface uses Cake\ORM\Locator\LocatorAwareTrait
Properties summary
-
$_defaultConfig
protectedDefault configarray
-
$_locale
protectedstring
The locale name that will be used to override fields in the bound table from the translations table
-
$_table
protected -
$_translationTable
protected
Inherited Properties
Method Summary
- __construct() publicConstructor
- _bundleTranslatedFields() protected
Helper method used to generated multiple translated field entities out of the data found in the
_translations
property in the passed entity. The result will be put into its_i18n
property - _findExistingTranslations() protected
Returns the ids found for each of the condition arrays passed for the translations table. Each records is indexed by the corresponding position to the conditions array
- _referenceName() protectedDetermine the reference name to use for a given table
- _rowMapper() protected
Modifies the results from a table find in order to merge the translated fields into each entity for a given locale.
- afterSave() publicUnsets the temporary
_i18n
property after the entity has been saved - beforeFind() public
Callback method that listens to the
beforeFind
event in the bound table. It modifies the passed query by eager loading the translated fields and adding a formatter to copy the values into the main table records. - beforeSave() public
Modifies the entity before it is saved so that translated fields are persisted in the database too.
- buildMarshalMap() public
Add in _translations marshalling handlers if translation marshalling is enabled. You need to specifically enable translation marshalling by adding
'translations' => true
to the options provided toTable::newEntity()
orTable::patchEntity()
. - findTranslations() public
Custom finder method used to retrieve all translations for the found records. Fetched translations can be filtered by locale by passing the
locales
key in the options array. - groupTranslations() public
Modifies the results from a table find in order to merge full translation records into each entity under the
_translations
key - initialize() publicInitialize hook
- locale() public
Sets all future finds for the bound table to also fetch translated fields for the passed locale. If no value is passed, it returns the currently configured locale
- setupFieldAssociations() public
Creates the associations between the bound table and every field passed to this method.
- translationField() publicReturns a fully aliased field name for translated fields.
Method Detail
__construct()source public
__construct( Cake\ORM\Table $table , array $config [] )
Constructor
Parameters
-
Cake\ORM\Table
$table
- The table this behavior is attached to.
- array
$config
optional [] - The config for this behavior.
Overrides
Cake\ORM\Behavior::__construct()
_bundleTranslatedFields()source protected
_bundleTranslatedFields( Cake\Datasource\EntityInterface $entity )
Helper method used to generated multiple translated field entities out of the data found in the _translations
property in the passed entity. The result will be put into its _i18n
property
Parameters
-
Cake\Datasource\EntityInterface
$entity
- Entity
_findExistingTranslations()source protected
_findExistingTranslations( array $ruleSet )
Returns the ids found for each of the condition arrays passed for the translations table. Each records is indexed by the corresponding position to the conditions array
Parameters
- array
$ruleSet
- an array of arary of conditions to be used for finding each
Returns
array_referenceName()source protected
_referenceName( Cake\ORM\Table $table )
Determine the reference name to use for a given table
The reference name is usually derived from the class name of the table object (PostsTable -> Posts), however for autotable instances it is derived from the database table the object points at - or as a last resort, the alias of the autotable instance.
Parameters
-
Cake\ORM\Table
$table
- The table class to get a reference name for.
Returns
string_rowMapper()source protected
_rowMapper( Cake\Datasource\ResultSetInterface $results , string $locale )
Modifies the results from a table find in order to merge the translated fields into each entity for a given locale.
Parameters
-
Cake\Datasource\ResultSetInterface
$results
- Results to map.
- string
$locale
- Locale string
Returns
Cake\Collection\CollectionInterface
afterSave()source public
afterSave( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity )
Unsets the temporary _i18n
property after the entity has been saved
Parameters
-
Cake\Event\Event
$event
- The beforeSave event that was fired
-
Cake\Datasource\EntityInterface
$entity
- The entity that is going to be saved
beforeFind()source public
beforeFind( Cake\Event\Event $event , Cake\ORM\Query $query , ArrayObject $options )
Callback method that listens to the beforeFind
event in the bound table. It modifies the passed query by eager loading the translated fields and adding a formatter to copy the values into the main table records.
Parameters
-
Cake\Event\Event
$event
- The beforeFind event that was fired.
-
Cake\ORM\Query
$query
- Query
- ArrayObject
$options
- The options for the query
beforeSave()source public
beforeSave( Cake\Event\Event $event , Cake\Datasource\EntityInterface $entity , ArrayObject $options )
Modifies the entity before it is saved so that translated fields are persisted in the database too.
Parameters
-
Cake\Event\Event
$event
- The beforeSave event that was fired
-
Cake\Datasource\EntityInterface
$entity
- The entity that is going to be saved
- ArrayObject
$options
- the options passed to the save method
buildMarshalMap()source public
buildMarshalMap( Cake\ORM\Marshaller $marshaller , array $map , array $options )
Add in _translations marshalling handlers if translation marshalling is enabled. You need to specifically enable translation marshalling by adding 'translations' => true
to the options provided to Table::newEntity()
or Table::patchEntity()
.
Parameters
-
Cake\ORM\Marshaller
$marshaller
- The marhshaller of the table the behavior is attached to.
- array
$map
- The property map being built.
- array
$options
- The options array used in the marshalling call.
Returns
arrayA map of
[property => callable]
of additional properties to marshal.Implementation of
Cake\ORM\PropertyMarshalInterface::buildMarshalMap()
findTranslations()source public
findTranslations( Cake\ORM\Query $query , array $options )
Custom finder method used to retrieve all translations for the found records. Fetched translations can be filtered by locale by passing the locales
key in the options array.
Translated values will be found for each entity under the property _translations
, containing an array indexed by locale name.
Example:
$article = $articles->find('translations', ['locales' => ['eng', 'deu'])->first(); $englishTranslatedFields = $article->get('_translations')['eng'];
If the locales
array is not passed, it will bring all translations found for each record.
Parameters
-
Cake\ORM\Query
$query
- The original query to modify
- array
$options
- Options
Returns
Cake\ORM\Query
groupTranslations()source public
groupTranslations( Cake\Datasource\ResultSetInterface $results )
Modifies the results from a table find in order to merge full translation records into each entity under the _translations
key
Parameters
-
Cake\Datasource\ResultSetInterface
$results
- Results to modify.
Returns
Cake\Collection\CollectionInterface
initialize()source public
initialize( array $config )
Initialize hook
Parameters
- array
$config
- The config for this behavior.
Overrides
Cake\ORM\Behavior::initialize()
locale()source public
locale( string|null $locale null )
Sets all future finds for the bound table to also fetch translated fields for the passed locale. If no value is passed, it returns the currently configured locale
Parameters
- string|null
$locale
optional null - The locale to use for fetching translated records
Returns
stringsetupFieldAssociations()source public
setupFieldAssociations( array $fields , string $table , string $model , string $strategy )
Creates the associations between the bound table and every field passed to this method.
Additionally it creates a i18n
HasMany association that will be used for fetching all translations for each record in the bound table
Parameters
- array
$fields
- list of fields to create associations for
- string
$table
- the table name to use for storing each field translation
- string
$model
- the model field value
- string
$strategy
- the strategy used in the _i18n association
translationField()source public
translationField( string $field )
Returns a fully aliased field name for translated fields.
If the requested field is configured as a translation field, the content
field with an alias of a corresponding association is returned. Table-aliased field name is returned for all other fields.
Parameters
- string
$field
- Field name to be aliased.
Returns
stringMethods inherited from Cake\ORM\Behavior
_reflectionCache()source protected
_reflectionCache( )
Gets the methods implemented by this behavior
Uses the implementedEvents() method to exclude callback methods. Methods starting with _
will be ignored, as will methods declared on Cake\ORM\Behavior
Returns
array_resolveMethodAliases()source protected
_resolveMethodAliases( string $key , array $defaults , array $config )
Removes aliased methods that would otherwise be duplicated by userland configuration.
Parameters
- string
$key
- The key to filter.
- array
$defaults
- The default method mappings.
- array
$config
- The customized method mappings.
Returns
arrayA de-duped list of config data.
getTable()source public
getTable( )
Get the table instance this behavior is bound to.
Returns
Cake\ORM\Table
The bound table instance.
implementedEvents()source public
implementedEvents( )
Gets the Model callbacks this behavior is interested in.
By defining one of the callback methods a behavior is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want your behavior to listen to non-standard events.
Returns
arrayImplementation of
Cake\Event\EventListenerInterface::implementedEvents()
implementedFinders()source public
implementedFinders( )
implementedFinders
Provides an alias->methodname map of which finders a behavior implements. Example:
[ 'this' => 'findThis', 'alias' => 'findMethodName' ]
With the above example, a call to $Table->find('this')
will call $Behavior->findThis()
and a call to $Table->find('alias')
will call $Behavior->findMethodName()
It is recommended, though not required, to define implementedFinders in the config property of child classes such that it is not necessary to use reflections to derive the available method list. See core behaviors for examples
Returns
arrayimplementedMethods()source public
implementedMethods( )
implementedMethods
Provides an alias->methodname map of which methods a behavior implements. Example:
[ 'method' => 'method', 'aliasedmethod' => 'somethingElse' ]
With the above example, a call to $Table->method()
will call $Behavior->method()
and a call to $Table->aliasedmethod()
will call $Behavior->somethingElse()
It is recommended, though not required, to define implementedFinders in the config property of child classes such that it is not necessary to use reflections to derive the available method list. See core behaviors for examples
Returns
arrayverifyConfig()source public
verifyConfig( )
verifyConfig
Checks that implemented keys contain values pointing at callable.
Throws
Cake\Core\Exception\Exception
if config are invalid
Methods used from Cake\ORM\Locator\LocatorAwareTrait
tableLocator()source public
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )
Sets the table locator. If no parameters are passed, it will return the currently used locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface
$tableLocator
optional null - LocatorInterface instance.
Returns
Cake\ORM\Locator\LocatorInterface
Methods used from Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Deletes a single config key.
Parameters
- string
$key
- Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead()source protected
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null
$key
- Key to read.
Returns
mixed_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array
$key
- Key to write to.
- mixed
$value
- Value to write.
- boolean|string
$merge
optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
config()source public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Usage
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Deprecated
3.4.0 use setConfig()/getConfig() instead.Parameters
- string|array|null
$key
optional null - The key to get/set, or a complete array of configs.
- mixed|null
$value
optional null - The value to set.
- boolean
$merge
optional true - Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
configShallow()source public
configShallow( string|array $key , mixed|null $value null )
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Parameters
- string|array
$key
- The key to set, or a complete array of configs.
- mixed|null
$value
optional null - The value to set.
Returns
$this
getConfig()source public
getConfig( string|null $key null )
Returns the config.
Usage
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Parameters
- string|null
$key
optional null - The key to get or null for the whole config.
Returns
mixedConfig value being read.
setConfig()source public
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Parameters
- string|array
$key
- The key to set, or a complete array of configs.
- mixed|null
$value
optional null - The value to set.
- boolean
$merge
optional true - Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
Properties detail
$_defaultConfigsource
protected array
Default config
These are merged with user-provided configuration when the behavior is used.
[ 'implementedFinders' => ['translations' => 'findTranslations'], 'implementedMethods' => [ 'locale' => 'locale', 'translationField' => 'translationField' ], 'fields' => [], 'translationTable' => 'I18n', 'defaultLocale' => '', 'referenceName' => '', 'allowEmptyTranslations' => true, 'onlyTranslated' => false, 'strategy' => 'subquery', 'tableLocator' => null, 'validator' => false ]
$_localesource
protected string
The locale name that will be used to override fields in the bound table from the translations table
© 2005–2017 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/3.4/class-Cake.ORM.Behavior.TranslateBehavior.html