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

Namespace: Cake\ORM\Behavior
Location: ORM/Behavior/TranslateBehavior.php

Properties summary

$_defaultConfig protected

array

Default config
$_locale protected

string

The locale name that will be used to override fields in the bound table from the translations table
$_table protected

Cake\ORM\Table

Table instance
$_translationTable protected

Cake\ORM\Table

Instance of Table responsible for translating

Inherited Properties

_reflectionCache _config, _configInitialized _tableLocator

Method Summary

__construct() public

Constructor
_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() protected

Determine 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.
_unsetEmptyFields() protected

Unset empty translations to avoid persistence.
afterSave() public

Unsets 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. You can disable marshalling of translations by setting 'translations' => false in the options provided to Table::newEntity() or Table::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.
getLocale() public

Returns the current locale.
groupTranslations() public

Modifies the results from a table find in order to merge full translation records into each entity under the _translations key
initialize() public

Initialize hook
locale() public deprecated

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
setLocale() public

Sets the locale that should be used for all future find and save operations on the table where this behavior is attached to.
setupFieldAssociations() public

Creates the associations between the bound table and every field passed to this method.
translationField() public

Returns a fully aliased field name for translated fields.

Method Detail

__construct() 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() 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() 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() 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() 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

_unsetEmptyFields() protected ¶

_unsetEmptyFields( Cake\Datasource\EntityInterface $entity )

Unset empty translations to avoid persistence.

Should only be called if $this->_config['allowEmptyTranslations'] is false.

Parameters

Cake\Datasource\EntityInterface $entity: The entity to check for empty translations fields inside.

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

buildMarshalMap( Cake\ORM\Marshaller $marshaller , array $map , array $options )

Add in _translations marshalling handlers. You can disable marshalling of translations by setting 'translations' => false in 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

array
A map of [property => callable] of additional properties to marshal.

Implementation of

Cake\ORM\PropertyMarshalInterface::buildMarshalMap()

findTranslations() 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

getLocale() public ¶

getLocale( )

Returns the current locale.

If no locale has been explicitly set via setLocale(), this method will return the currently configured global locale.

Returns

string

See

\Cake\I18n\I18n::getLocale()
\Cake\ORM\Behavior\TranslateBehavior::setLocale()

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

initialize( array $config )

Initialize hook

Parameters

array $config: The config for this behavior.

Overrides

Cake\ORM\Behavior::initialize()

locale() public deprecated ¶

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

Deprecated

3.6.0 Use setLocale()/getLocale() instead.

Parameters

string|null $locale optional null: The locale to use for fetching translated records

Returns

string

setLocale() public ¶

setLocale( string|null $locale )

Sets the locale that should be used for all future find and save operations on the table where this behavior is attached to.

When fetching records, the behavior will include the content for the locale set via this method, and likewise when saving data, it will save the data in that locale.

Note that in case an entity has a _locale property set, that locale will win over the locale set via this method (and over the globally configured one for that matter)!

Parameters

string|null $locale: The locale to use for fetching and saving records. Pass null in order to unset the current locale, and to make the behavior fall back to using the globally configured locale.

Returns

$this

See

\Cake\ORM\Behavior\TranslateBehavior::getLocale()

Link

https://book.cakephp.org/3.0/en/orm/behaviors/translate.html#retrieving-one-language-without-using-i18n-locale
https://book.cakephp.org/3.0/en/orm/behaviors/translate.html#saving-in-another-language

setupFieldAssociations() 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() 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

string

Methods inherited from Cake\ORM\Behavior

_reflectionCache() 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

Throws

ReflectionException

_resolveMethodAliases() 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

array
A de-duped list of config data.

getTable() public ¶

getTable( )

Get the table instance this behavior is bound to.

Returns

Cake\ORM\Table
The bound table instance.

implementedEvents() 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

array

Implementation of

Cake\Event\EventListenerInterface::implementedEvents()

implementedFinders() 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

array

Throws

ReflectionException

implementedMethods() 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()

Returns

array

Throws

ReflectionException

verifyConfig() 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

getTableLocator() public ¶

getTableLocator( )

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

setTableLocator() public ¶

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface instance.

Returns

$this

tableLocator() public deprecated ¶

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Sets the table locator. If no parameters are passed, it will return the currently used locator.

Deprecated

3.5.0 Use getTableLocator()/setTableLocator() instead.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator optional null: LocatorInterface instance.

Returns

Cake\ORM\Locator\LocatorInterface

Methods used from Cake\Core\InstanceConfigTrait

_configDelete() 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() protected ¶

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() 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() public deprecated ¶

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

mixed
Config 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() 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->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['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() public ¶

getConfig( string|null $key = null , mixed $default = 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');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional null: The key to get or null for the whole config.
mixed $default optional null: The return value when the key does not exist.

Returns

mixed
Configuration data at the named key or null if the key does not exist.

setConfig() 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

`$_defaultConfig` ¶

protected array

Default config

These are merged with user-provided configuration when the behavior is used.

[
    'implementedFinders' => ['translations' => 'findTranslations'],
    'implementedMethods' => [
        'setLocale' => 'setLocale',
        'getLocale' => 'getLocale',
        'locale' => 'locale',
        'translationField' => 'translationField'
    ],
    'fields' => [],
    'translationTable' => 'I18n',
    'defaultLocale' => '',
    'referenceName' => '',
    'allowEmptyTranslations' => true,
    'onlyTranslated' => false,
    'strategy' => 'subquery',
    'tableLocator' => null,
    'validator' => false
]

Namespaces

Classes

Class TranslateBehavior

Properties summary

Inherited Properties

Method Summary

__construct() public

_bundleTranslatedFields() protected

_findExistingTranslations() protected

_referenceName() protected

_rowMapper() protected

_unsetEmptyFields() protected

afterSave() public

beforeFind() public

beforeSave() public

buildMarshalMap() public

findTranslations() public

getLocale() public

groupTranslations() public

initialize() public

locale() public deprecated

setLocale() public

setupFieldAssociations() public

translationField() public

Method Detail

__construct() public ¶

Parameters

Overrides

_bundleTranslatedFields() protected ¶

Parameters

_findExistingTranslations() protected ¶

Parameters

Returns

_referenceName() protected ¶

Parameters

Returns

_rowMapper() protected ¶

Parameters

Returns

_unsetEmptyFields() protected ¶

Parameters

afterSave() public ¶

Parameters

beforeFind() public ¶

Parameters

beforeSave() public ¶

Parameters

buildMarshalMap() public ¶

Parameters

Returns

Implementation of

findTranslations() public ¶

Example:

Parameters

Returns

getLocale() public ¶

Returns

See

groupTranslations() public ¶

Parameters

Returns

initialize() public ¶

Parameters

Overrides

locale() public deprecated ¶

Deprecated

Parameters

Returns

setLocale() public ¶

Parameters

Returns

See

Link

setupFieldAssociations() public ¶

Parameters

translationField() public ¶

Parameters

Returns

Methods inherited from Cake\ORM\Behavior

_reflectionCache() protected ¶

`$_defaultConfig` ¶

`$_locale` ¶

`$_table` ¶

`$_translationTable` ¶