Трейт ViewVarsTrait
Предоставляет метод set() для сбора контекста шаблона.
После сбора данные контекста могут быть переданы другому объекту. Это делается, например, в контроллере, задаче шаблона и представлении.
Прямые пользователи
Косвенные пользователи
- Cake\Controller\ErrorController
- Cake\View\AjaxView
- Cake\View\JsonView
- Cake\View\SerializedView
- Cake\View\XmlView
Краткое описание свойств
- Экземпляр используемого билдера представлений.
$_viewBuilderprotected -
$viewClasspublicИмя класса представления по умолчанию.string -
$viewVarspublicПеременные для представления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\ViewBuilderviewOptions()source public
viewOptions( string|array|null $options null , boolean $merge true )
Получить/установить допустимые параметры представления в свойстве объекта _validViewOptions. Свойство создаётся как пустой массив, если оно не задано. Если вызывается без параметров, возвращает текущий список допустимых параметров представления. См. createView().
Параметры
- string|array|null
$optionsнеобязательный null - Строка или массив строк, которые будут добавлены в _validViewOptions.
- boolean
$mergeнеобязательный true Объединить или перезаписать существующие допустимые параметры представления. По умолчанию
true.
Возвращает
массивОбновлённые параметры представления в виде массива.
Подробное описание свойств
$viewClasssource
public string
Имя класса представления по умолчанию.
Устарело
3.1.0 Используйте$this->viewBuilder()->className() вместо этого.null
© 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.3/class-Cake.View.ViewVarsTrait.html