Класс yii\widgets\ContentDecorator
| Наследование | yii\widgets\ContentDecorator » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступен с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/widgets/ContentDecorator.php |
ContentDecorator записывает весь вывод между вызовами begin() и end(), передаёт его заданному файлу представления как $content и затем отображает результат рендеринга.
<?php ContentDecorator::begin([
'viewFile' => '@app/views/layouts/base.php',
'params' => [],
'view' => $this,
]) ?>
some content here
<?php ContentDecorator::end() ?>
В компоненте yii\base\View есть обертки методов yii\base\View::beginContent() и yii\base\View::endContent(), чтобы сделать синтаксис более удобным. В представлении они могут использоваться следующим образом:
<?php $this->beginContent('@app/views/layouts/base.php') ?>
some content here
<?php $this->endContent() ?>
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $autoIdPrefix | string | Префикс для автоматически сгенерированных идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список прикреплённых к этому компоненту поведений. | yii\base\Component |
| $counter | integer | Счётчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $params | array | Параметры (имя => значение), которые будут извлечены и станут доступными в представлении декоратора. | yii\widgets\ContentDecorator |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время рендерятся (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| $viewFile | string | Файл представления, который будет использоваться для оформления содержимого, заключённого в этом виджете. | yii\widgets\ContentDecorator |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Присоединяет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает выполнение виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Заканчивает выполнение виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, присоединенный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Начинает запись фрагмента. | yii\widgets\ContentDecorator |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Заканчивает запись фрагмента. | yii\widgets\ContentDecorator |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создает экземпляр виджета и запускает его. | yii\base\Widget |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает при инициализации виджета с помощью init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$params общедоступное свойство
Параметры (имя => значение), которые будут извлечены и станут доступными в декоративном представлении.
public array $params = []
$viewFile общедоступное свойство
Файл представления, который будет использоваться для декорации содержимого, заключенного в этом виджете. Это может быть указано либо путем к файлу представления, либо псевдонимом пути.
public string $viewFile = null
Подробное описание методов
init() общедоступный метод
Начинает запись фрагмента.
| public void init ( ) |
|---|
run() общедоступный метод
Заканчивает запись фрагмента.
Этот метод останавливает буферизацию вывода и сохраняет результат рендеринга как именованный фрагмент в контроллере.
| public void run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-widgets-contentdecorator.html
