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<string, mixed>

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_defaultConfig protected

array<string, mixed>

Default config
$_reflectionCache protected static

array<string, array>

Reflection method cache for behaviors.
$_table protected

Cake\ORM\Table

Table instance.
$defaultStrategyClass protected static

string

Default strategy class name.
$strategy protected

Cake\ORM\Behavior\Translate\TranslateStrategyInterface|null

Translation strategy instance.

Method Summary

__call() public

Proxy method calls to strategy class instance.
__construct() public

Constructor
_configDelete() protected

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
_reflectionCache() protected

Gets the methods implemented by this behavior
_resolveMethodAliases() protected

Removes aliased methods that would otherwise be duplicated by userland configuration.
beforeMarshal() public

Hoist fields for the default locale under _translations key to the root in the data.
buildMarshalMap() public

Build a set of properties that should be included in the marshalling process.
configShallow() public

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
createStrategy() protected

Create strategy instance.
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.
getConfigOrFail() public

Returns the config for this specific key.
getDefaultStrategyClass() public static

Get default strategy class name.
getLocale() public

Returns the current locale.
getStrategy() public

Get strategy class instance.
implementedEvents() public

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

implementedFinders
implementedMethods() public

implementedMethods
initialize() public

Initialize hook
referenceName() protected

Determine the reference name to use for a given table
setConfig() public

Sets the config.
setDefaultStrategyClass() public static

Set default strategy class name.
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.
setStrategy() public

Set strategy class instance.
table() public

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

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

verifyConfig

Method Detail

__call() ¶ public

__call(string $method, array $args): mixed

Proxy method calls to strategy class instance.

Parameters

string $method: Method name.
array $args: Method arguments.

Returns

mixed

__construct() ¶ public

__construct(Cake\ORM\Table $table, array<string, mixed> $config = [])

Constructor

Options

fields: List of fields which need to be translated. Providing this fields list is mandatory when using EavStrategy. If the fields list is empty when using ShadowTableStrategy then the list will be auto generated based on shadow table schema.
defaultLocale: The locale which is treated as default by the behavior. Fields values for defaut locale will be stored in the primary table itself and the rest in translation table. If not explicitly set the value of I18n::getDefaultLocale() will be used to get default locale. If you do not want any default locale and want translated fields for all locales to be stored in translation table then set this config to empty string ''.
allowEmptyTranslations: By default if a record has been translated and stored as an empty string the translate behavior will take and use this value to overwrite the original field value. If you don't want this behavior then set this option to false.
validator: The validator that should be used when translation records are created/modified. Default null.

Parameters

Cake\ORM\Table $table: The table this behavior is attached to.
array<string, mixed> $config optional: The config for this behavior.

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\CakeException
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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes a config key.

Parameters

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

Returns

void

Throws

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

_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

Throws

ReflectionException

_resolveMethodAliases() ¶ protected

_resolveMethodAliases(string $key, array<string, mixed> $defaults, array<string, mixed> $config): array

Removes aliased methods that would otherwise be duplicated by userland configuration.

Parameters

string $key: The key to filter.
array<string, mixed> $defaults: The default method mappings.
array<string, mixed> $config: The customized method mappings.

Returns

array

beforeMarshal() ¶ public

beforeMarshal(Cake\Event\EventInterface $event, ArrayObject $data, ArrayObject $options): void

Hoist fields for the default locale under _translations key to the root in the data.

This allows _translations.{locale}.field_name type naming even for the default locale in forms.

Parameters

Cake\Event\EventInterface $event
ArrayObject $data
ArrayObject $options

Returns

void

buildMarshalMap() ¶ public

buildMarshalMap(Cake\ORM\Marshaller $marshaller, array $map, array<string, mixed> $options): array

Build a set of properties that should be included in the marshalling process.

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<string, mixed> $options: The options array used in the marshalling call.

Returns

array

configShallow() ¶ public

