PHP Класс RainLab\Pages\Classes\Menu

Автор: Alexey Bobkov, Samuel Georges
Наследование: extends Cms\Classes\CmsObject
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$allowedExtensions Allowable file extensions.
$contentDataCache Cache store used by parseContent method.
$defaultExtension Default file extension.
$dirName The container name associated with the model, eg: pages.
$fillable The attributes that are mass assignable.
$purgeable List of attribute names which are not considered "settings".

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

Метод Описание
beforeSave ( ) : void Triggered before the menu is saved.
beforeValidate ( ) : void Validate custom attributes.
generateReferences ( Cms\Classes\Page $page ) : array Returns the menu item references.
getCodeAttribute ( ) : string Returns the menu code.
getItemDataAttribute ( ) : array Returns a default value for itemData attribute.
getItemsAttribute ( ) : array Returns a default value for items attribute.
getNameAttribute ( ) : string Returns a default value for name attribute.
initCacheItem ( &$item ) Initializes a cache item.
setCodeAttribute ( string $code ) : Cms\Classes\CmsObject Sets the menu code.

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

Метод Описание
parseContent ( ) : array | null Processes the content attribute to an array of menu data.
renderContent ( ) : string Renders the menu data as a content string in YAML format.

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

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

Triggered before the menu is saved.
public beforeSave ( ) : void
Результат void

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

Validate custom attributes.
public beforeValidate ( ) : void
Результат void

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

This function is used on the front-end.
public generateReferences ( Cms\Classes\Page $page ) : array
$page Cms\Classes\Page The current page object.
Результат array Returns an array of the \RainLab\Pages\Classes\MenuItemReference objects.

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

Returns the menu code.
public getCodeAttribute ( ) : string
Результат string

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

Returns a default value for itemData attribute.
public getItemDataAttribute ( ) : array
Результат array

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

Items are objects of the \RainLab\Pages\Classes\MenuItem class.
public getItemsAttribute ( ) : array
Результат array

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

Returns a default value for name attribute.
public getNameAttribute ( ) : string
Результат string

initCacheItem() публичный статический Метод

Initializes a cache item.
public static initCacheItem ( &$item )

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

Processes the content attribute to an array of menu data.
protected parseContent ( ) : array | null
Результат array | null

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

Renders the menu data as a content string in YAML format.
protected renderContent ( ) : string
Результат string

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

Sets the menu code.
public setCodeAttribute ( string $code ) : Cms\Classes\CmsObject
$code string Specifies the file code.
Результат Cms\Classes\CmsObject Returns the object instance.

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

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

Allowable file extensions.
protected $allowedExtensions

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

Cache store used by parseContent method.
protected $contentDataCache

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

Default file extension.
protected $defaultExtension

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

The container name associated with the model, eg: pages.
protected $dirName

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

The attributes that are mass assignable.
protected $fillable

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

List of attribute names which are not considered "settings".
protected $purgeable