Класс ViewBuilder

autoLayout()source public

autoLayout( boolean|null $autoLayout null )

Включает или отключает стандартный режим CakePHP применения файлов макета. Включено по умолчанию. Отключение означает, что макеты не будут автоматически применяться к отрисовываемым представлениям.

Параметры

boolean|null $autoLayout необязательно null

Булево значение для включения/выключения. Если null, возвращает текущее значение.

Возвращаемое значение

boolean|Cake\View\ViewBuilder
$this

build()source public

build( array $vars [] , Cake\Network\Request $request null , Cake\Network\Response $response null , Cake\Event\EventManager $events null )

Создание экземпляра представления на основе данных в билдере.

Если className() равно null, будет использоваться App\View\AppView. Если этот класс не существует, используется Cake\View\View.

Параметры

array $vars необязательно []

Переменные/контекст представления для использования.

Cake\Network\Request $request необязательно null

Используемый запрос.

Cake\Network\Response $response необязательно null

Используемый ответ.

Cake\Event\EventManager $events необязательно null

Используемый менеджер событий.

Возвращаемое значение

Cake\View\View

Вызываемые исключения

Cake\View\Exception\MissingViewException

className()source public

className( string|null $name null )

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

Принимает короткое имя (Ajax), имя плагина (MyPlugin.Ajax) или полное имя с пространством имён (App\View\AppView).

Параметры

string|null $name необязательно null

Имя класса представления. Может быть ссылкой на имя класса плагина, коротким псевдонимом или полным именем с пространством имён.

Возвращаемое значение

array|Cake\View\ViewBuilder
$this

createFromArray()source public

createFromArray( array $config )

Настройка экземпляра билдера представления из сериализованной конфигурации.

Параметры

array $config

Массив конфигурации билдера представления.

Возвращаемое значение

$this Настроенный экземпляр билдера представления.

helpers()source public

helpers( array $helpers null , boolean $merge true )

Используемые помощники (helpers)

Параметры

array $helpers необязательно null

Используемые помощники.

boolean $merge необязательно true

Объединить ли существующие данные с новыми.

Возвращаемое значение

array|Cake\View\ViewBuilder
$this

jsonSerialize()source public

jsonSerialize( )

Сериализация объекта билдера представления в значение, которое можно напрямую сериализовать и повторно использовать для клонирования этого билдера.

Возвращаемое значение

array
Сериализуемый массив свойств конфигурации.

Реализация

JsonSerializable::jsonSerialize()

layout()source public

layout( string|null $name null )

Получить/установить имя файла макета для рендеринга представления. Указанное имя — это имя файла макета в /src/Template/Layout без расширения .ctp.

Параметры

string|null $name необязательно null

Имя файла макета для установки. Если null, возвращает текущее имя.

Возвращает

string|Cake\View\ViewBuilder
$this

layoutPath()source public

layoutPath( string|null $path null )

Получить/установить путь к файлам макета.

Параметры

string|null $path необязательно null

Путь к файлам макета. Если null, возвращает текущий путь.

Возвращает

string|Cake\View\ViewBuilder
$this

name()source public

name( string|null $name null )

Получить/установить имя представления

Параметры

string|null $name необязательно null

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

Возвращает

array|Cake\View\ViewBuilder
$this

options()source public

options( array $options null , boolean $merge true )

Установить дополнительные параметры для представления.

Это позволяет передавать пользовательские аргументы конструктора класса представления в приложениях/плагинах.

Параметры

array $options необязательно null

Массив параметров или null для получения текущих параметров.

boolean $merge необязательно true

Флаг, объединять ли существующие данные с новыми данными.

Возвращает

array|Cake\View\ViewBuilder
$this

plugin()source public

plugin( string|null|false $name null )

Имя плагина для использования

Параметры

string|null|false $name необязательно null

Имя плагина. Если null, возвращает текущий плагин. Используйте false для удаления текущего имени плагина.

Возвращает

string|Cake\View\ViewBuilder
$this

serialize()source public

serialize( )

Сериализует объект билдера представления.

Возвращает

string

Реализация

Serializable::serialize()

template()source public

template( string|null $name null )

Получить/установить имя файла представления для рендеринга. Указанное имя — это имя файла в /src/Template/<подпапка> без расширения .ctp.

Параметры

string|null $name необязательно null

Имя файла представления для установки. Если null, возвращает текущее имя.

Возвращает

string|Cake\View\ViewBuilder
$this

templatePath()source public

templatePath( string|null $path null )

Получить/установить путь к файлам шаблонов.

Параметры

string|null $path необязательно null

Путь к файлам представлений. Если null, возвращает текущий путь.

Возвращает

string|Cake\View\ViewBuilder
$this

theme()source public

theme( string|null|false $theme null )

Тема представления для использования.

Параметры

string|null|false $theme необязательно null

Имя темы. Если null, возвращает текущую тему. Используйте false для удаления текущей темы.

Возвращает

string|Cake\View\ViewBuilder
$this

unserialize()source public

unserialize( string $data )

Десериализует объект билдера представления.

Параметры

string $data

Сериализованная строка.

Возвращает

$this Конфигурированный экземпляр билдера представления.

Реализация

Serializable::unserialize()

[]

[]