Трейт 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 deprecated

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

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

createView()source public

createView( string|null $viewClass = null )

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

Параметры

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

Возвращает

Cake\View\View

Выбрасывает

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

set()source public

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

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

Параметры

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

Возвращает

$this

viewBuilder()source public

viewBuilder( )

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

Возвращает

Cake\View\ViewBuilder

viewOptions()source public deprecated

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

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

Устаревшее

3.7.0 Используйте ViewBuilder::setOptions() или любой из его методов-сеттеров вместо этого.

Параметры

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

Возвращает

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

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

$_viewBuildersource

protected Cake\View\ViewBuilder

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

$viewClasssource

public string|null

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

Устаревшее

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

$viewVarssource

public array

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

Устаревшее: Это свойство будет удалено в версии 4.x. В контексте контроллера используйте $this->set() вместо этого, также см. $this->viewBuilder()->getVar(). В контексте представления это будет защищённое свойство View::$viewVars.

[]

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

$_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.8/class-Cake.View.ViewVarsTrait.html