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.

Namespace: Cake\ORM\Behavior

Property Summary

$_config protected

array

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_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
$_reflectionCache protected static

array

Reflection method cache for behaviors.
$_table protected

Cake\ORM\Table

Table instance
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface

Table locator instance
$_translationTable protected

Cake\ORM\Table

Instance of Table responsible for translating

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

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
_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
_reflectionCache() protected

Gets the methods implemented by this behavior
_resolveMethodAliases() protected

Removes aliased methods that would otherwise be duplicated by userland configuration.
_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 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().
config() public deprecated

Gets/Sets the config.
configShallow() public

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
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.
getConfig() public

Returns the config.
getTable() public

Get the table instance this behavior is bound to.
groupTranslations() public

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

Gets the Model callbacks this behavior is interested in.
implementedFinders() public

implementedFinders
implementedMethods() public

implementedMethods
initialize() public

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

Sets the config.
setupFieldAssociations() public

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

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

Returns a fully aliased field name for translated fields.
verifyConfig() public

verifyConfig

Method Detail

__construct() ¶ public

__construct(Cake\ORM\Table $table, array $config = [])

Constructor

Merges config with the default and store in the config property

Parameters

Cake\ORM\Table $table: The table this behavior is attached to.
array $config optional: The config for this behavior.

_bundleTranslatedFields() ¶ protected

_bundleTranslatedFields(Cake\Datasource\EntityInterface $entity): void

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

Returns

void

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() ¶ protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Writes a config key.

Parameters

string|array $key: Key to write to.
mixed $value: Value to write.
bool|string $merge optional: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Returns

void

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_findExistingTranslations() ¶ protected

_findExistingTranslations(array $ruleSet): array

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): string

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

_reflectionCache() ¶ protected

_reflectionCache(): array

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

_resolveMethodAliases(string $key, array $defaults, array $config): array

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

_rowMapper() ¶ protected

_rowMapper(Cake\Datasource\ResultSetInterface $results, string $locale): Cake\Collection\CollectionInterface

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): void

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.

Returns

void

afterSave() ¶ public

afterSave(Cake\Event\Event $event, Cake\Datasource\EntityInterface $entity): void

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

Returns

void

beforeFind() ¶ public

beforeFind(Cake\Event\Event $event, Cake\ORM\Query $query, ArrayObject $options): void

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

Returns

void

beforeSave() ¶ public

beforeSave(Cake\Event\Event $event, Cake\Datasource\EntityInterface $entity, ArrayObject $options): void

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

Returns

void

buildMarshalMap() ¶ public

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

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
array $map
array $options

Returns

array

config() ¶ public

config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed

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']);

Parameters

string|array|null $key optional: The key to get/set, or a complete array of configs.
mixed|null $value optional: The value to set.
bool $merge optional: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() ¶ public

configShallow(string|array $key, mixed|null $value = null): $this

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: The value to set.

Returns

$this

findTranslations() ¶ public

findTranslations(Cake\ORM\Query $query, array $options): Cake\ORM\Query

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

getConfig() ¶ public

getConfig(string|null $key = null): mixed

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: The key to get or null for the whole config.

Returns

mixed

getTable() ¶ public

getTable(): Cake\ORM\Table

Get the table instance this behavior is bound to.

Returns

Cake\ORM\Table

groupTranslations() ¶ public

groupTranslations(Cake\Datasource\ResultSetInterface $results): Cake\Collection\CollectionInterface

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

implementedEvents() ¶ public

implementedEvents(): array

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

implementedFinders() ¶ public

implementedFinders(): array

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

implementedMethods() ¶ public

implementedMethods(): array

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

initialize() ¶ public

initialize(array $config): void

Initialize hook

Implement this method to avoid having to overwrite the constructor and call parent.

Parameters

array $config: The config for this behavior.

Returns

void

locale() ¶ public

locale(string|null $locale = null): string

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: The locale to use for fetching translated records

Returns

string

setConfig() ¶ public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

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: The value to set.
bool $merge optional: 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.

setupFieldAssociations() ¶ public

setupFieldAssociations(array $fields, string $table, string $model, string $strategy): void

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

Returns

void

tableLocator() ¶ public

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

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

Parameters

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

Returns

Cake\ORM\Locator\LocatorInterface

translationField() ¶ public

translationField(string $field): string

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

verifyConfig() ¶ public

verifyConfig(): void

verifyConfig

Checks that implemented keys contain values pointing at callable.

Returns

void

Throws

Cake\Core\Exception\Exception
if config are invalid

Property Detail

`$_config` ¶ protected

Runtime config

Type

array

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

Default config

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

Type

array

`$_locale` ¶ protected

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

Type

string

`$_reflectionCache` ¶ protected static

Reflection method cache for behaviors.

Stores the reflected method + finder methods per class. This prevents reflecting the same class multiple times in a single process.

Type

array

`$_table` ¶ protected

Table instance

Type

Cake\ORM\Table

`$_tableLocator` ¶ protected

Table locator instance

Type

Cake\ORM\Locator\LocatorInterface

`$_translationTable` ¶ protected

Instance of Table responsible for translating

Type

Cake\ORM\Table

Namespaces

Class TranslateBehavior

Property Summary

Method Summary

__construct() public

_bundleTranslatedFields() protected

_configDelete() protected

_configRead() protected

_configWrite() protected

_findExistingTranslations() protected

_referenceName() protected

_reflectionCache() protected

_resolveMethodAliases() protected

_rowMapper() protected

_unsetEmptyFields() protected

afterSave() public

beforeFind() public

beforeSave() public

buildMarshalMap() public

config() public deprecated

configShallow() public

findTranslations() public

getConfig() public

getTable() public

groupTranslations() public

implementedEvents() public

implementedFinders() public

implementedMethods() public

initialize() public

locale() public

setConfig() public

setupFieldAssociations() public

tableLocator() public

translationField() public

verifyConfig() public

Method Detail

__construct() ¶ public

Parameters

_bundleTranslatedFields() ¶ protected

Parameters

Returns

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_findExistingTranslations() ¶ protected

Parameters

Returns

_referenceName() ¶ protected

Parameters

Returns

_reflectionCache() ¶ protected

Returns

_resolveMethodAliases() ¶ protected

Parameters

Returns

_rowMapper() ¶ protected

Parameters

Returns

_unsetEmptyFields() ¶ protected

Parameters

Returns

afterSave() ¶ public

Parameters

Returns

beforeFind() ¶ public

Parameters

Returns

beforeSave() ¶ public

Parameters

Returns

buildMarshalMap() ¶ public

Parameters

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_locale` ¶ protected

`$_reflectionCache` ¶ protected static

`$_table` ¶ protected

`$_tableLocator` ¶ protected