Класс 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 )

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

Параметры

array $config

Массив конфигурации ViewBuilder.

Возвращает

$this Настроенный экземпляр view builder.

helpers()source public

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

Помощники для использования

Параметры

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

Помощники для использования.

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

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

Возвращает

array|Cake\View\ViewBuilder
$this

jsonSerialize()source public

jsonSerialize( )

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

Возвращает

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( )

Сериализует объект view builder.

Возвращает

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 )

Десериализует объект view builder.

Параметры

string $data

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

Возвращает

$this Настроенный экземпляр view builder.

Реализация

Serializable::unserialize()

[]

[]