Трейт TranslateStrategyTrait
Содержит общий код, необходимый классам стратегии TranslateBehavior.
Краткое описание свойств
- $locale protected
string|nullИмя локали, которое будет использоваться для переопределения полей в связанной таблице из таблицы переводов
- $table protected
Cake\ORM\TableЭкземпляр таблицы
- $translationTable protected
Cake\ORM\TableЭкземпляр таблицы, ответственной за перевод
Краткое описание методов
-
afterSave() public
Снимает временное свойство
_i18nпосле сохранения сущности -
buildMarshalMap() public
Создает набор свойств, которые должны быть включены в процесс маршаллирования.
-
getLocale() public
Возвращает текущую локаль.
-
getTranslationTable() public
Возвращает экземпляр таблицы переводов.
-
setLocale() public
Устанавливает используемую локаль.
-
unsetEmptyFields() protected
Удаляет пустые переводы для предотвращения сохранения.
Подробное описание методов
afterSave() public
afterSave(Cake\Event\EventInterface $event, Cake\Datasource\EntityInterface $entity): void
Снимает временное свойство _i18n после сохранения сущности
Параметры
-
Cake\Event\EventInterface$event Событие beforeSave, которое было запущено
-
Cake\Datasource\EntityInterface$entity Сущность, которая будет сохранена
Возвращаемое значение
voidbuildMarshalMap() public
buildMarshalMap(Cake\ORM\Marshaller $marshaller, array $map, array<string, mixed> $options): array
Создает набор свойств, которые должны быть включены в процесс маршаллирования.
Добавляет обработчики маршаллирования _translations. Вы можете отключить маршаллирование переводов, установив 'translations' => false в параметрах, предоставленных для Table::newEntity() или Table::patchEntity().
Параметры
-
Cake\ORM\Marshaller$marshaller Маршаллировщик таблицы, к которой прикреплен этот трейт.
-
array$map Создаваемая карта свойств.
-
array<string, mixed>$options Массив параметров, используемый в вызове маршаллирования.
Возвращаемое значение
arraygetLocale() public
getLocale(): string
Возвращает текущую локаль.
Если локаль не была явно установлена с помощью setLocale(), этот метод вернет текущую глобальную локаль.
Возвращаемое значение
stringСм. также
\Cake\ORM\Behavior\TranslateBehavior::setLocale()
getTranslationTable() public
getTranslationTable(): Cake\ORM\Table
Возвращает экземпляр таблицы переводов.
Возвращаемое значение
Cake\ORM\TablesetLocale() public
setLocale(string|null $locale): $this
Устанавливает используемую локаль.
При извлечении записей, контент для установленной с помощью этого метода локали, и, аналогично, при сохранении данных, данные будут сохранены в этой локали.
Обратите внимание, что в случае, если у сущности установлено свойство _locale, эта локаль будет иметь приоритет над локаллю, установленной с помощью этого метода (и над глобально настроенной для данного случая)!
Параметры
-
string|null$locale Локаль для извлечения и сохранения записей. Передайте
nullдля снятия текущей локали и возврата поведения к использованию глобально настроенной локали.
Возвращаемое значение
$thisunsetEmptyFields() protected
unsetEmptyFields(Cake\Datasource\EntityInterface $entity): void
Удаляет пустые переводы для предотвращения сохранения.
Должен вызываться только если $this->_config['allowEmptyTranslations'] ложно.
Параметры
-
Cake\Datasource\EntityInterface$entity Сущность, в которой проверяются поля пустых переводов.
Возвращаемое значение
voidПодробное описание свойств
$locale protected
Имя локали, которое будет использоваться для переопределения полей в связанной таблице из таблицы переводов
Тип
string|null$table protected
Экземпляр таблицы
Тип
Cake\ORM\Table$translationTable protected
Экземпляр таблицы, ответственной за перевод
Тип
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/trait-Cake.ORM.Behavior.Translate.TranslateStrategyTrait.html
