Class ShadowTableStrategy
This class provides a way to translate dynamic data by keeping translations in a separate shadow table where each row corresponds to a row of primary table.
Properties 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.
-
addFieldsToQuery() protected
Add translation fields to query.
-
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. -
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. -
iterateClause() protected
Iterate over a clause to alias fields.
-
mainFields() protected
Lazy define and return the main table fields.
-
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
Create a hasMany association for all records.
-
translatedFields() protected
Lazy define and return the translation table fields.
-
translationField() public
Returns a fully aliased field name for translated fields.
-
traverseClause() protected
Traverse over a clause to alias 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 Table instance.
-
array$config optional Configuration.
_configDelete() protected ¶
_configDelete(string $key)
Deletes a single config key.
Parameters
-
string$key Key to delete.
Throws
Cake\Core\Exception\Exceptionif 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\Exceptionif attempting to clobber existing config
addFieldsToQuery() protected ¶
addFieldsToQuery(mixed $query, array $config)
Add translation fields to query.
If the query is using autofields (directly or implicitly) add the main table's fields to the query first.
Only add translations for fields that are in the main table, always add the locale field though.
Parameters
-
\Cake\ORM\Query$query The query to check.
-
array$config The config to use for adding fields.
Returns
boolWhether a join to the translation table is required.
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
arrayA 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
$thisgetConfig() 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
mixedConfiguration 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
mixedConfiguration data at the named key
Throws
InvalidArgumentExceptiongetLocale() 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
stringSee Also
\Cake\ORM\Behavior\TranslateBehavior::setLocale()
getTableLocator() public ¶
getTableLocator()
Gets the table locator.
Returns
\Cake\ORM\Locator\LocatorInterfacegetTranslationTable() public ¶
getTranslationTable()
Return translation table instance.
Returns
\Cake\ORM\TablegroupTranslations() 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\CollectionInterfaceiterateClause() protected ¶
iterateClause(mixed $query, mixed $name, mixed $config)
Iterate over a clause to alias fields.
The objective here is to transparently prevent ambiguous field errors by prefixing fields with the appropriate table alias. This method currently expects to receive an order clause only.
Parameters
-
\Cake\ORM\Query$query the query to check.
-
string$name optional The clause name.
-
array$config optional The config to use for adding fields.
Returns
boolWhether a join to the translation table is required.
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\CollectionInterfacesetConfig() 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
$thisThrows
Cake\Core\Exception\ExceptionWhen 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
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)
Sets the table locator.
Parameters
-
\Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface instance.
Returns
$thissetupAssociations() protected ¶
setupAssociations()
Create a hasMany association for all records.
Don't create a hasOne association here as the join conditions are modified in before find - so create/modify it there.
translatedFields() protected ¶
translatedFields()
Lazy define and return the translation table fields.
Returns
arraytranslationField() public ¶
translationField(string $field)
Returns a fully aliased field name for translated fields.
If the requested field is configured as a translation field, 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
stringtraverseClause() protected ¶
traverseClause(mixed $query, mixed $name, mixed $config)
Traverse over a clause to alias fields.
The objective here is to transparently prevent ambiguous field errors by prefixing fields with the appropriate table alias. This method currently expects to receive a where clause only.
Parameters
-
\Cake\ORM\Query$query the query to check.
-
string$name optional The clause name.
-
array$config optional The config to use for adding fields.
Returns
boolWhether a join to the translation table is required.
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
$_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