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.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault config
arrayReflection method cache for behaviors.
\Cake\ORM\TableTable instance.
stringDefault strategy class name.
\Cake\ORM\Behavior\Translate\TranslateStrategyInterface|nullTranslation strategy instance.
Removes aliased methods that would otherwise be duplicated by userland configuration.
Build a set of properties that should be included in the marshalling process.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Custom finder method used to retrieve all translations for the found records.
Sets the locale that should be used for all future find and save operations on the table where this behavior is attached to.
__call(mixed $method, mixed $args)
Proxy method calls to strategy class instance.
string $method Method name.
array $args Method arguments.
mixed__construct(\Cake\ORM\Table $table, array $config)
Constructor
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.\Cake\ORM\Table $table The table this behavior is attached to.
array $config optional The config for this behavior.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception_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
arrayReflectionException_resolveMethodAliases(string $key, array $defaults, array $config)
Removes aliased methods that would otherwise be duplicated by userland configuration.
string $key The key to filter.
array $defaults The default method mappings.
array $config The customized method mappings.
arrayA de-duped list of config data.
buildMarshalMap(\Cake\ORM\Marshaller $marshaller, array $map, array $options)
Build a set of properties that should be included in the marshalling process.
\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.
arrayA map of [property => callable] of additional properties to marshal.
configShallow(mixed $key, mixed $value)
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thiscreateStrategy()
Create strategy instance.
\Cake\ORM\Behavior\Translate\TranslateStrategyInterfacefindTranslations(\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.
$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.
\Cake\ORM\Query $query The original query to modify
array $options Options
\Cake\ORM\QuerygetConfig(?string $key, mixed $default)
Returns the config.
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'); 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.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetDefaultStrategyClass()
Get default strategy class name.
stringgetLocale()
Returns the current locale.
If no locale has been explicitly set via setLocale(), this method will return the currently configured global locale.
stringgetStrategy()
Get strategy class instance.
\Cake\ORM\Behavior\Translate\TranslateStrategyInterfacegetTable()
Get the table instance this behavior is bound to.
\Cake\ORM\TableThe bound table instance.
implementedEvents()
Gets the Model callbacks this behavior is interested in.
arrayimplementedFinders()
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
arrayReflectionExceptionimplementedMethods()
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
arrayReflectionExceptioninitialize(array $config)
Initialize hook
array $config The config for this behavior.
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.
\Cake\ORM\Table $table The table class to get a reference name for.
stringsetConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
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.
$thisCake\Core\Exception\ExceptionsetDefaultStrategyClass(string $class)
Set default strategy class name.
string $class Class name.
setLocale(?string $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)!
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.
$thissetStrategy(\Cake\ORM\Behavior\Translate\TranslateStrategyInterface $strategy)
Set strategy class instance.
\Cake\ORM\Behavior\Translate\TranslateStrategyInterface $strategy Strategy class instance.
$thistranslationField(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.
string $field Field name to be aliased.
stringverifyConfig()
verifyConfig
Checks that implemented keys contain values pointing at callable.
Cake\Core\Exception\ExceptionRuntime config
arrayWhether the config property has already been configured with defaults
boolDefault config
These are merged with user-provided configuration when the behavior is used.
arrayReflection method cache for behaviors.
Stores the reflected method + finder methods per class. This prevents reflecting the same class multiple times in a single process.
arrayTable instance.
\Cake\ORM\TableDefault strategy class name.
stringTranslation strategy instance.
\Cake\ORM\Behavior\Translate\TranslateStrategyInterface|null
© 2005–present 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/4.1/class-Cake.ORM.Behavior.TranslateBehavior.html