W3cubDocs

/CakePHP 4.1

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.

Properties summary

  • $_config protected
    array

    Runtime config

  • bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config

  • $_tableLocator protected
    \Cake\ORM\Locator\LocatorInterface|null

    Table locator instance

  • $locale protected
    string|null

    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

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 _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

    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 _translations property in the passed entity. The result will be put into its _i18n property.

  • 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 _translations key.

  • 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)

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 $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected

_configWrite(mixed $key, mixed $value, mixed $merge)

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.

Throws

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

afterSave() public

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

Unsets 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

beforeFind() public

beforeFind(\Cake\Event\EventInterface $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\EventInterface $event

The beforeFind event that was fired.

\Cake\ORM\Query $query

Query

\ArrayObject $options

The options for the query

beforeSave() public

beforeSave(\Cake\Event\EventInterface $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\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

buildMarshalMap() public

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

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

The options array used in the marshalling call.

Returns

array

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

bundleTranslatedFields() protected

bundleTranslatedFields(mixed $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

configShallow() public

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

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns

$this

findExistingTranslations() protected

findExistingTranslations(mixed $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 array of conditions to be used for finding each

Returns

array

getConfig() public

getConfig(?string $key, mixed $default)

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

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

getConfigOrFail() public

getConfigOrFail(string $key)

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

Configuration data at the named key

Throws

InvalidArgumentException

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 Also

\Cake\I18n\I18n::getLocale()

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

getTableLocator() public

getTableLocator()

Gets the table locator.

Returns

\Cake\ORM\Locator\LocatorInterface

getTranslationTable() public

getTranslationTable()

Return translation table instance.

Returns

\Cake\ORM\Table

groupTranslations() public

groupTranslations(mixed $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

rowMapper() protected

rowMapper(mixed $results, mixed $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

setConfig() public

setConfig(mixed $key, mixed $value, mixed $merge)

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.

setLocale() public

setLocale(?string $locale)

Sets 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 null in order to unset the current locale, and to make the behavior fall back to using the globally configured locale.

Returns

$this

setTableLocator() public

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

Sets the table locator.

Parameters

\Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

$this

setupAssociations() protected

setupAssociations()

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.

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

unsetEmptyFields() protected

unsetEmptyFields(mixed $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.

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.

Type

array

$_tableLocator protected

Table locator instance

Type

\Cake\ORM\Locator\LocatorInterface|null

$locale protected

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

Type

string|null

$table protected

Table instance

Type

\Cake\ORM\Table

$translationTable protected

Instance of Table responsible for translating

Type

\Cake\ORM\Table

© 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.Translate.EavStrategy.html