Трейт ViewVarsTrait

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

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

Непосредственные пользователи

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

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

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

$_viewBuilder protected

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

string|null
Имя по умолчанию класса View.
$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 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 deprecated

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

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

Устарело

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

Параметры

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

Возвращает

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

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

$_viewBuildersource

protected Cake\View\ViewBuilder

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

$viewClasssource

public string|null

Имя по умолчанию класса View.

Устарело

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

$viewVarssource

public array

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

Устарело

3.7.0 Используйте $this->set() вместо этого, также см. $this->viewBuilder()->getVar().

[]

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

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