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.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default config
Cake\ORM\Locator\LocatorInterface|nullTable locator instance
string|nullThis object's default table alias.
string|nullThe locale name that will be used to override fields in the bound table from the translations table
Cake\ORM\TableTable instance
Cake\ORM\TableInstance of Table responsible for translating
Constructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Add translation fields to query.
Unsets the temporary _i18n property after the entity has been saved
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.
Modifies the entity before it is saved so that translated fields are persisted in the database too.
Build a set of properties that should be included in the marshalling process.
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.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Convenience method to get a table instance.
Returns the config.
Returns the config for this specific key.
Returns the current locale.
Gets the table locator.
Return translation table instance.
Modifies the results from a table find in order to merge full translation records into each entity under the _translations key.
Iterate over a clause to alias fields.
Lazy define and return the main table fields.
Modifies the results from a table find in order to merge the translated fields into each entity for a given locale.
Sets the config.
Sets the locale to be used.
Sets the table locator.
Create a hasMany association for all records.
Create a hasOne association for record with required locale.
Lazy define and return the translation table fields.
Returns a fully aliased field name for translated fields.
Traverse over a clause to alias fields.
Unset empty translations to avoid persistence.
__construct(Cake\ORM\Table $table, array<string, mixed> $config = [])
Constructor
Cake\ORM\Table $table Table instance.
array<string, mixed> $config optional Configuration.
_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
voidCake\Core\Exception\CakeExceptionaddFieldsToQuery(Cake\ORM\Query $query, array<string, mixed> $config): bool
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.
Cake\ORM\Query $query The query to check.
array<string, mixed> $config The config to use for adding fields.
boolafterSave(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity): void
Unsets the temporary _i18n property after the entity has been saved
Cake\Event\EventInterface $event The beforeSave event that was fired
Cake\Datasource\EntityInterface $entity The entity that is going to be saved
voidbeforeFind(Cake\Event\EventInterface $event, Cake\ORM\Query $query, ArrayObject $options): void
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.
Cake\Event\EventInterface $event The beforeFind event that was fired.
Cake\ORM\Query $query Query.
ArrayObject $options The options for the query.
voidbeforeSave(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity, ArrayObject $options): void
Modifies the entity before it is saved so that translated fields are persisted in the database too.
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.
voidbuildMarshalMap(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().
Cake\ORM\Marshaller $marshaller array $map array<string, mixed> $options arraybundleTranslatedFields(Cake\Datasource\EntityInterface $entity): void
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.
Cake\Datasource\EntityInterface $entity Entity.
voidconfigShallow(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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisfetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table
Convenience method to get a table instance.
string|null $alias optional The alias name you want to get. Should be in CamelCase format. If null then the value of $defaultTable property is used.
array<string, mixed> $options optional The options you want to build the table with. If a table has already been loaded the registry options will be ignored.
Cake\ORM\TableCake\Core\Exception\CakeExceptiongetConfig(string|null $key = null, mixed $default = null): mixed
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.
mixedgetConfigOrFail(string $key): mixed
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.
mixedInvalidArgumentExceptiongetLocale(): string
Returns the current locale.
If no locale has been explicitly set via setLocale(), this method will return the currently configured global locale.
stringgetTableLocator(): Cake\ORM\Locator\LocatorInterface
Gets the table locator.
Cake\ORM\Locator\LocatorInterfacegetTranslationTable(): Cake\ORM\Table
Return translation table instance.
Cake\ORM\TablegroupTranslations(Cake\Datasource\ResultSetInterface $results): Cake\Collection\CollectionInterface
Modifies the results from a table find in order to merge full translation records into each entity under the _translations key.
Cake\Datasource\ResultSetInterface $results Results to modify.
Cake\Collection\CollectionInterfaceiterateClause(Cake\ORM\Query $query, string $name = '', array<string, mixed> $config = []): bool
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.
Cake\ORM\Query $query the query to check.
string $name optional The clause name.
array<string, mixed> $config optional The config to use for adding fields.
boolmainFields(): array<string>
Lazy define and return the main table fields.
array<string>rowMapper(Cake\Datasource\ResultSetInterface $results, string $locale): Cake\Collection\CollectionInterface
Modifies the results from a table find in order to merge the translated fields into each entity for a given locale.
Cake\Datasource\ResultSetInterface $results Results to map.
string $locale Locale string
Cake\Collection\CollectionInterfacesetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
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.
$thisCake\Core\Exception\CakeExceptionsetLocale(string|null $locale): $this
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)!
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.
$thissetTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this
Sets the table locator.
Cake\ORM\Locator\LocatorInterface $tableLocator LocatorInterface instance.
$thissetupAssociations(): void
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.
voidsetupHasOneAssociation(string $locale, ArrayObject $options): void
Create a hasOne association for record with required locale.
string $locale Locale
ArrayObject $options Find options
voidtranslatedFields(): array<string>
Lazy define and return the translation table fields.
array<string>translationField(string $field): string
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.
string $field Field name to be aliased.
stringtraverseClause(Cake\ORM\Query $query, string $name = '', array<string, mixed> $config = []): bool
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.
Cake\ORM\Query $query the query to check.
string $name optional The clause name.
array<string, mixed> $config optional The config to use for adding fields.
boolunsetEmptyFields(Cake\Datasource\EntityInterface $entity): void
Unset empty translations to avoid persistence.
Should only be called if $this->_config['allowEmptyTranslations'] is false.
Cake\Datasource\EntityInterface $entity The entity to check for empty translations fields inside.
voidRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault config
These are merged with user-provided configuration.
array<string, mixed>Table locator instance
Cake\ORM\Locator\LocatorInterface|nullThis object's default table alias.
string|nullThe locale name that will be used to override fields in the bound table from the translations table
string|nullTable instance
Cake\ORM\TableInstance of Table responsible for translating
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.4/class-Cake.ORM.Behavior.Translate.ShadowTableStrategy.html