Class app\modules\main\components\BlocksProvider

Inheritanceapp\modules\main\components\BlocksProvider » yii\base\Object

Class BlocksProvider Провайдер символьных идентификаторов меню и включаемых областей.

Предоставляет интерфейс для того чтобы сопоставить место блока в шаблоне сайта и символьный идентификатор включаемой области или меню. Это необходимо для того, чтобы компоненты сайта могли динамичеки переопределять подключаемы области.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$areas array массив сопоставлений для включаемых областей app\modules\main\components\BlocksProvider
$menus array массив сопоставлений для меню app\modules\main\components\BlocksProvider

Public Methods

Hide inherited methods

MethodDescriptionDefined By
getArea() Возвращает символьный код включаемой области для места app\modules\main\components\BlocksProvider
getMenu() Возвращает символьный код меню для места app\modules\main\components\BlocksProvider
setArea() app\modules\main\components\BlocksProvider
setMenu() Устанавливает соответствие для меню app\modules\main\components\BlocksProvider

Property Details

$areas public property
array $areas = []

массив сопоставлений для включаемых областей

$menus public property
array $menus = []

массив сопоставлений для меню

Method Details

getArea() public method

Возвращает символьный код включаемой области для места

string|null getArea( $placeCode, $default = null )
$placeCode string

код места
$default string|null

значение по умолчанию
getMenu() public method

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

string|null getMenu( $placeCode, $default = null )
$placeCode string

код места
$default string|null

значение по умолчанию
setArea() public method

void setArea( $placeCode, $areaCode )
$placeCode string

код места
$areaCode string

символьный код включаемой области
setMenu() public method

Устанавливает соответствие для меню

void setMenu( $placeCode, $menuCode )
$placeCode string

код места
$menuCode string

символьный код меню