Интерфейс TranslateStrategyInterface

Данный интерфейс описывает методы для стратегий поведения перевода.

Пространство имён: Cake\ORM\Behavior\Translate

Краткое описание методов

afterSave() public

Снимает временное свойство _i18n после сохранения сущности.
beforeFind() public

Метод обратного вызова, реагирующий на событие beforeFind в связанной таблице. Он изменяет переданный запрос, загружая жадно поля перевода и добавляя форматировщик для копирования значений в записи основной таблицы.
beforeSave() public

Изменяет сущность перед сохранением, чтобы поля перевода также сохранялись в базе данных.
buildMarshalMap() public

Создаёт набор свойств, которые должны быть включены в процесс маршаллирования.
getLocale() public

Возвращает текущий язык.
getTranslationTable() public

Возвращает экземпляр таблицы перевода.
groupTranslations() public

Изменяет результаты поиска таблицы, чтобы объединить полные записи перевода в каждую сущность под ключом _translations.
setLocale() public

Устанавливает используемый язык.
translationField() public

Возвращает полностью алиасовое имя поля для полей перевода.

Подробное описание методов

afterSave() public

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

Снимает временное свойство _i18n после сохранения сущности.

Параметры

Cake\Event\EventInterface $event: Событие beforeSave, которое было запущено.
Cake\Datasource\EntityInterface $entity: Сущность, которая будет сохранена.

Возвращает

void

beforeFind() public

beforeFind(Cake\Event\EventInterface $event, Cake\ORM\Query $query, ArrayObject $options): void

Метод обратного вызова, реагирующий на событие beforeFind в связанной таблице. Он изменяет переданный запрос, загружая жадно поля перевода и добавляя форматировщик для копирования значений в записи основной таблицы.

Параметры

Cake\Event\EventInterface $event: Событие beforeFind, которое было запущено.
Cake\ORM\Query $query: Запрос.
ArrayObject $options: Параметры запроса.

Возвращает

void

beforeSave() public

beforeSave(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity, ArrayObject $options): void

Изменяет сущность перед сохранением, чтобы поля перевода также сохранялись в базе данных.

Параметры

Cake\Event\EventInterface $event: Событие beforeSave, которое было запущено.
Cake\Datasource\EntityInterface $entity: Сущность, которая будет сохранена.
ArrayObject $options: Параметры, переданные методу сохранения.

Возвращает

void

buildMarshalMap() public

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

Создаёт набор свойств, которые должны быть включены в процесс маршаллирования.

Параметры

Cake\ORM\Marshaller $marshaller: Маршаллировщик таблицы, к которой прикреплено поведение.
array $map: Карта свойств, которая создаётся.
array $options: Массив параметров, используемый в вызове маршаллирования.

Возвращает

array

getLocale() public

getLocale(): string

Возвращает текущий язык.

Если язык явно не был установлен с помощью setLocale(), этот метод вернёт текущий глобально настроенный язык.

Возвращает

string

getTranslationTable() public

getTranslationTable(): Cake\ORM\Table

Возвращает экземпляр таблицы перевода.

Возвращает

Cake\ORM\Table

groupTranslations() public

groupTranslations(Cake\Datasource\ResultSetInterface $results): Cake\Collection\CollectionInterface

Изменяет результаты поиска таблицы, чтобы объединить полные записи перевода в каждую сущность под ключом _translations.

Параметры

Cake\Datasource\ResultSetInterface $results: Результаты для изменения.

Возвращает

Cake\Collection\CollectionInterface

setLocale() public

setLocale(string|null $locale): $this

Устанавливает используемый язык.

При получении записей содержимое для языка, установленного с помощью этого метода, и, аналогично, при сохранении данных, сохраняет данные на этом языке.

Обратите внимание, что если для сущности установлено свойство _locale, этот язык будет иметь приоритет перед языком, установленным с помощью этого метода (и перед глобально настроенным языком)!

Параметры

string|null $locale: Язык для получения и сохранения записей. Передайте null для отмены текущего языка и чтобы поведение вернулось к использованию глобально настроенного языка.

Возвращает

$this

translationField() public

translationField(string $field): string

Возвращает полностью алиасовое имя поля для полей перевода.

Если запрашиваемое поле настроено как поле перевода, возвращается поле с алиасом соответствующей ассоциации. Для всех других полей возвращается имя поля с алиасом таблицы.

Параметры

string $field: Имя поля для алиасирования.

Возвращает

string

© 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.2/interface-Cake.ORM.Behavior.Translate.TranslateStrategyInterface.html