Class EavStrategy
This class 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 finder of TranslateBehavior that is
exposed to the table.
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config
-
$_tableLocator protected
Cake\ORM\Locator\LocatorInterface|nullTable locator instance
-
$locale protected
string|nullThe locale name that will be used to override fields in the bound table from the translations table
-
$table protected
Cake\ORM\TableTable instance
-
$translationTable protected
Cake\ORM\TableInstance of Table responsible for translating
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
afterSave() public
Unsets the temporary
_i18nproperty after the entity has been saved -
beforeFind() public
Callback method that listens to the
beforeFindevent 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
Build a set of properties that should be included in the marshalling process.
-
bundleTranslatedFields() protected
Helper method used to generated multiple translated field entities out of the data found in the
_translationsproperty in the passed entity. The result will be put into its_i18nproperty. -
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
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.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getLocale() public
Returns the current locale.
-
getTableLocator() public
Gets the table locator.
-
getTranslationTable() public
Return translation table instance.
-
groupTranslations() public
Modifies the results from a table find in order to merge full translation records into each entity under the
_translationskey. -
rowMapper() protected
Modifies the results from a table find in order to merge the translated fields into each entity for a given locale.
-
setConfig() public
Sets the config.
-
setLocale() public
Sets the locale to be used.
-
setTableLocator() public
Sets the table locator.
-
setupAssociations() protected
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.
-
unsetEmptyFields() protected
Unset empty translations to avoid persistence.
Method Detail
__construct() ¶ public
__construct(Cake\ORM\Table $table, array $config = [])Constructor
Parameters
-
Cake\ORM\Table$table The table this strategy is attached to.
-
array$config optional The config for this strategy.
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites 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
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
afterSave() ¶ public
afterSave(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity): voidUnsets the temporary _i18n property after the entity has been saved
Parameters
-
Cake\Event\EventInterface$event The beforeSave event that was fired
-
Cake\Datasource\EntityInterface$entity The entity that is going to be saved
Returns
voidbeforeFind() ¶ public
beforeFind(Cake\Event\EventInterface $event, Cake\ORM\Query $query, ArrayObject $options): voidCallback 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\EventInterface$event The beforeFind event that was fired.
-
Cake\ORM\Query$query Query
-
ArrayObject$options The options for the query
Returns
voidbeforeSave() ¶ public
beforeSave(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity, ArrayObject $options): voidModifies the entity before it is saved so that translated fields are persisted in the database too.
Parameters
-
Cake\Event\EventInterface$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
voidbuildMarshalMap() ¶ public
buildMarshalMap(Cake\ORM\Marshaller $marshaller, array $map, array $options): arrayBuild 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$options The options array used in the marshalling call.
Returns
arraybundleTranslatedFields() ¶ protected
bundleTranslatedFields(Cake\Datasource\EntityInterface $entity): voidHelper 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
voidconfigShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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
$thisfindExistingTranslations() ¶ protected
findExistingTranslations(array $ruleSet): arrayReturns 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 array of conditions to be used for finding each
Returns
arraygetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns 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
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns 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
mixedThrows
InvalidArgumentExceptiongetLocale() ¶ public
getLocale(): stringReturns the current locale.
If no locale has been explicitly set via setLocale(), this method will return
the currently configured global locale.
Returns
stringSee Also
\Cake\ORM\Behavior\TranslateBehavior::setLocale()
getTableLocator() ¶ public
getTableLocator(): Cake\ORM\Locator\LocatorInterfaceGets the table locator.
Returns
Cake\ORM\Locator\LocatorInterfacegetTranslationTable() ¶ public
getTranslationTable(): Cake\ORM\TableReturn translation table instance.
Returns
Cake\ORM\TablegroupTranslations() ¶ public
groupTranslations(Cake\Datasource\ResultSetInterface $results): Cake\Collection\CollectionInterfaceModifies 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\CollectionInterfacerowMapper() ¶ protected
rowMapper(Cake\Datasource\ResultSetInterface $results, string $locale): Cake\Collection\CollectionInterfaceModifies 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\CollectionInterfacesetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets 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
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
setLocale() ¶ public
setLocale(string|null $locale): $thisSets the locale to be used.
When fetching records, 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
nullin order to unset the current locale, and to make the behavior fall back to using the globally configured locale.
Returns
$thissetTableLocator() ¶ public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $thisSets the table locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface instance.
Returns
$thissetupAssociations() ¶ protected
setupAssociations(): voidCreates 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.
Returns
voidtranslationField() ¶ public
translationField(string $field): stringReturns 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
stringunsetEmptyFields() ¶ protected
unsetEmptyFields(Cake\Datasource\EntityInterface $entity): voidUnset 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
voidProperty Detail
$_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.
Type
array$locale ¶ protected
The locale name that will be used to override fields in the bound table from the translations table
Type
string|null