Трейт ViewVarsTrait

Предоставляет метод set() для сбора контекста шаблона.

После сбора данные контекста могут быть переданы другому объекту. Это делается, например, в контроллере, задаче шаблона и представлении.

Прямые пользователи

Косвенные пользователи

Пространство имен: Cake\View
Расположение: View/ViewVarsTrait.php

Краткое описание свойств

$_viewBuilder protected

Cake\View\ViewBuilder
Экземпляр используемого билдера представлений.
$viewClass public

string|null
Имя класса представления по умолчанию.
$viewVars public

array
Переменные для представления.

Краткое описание магических свойств

$_validViewOptions public

array

Краткое описание методов

createView() public
Создает экземпляр класса представления на основе текущей конфигурации.
set() public
Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.
viewBuilder() public
Получить используемый билдер представлений.
viewOptions() public

Получить/установить допустимые параметры представления в свойстве _validViewOptions объекта. Свойство создаётся как пустой массив, если оно не установлено. Если вызывается без параметров, возвращает текущий список допустимых параметров представления. См. createView().

Подробное описание методов

createView()source public

createView( string|null $viewClass = null )

Создает экземпляр класса представления на основе текущей конфигурации.

Параметры

string|null $viewClass optional null: Необязательное имя класса представления с именем пространства имён для создания экземпляра.

Возвращает

Cake\View\View

Издаёт исключение

Cake\View\Exception\MissingViewException
Если класс представления не найден.

set()source public

set( string|array $name , mixed $value = null )

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

string|array $name: Строка или массив данных.
mixed $value optional null: Значение в случае, если $name является строкой (которая затем используется в качестве ключа). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.

Возвращает

$this

viewBuilder()source public

viewBuilder( )

Получить используемый билдер представлений.

Возвращает

Cake\View\ViewBuilder

viewOptions()source public

viewOptions( string|array|null $options = null , boolean $merge = true )

Получить/установить допустимые параметры представления в свойстве _validViewOptions объекта. Свойство создаётся как пустой массив, если оно не установлено. Если вызывается без параметров, возвращает текущий список допустимых параметров представления. См. createView().

Параметры

string|array|null $options optional null: строка или массив строк, которые нужно добавить в _validViewOptions.
boolean $merge optional true: Следует ли объединять или перезаписывать существующие допустимые параметры представления. По умолчанию true.

Возвращает

массив
Обновленные параметры представления в виде массива.

Подробное описание свойств

$_viewBuildersource

protected Cake\View\ViewBuilder

Экземпляр используемого билдера представлений.

$viewClasssource

public string|null

Имя класса представления по умолчанию.

Устаревшее

3.1.0 Используйте $this->viewBuilder()->getClassName()/$this->viewBuilder()->setClassName() вместо этого.

$viewVarssource

public array

Переменные для представления

[]

Подробное описание магических свойств

$_validViewOptionssource

public array

© 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/3.6/class-Cake.View.ViewVarsTrait.html