Класс ViewBuilder

autoLayoutsource public

autoLayout( boolean|null $autoLayout null )

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

Параметры

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

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

Возвращает

boolean|$this
$this

buildsource 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.

Параметры

массив $vars необязательно []

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

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

Запрос, который нужно использовать.

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

Ответ, который нужно использовать.

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

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

Возвращает

Cake\View\View
\Cake\View\View

Выбрасывает

Cake\View\Exception\MissingViewException
\Cake\View\Exception\MissingViewException

classNamesource public

className( string|null $name null )

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

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

Параметры

строка|null $name необязательно null

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

Возвращает

array|$this
$this

createFromArraysource public

createFromArray( array $config )

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

Параметры

массив $config

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

Возвращает

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

helperssource public

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

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

Параметры

массив $helpers необязательно null

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

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

Слияние существующих данных с новыми данными.

Возвращает

array|$this
$this

jsonSerializesource public

jsonSerialize( )

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

Возвращает

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

Реализация

JsonSerializable::jsonSerialize()

layoutsource public

layout( string|null $name null )

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

Параметры

строка|null $name необязательно null

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

Возвращает

string|$this
$this

layoutPathsource public

layoutPath( string|null $path null )

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

Параметры

строка|null $path необязательно null

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

Возвращает

string|$this
$this

namesource public

name( string|null $name null )

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

Параметры

строка|null $name необязательно null

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

Возвращает

array|$this
$this

optionssource public

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

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

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

Параметры

массив $options необязательно null

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

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

Слияние существующих данных с новыми данными.

Возвращает

array|$this
$this

pluginsource public

plugin( string|null|false $name null )

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

Параметры

строка|null|false $name необязательно null

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

Возвращает

string|$this
$this

serializesource public

serialize( )

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

Возвращает

string
строка

Реализация

Serializable::serialize()

templatesource public

template( string|null $name null )

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

Параметры

строка|null $name необязательно null

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

Возвращает

string|$this
$this

templatePathsource public

templatePath( string|null $path null )

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

Параметры

строка|null $path необязательно null

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

Возвращает

string|$this
$this

themesource public

theme( string|null|false $theme null )

Тему представления, которую нужно использовать.

Параметры

строка|null|false $theme необязательно null

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

Возвращает

string|$this
$this

unserializesource public

unserialize( string $data )

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

Параметры

строка $data

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

Возвращает

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

Реализация

Serializable::unserialize()

[]

[]