PHP Класс RainLab\Translate\Behaviors\TranslatableCmsObject

Usage: In the CMS object class definition: public $implement = ['@RainLab.Translate.Behaviors.TranslatableCmsObject']; public $translatable = ['title', 'markup']; This definition is optional and defaults to RainLab\Translate\Classes\MLCmsObject public $translatableModel = 'RainLab\Translate\Classes\MLStaticPage';
Наследование: extends RainLab\Translate\Classes\TranslatableBehavior
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$translatableViewBag Data store for translated viewbag attributes.

Открытые методы

Метод Описание
__construct ( October\Rain\Database\Model $model ) Constructor
getTranslatableModelClass ( ) : array Returns a collection of fields that will be hashed.
syncTranslatableAttributes ( ) {@inheritDoc}

Защищенные методы

Метод Описание
createModel ( ) : Model Internal method, prepare the form model object
getCmsObjectForLocale ( $locale )
isEmptyDataSet ( array $data ) : boolean Returns true if all attributes are empty (false when converted to booleans).
loadTranslatableData ( string $locale = null ) : array Loads the translation data from the join table.
mergeViewBagAttributes ( ) : void Merge the viewBag array for the base and translated objects.
overrideTwigCacheKey ( $key ) : string | null Translated CMS objects need their own unique cache key in twig.
storeTranslatableData ( string $locale = null ) : void Saves the translation data in the join table.
syncTranslatableFileNames ( ) If the parent model file name is changed, this should be reflected in the translated models also.

Описание методов

__construct() публичный Метод

Constructor
public __construct ( October\Rain\Database\Model $model )
$model October\Rain\Database\Model The extended model.

createModel() защищенный Метод

Internal method, prepare the form model object
protected createModel ( ) : Model
Результат Model

getCmsObjectForLocale() защищенный Метод

protected getCmsObjectForLocale ( $locale )

getTranslatableModelClass() публичный Метод

Returns a collection of fields that will be hashed.
public getTranslatableModelClass ( ) : array
Результат array

isEmptyDataSet() защищенный Метод

Returns true if all attributes are empty (false when converted to booleans).
protected isEmptyDataSet ( array $data ) : boolean
$data array
Результат boolean

loadTranslatableData() защищенный Метод

Loads the translation data from the join table.
protected loadTranslatableData ( string $locale = null ) : array
$locale string
Результат array

mergeViewBagAttributes() защищенный Метод

Merge the viewBag array for the base and translated objects.
protected mergeViewBagAttributes ( ) : void
Результат void

overrideTwigCacheKey() защищенный Метод

Translated CMS objects need their own unique cache key in twig.
protected overrideTwigCacheKey ( $key ) : string | null
Результат string | null

storeTranslatableData() защищенный Метод

Saves the translation data in the join table.
protected storeTranslatableData ( string $locale = null ) : void
$locale string
Результат void

syncTranslatableAttributes() публичный Метод

{@inheritDoc}
public syncTranslatableAttributes ( )

syncTranslatableFileNames() защищенный Метод

If the parent model file name is changed, this should be reflected in the translated models also.
protected syncTranslatableFileNames ( )

Описание свойств

$translatableViewBag защищенное свойство

Data store for translated viewbag attributes.
protected $translatableViewBag