Interface TranslateStrategyInterface
This interface describes the methods for translate behavior strategies.
Method Summary
-
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.
-
getLocale() public
Returns the current locale.
-
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 -
setLocale() public
Sets the locale to be used.
-
translationField() public
Returns a fully aliased field name for translated fields.
Method Detail
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.
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
arraygetLocale() ¶ 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
stringgetTranslationTable() ¶ 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\CollectionInterfacesetLocale() ¶ 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
$thistranslationField() ¶ public
translationField(string $field): stringReturns 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
string