Трейт 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–2017 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.4/class-Cake.View.ViewVarsTrait.html