Трейт ViewVarsTrait

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

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

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

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

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

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

$_viewBuilder protected

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

string
Имя класса представления по умолчанию.
$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 необязательно 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

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

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

Параметры

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

Возвращает

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

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

$_viewBuildersource

protected Cake\View\ViewBuilder

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

$viewClasssource

public string

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

Устарело

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

$viewVarssource

public array

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

[]

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

$_validViewOptionssource

public array

© 2005–2018 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.5/class-Cake.View.ViewVarsTrait.html