Трейт ViewVarsTrait

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

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

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

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

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

Резюме свойств

$_viewBuilder protected

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

string
Имя класса представления по умолчанию.
$viewVars 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 , string|array|null|boolean $value null )

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

Параметры

string|array $name: Строка или массив данных.
string|array|null|boolean $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()->className() вместо этого.

null

$viewVarssource

public array

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

[]

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.View.ViewVarsTrait.html