configShallow(array<string, mixed>|string $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

array<string, mixed>|string $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.

Returns

$this

createStrategy() ¶ protected

createStrategy(): Cake\ORM\Behavior\Translate\TranslateStrategyInterface

Create strategy instance.

Returns

Cake\ORM\Behavior\Translate\TranslateStrategyInterface

findTranslations() ¶ public

findTranslations(Cake\ORM\Query\SelectQuery $query, list<string> $locales = []): Cake\ORM\Query\SelectQuery

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\SelectQuery $query: The original query to modify
list<string> $locales optional: A list of locales or options with the locales key defined

Returns

Cake\ORM\Query\SelectQuery

getConfig() ¶ public

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

Reading with default value:

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

Parameters

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

Returns

mixed

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key: The key to get.

Returns

mixed

Throws

InvalidArgumentException

getDefaultStrategyClass() ¶ public static

getDefaultStrategyClass(): string

Get default strategy class name.

Returns

string

getLocale() ¶ public

getLocale(): string

Returns the current locale.

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

Returns

string

getStrategy() ¶ public

getStrategy(): Cake\ORM\Behavior\Translate\TranslateStrategyInterface

Get strategy class instance.

Returns

Cake\ORM\Behavior\Translate\TranslateStrategyInterface

implementedEvents() ¶ public

implementedEvents(): array<string, mixed>

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<string, mixed>

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

Throws

ReflectionException

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

Throws

ReflectionException

initialize() ¶ public

initialize(array<string, mixed> $config): void

Initialize hook

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

Parameters

array<string, mixed> $config: The config for this behavior.

Returns

void

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

setConfig() ¶ public

setConfig(array<string, mixed>|string $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

array<string, mixed>|string $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\CakeException
When trying to set a key that is invalid.

setDefaultStrategyClass() ¶ public static

setDefaultStrategyClass(string $class): void

Set default strategy class name.

Parameters

string $class: Class name.

Returns

void

setLocale() ¶ public

setLocale(string|null $locale): $this

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

Links

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

https://book.cakephp.org/5/en/orm/behaviors/translate.html#saving-in-another-language

setStrategy() ¶ public

setStrategy(Cake\ORM\Behavior\Translate\TranslateStrategyInterface $strategy): $this

Set strategy class instance.

Parameters

Cake\ORM\Behavior\Translate\TranslateStrategyInterface $strategy: Strategy class instance.

Returns

$this

table() ¶ public

table(): Cake\ORM\Table

Get the table instance this behavior is bound to.

Returns

Cake\ORM\Table

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\CakeException
if config are invalid

Property Detail

`$_config` ¶ protected

Runtime config

Type

array<string, mixed>

`$_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<string, mixed>

`$_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<string, array>

`$_table` ¶ protected

Table instance.

Type

Cake\ORM\Table

`$defaultStrategyClass` ¶ protected static

Default strategy class name.

Type

string

`$strategy` ¶ protected

Translation strategy instance.

Type

Cake\ORM\Behavior\Translate\TranslateStrategyInterface|null

Namespaces

Class TranslateBehavior

Property Summary

Method Summary

__call() public

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_reflectionCache() protected

_resolveMethodAliases() protected

beforeMarshal() public

buildMarshalMap() public

configShallow() public

createStrategy() protected

findTranslations() public

getConfig() public

getConfigOrFail() public

getDefaultStrategyClass() public static

getLocale() public

getStrategy() public

implementedEvents() public

implementedFinders() public

implementedMethods() public

initialize() public

referenceName() protected

setConfig() public

setDefaultStrategyClass() public static

setLocale() public

setStrategy() public

table() public

translationField() public

verifyConfig() public

Method Detail

__call() ¶ public

Parameters

Returns

__construct() ¶ public

Options

Parameters

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_reflectionCache() ¶ protected

Returns

Throws

_resolveMethodAliases() ¶ protected

Parameters

Returns

beforeMarshal() ¶ public

Parameters

Returns

buildMarshalMap() ¶ public

Parameters

Returns

configShallow() ¶ public

Parameters

Returns

createStrategy() ¶ protected

Returns

findTranslations() ¶ public

Example:

Parameters

Returns

getConfig() ¶ public

Usage

Parameters

Returns

getConfigOrFail() ¶ public

Parameters

Returns

Throws

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_reflectionCache` ¶ protected static

`$_table` ¶ protected

`$defaultStrategyClass` ¶ protected static

`$strategy` ¶ protected