Класс ViewBuilder

autoLayout()source public

autoLayout( boolean|null $enable null )

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

Устарело

3.4.0 Используйте enableAutoLayout()/isAutoLayoutEnabled() вместо этого.

Параметры

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

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

Возвращает

boolean|Cake\View\ViewBuilder
$this

build()source public

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

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

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

Параметры

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

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

Cake\Http\ServerRequest $request необязательно null

Запрос для использования.

Cake\Http\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).

Устарело

3.4.0 Используйте setClassName()/getClassName() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

createFromArray()source public

createFromArray( array $config )

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

Параметры

массив $config

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

Возвращает

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

enableAutoLayout()source public

enableAutoLayout( boolean $enable true )

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

Параметры

булево $enable необязательно true

Булево значение для включения/выключения.

Возвращает

$this

getClassName()source public

getClassName( )

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

Возвращает

строка

getHelpers()source public

getHelpers( )

Получает используемые помощники.

Возвращает

массив

getLayout()source public

getLayout( )

Получает имя файла макета, внутри которого будет отображено представление.

Возвращает

строка

getLayoutPath()source public

getLayoutPath( )

Получает путь к файлам макета.

Возвращает

строка

getName()source public

getName( )

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

Возвращает

строка

getOptions()source public

getOptions( )

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

Возвращает

массив

getPlugin()source public

getPlugin( )

Получает имя плагина для использования.

Возвращает

строка

getTemplate()source public

getTemplate( )

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

Возвращает

строка

getTemplatePath()source public

getTemplatePath( )

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

Возвращает

строка

getTheme()source public

getTheme( )

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

Возвращает

строка

helpers()source public

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

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

Устарело

3.4.0 Используйте setHelpers()/getHelpers() вместо этого.

Параметры

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

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

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

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

Возвращает

массив|Cake\View\ViewBuilder
$this

isAutoLayoutEnabled()source public

isAutoLayoutEnabled( )

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

Возвращает

булево

jsonSerialize()source public

jsonSerialize( )

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

Возвращает

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

Реализация

JsonSerializable::jsonSerialize()

layout()source public

layout( string|null $name null )

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

Устарело

3.4.0 Используйте setLayout()/getLayout() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

layoutPath()source public

layoutPath( string|null $path null )

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

Устарело

3.4.0 Используйте setLayoutPath()/getLayoutPath() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

name()source public

name( string|null $name null )

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

Устарело

3.4.0 Используйте setName()/getName() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

options()source public

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

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

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

Устаревший

3.4.0 Используйте setOptions()/getOptions() вместо этого.

Параметры

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

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

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

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

Возвращает

массив|Cake\View\ViewBuilder
$this

plugin()source public

plugin( string|null|false $name null )

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

Устаревший

3.4.0 Используйте setPlugin()/getPlugin() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

serialize()source public

serialize( )

Сериализует объект View Builder.

Возвращает

строка

Реализация

Serializable::serialize()

setClassName()source public

setClassName( string $name )

Устанавливает имя класса представления.

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

Параметры

строка $name

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

Возвращает

$this

setHelpers()source public

setHelpers( array $helpers , boolean $merge true )

Устанавливает используемые помощники.

Параметры

массив $helpers

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

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

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

Возвращает

$this

setLayout()source public

setLayout( string $name )

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

Параметры

строка $name

Имя файла макета для установки.

Возвращает

$this

setLayoutPath()source public

setLayoutPath( string $path )

Устанавливает путь к файлам макета.

Параметры

строка $path

Путь к файлам макета.

Возвращает

$this

setName()source public

setName( string $name )

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

Параметры

строка $name

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

Возвращает

$this

setOptions()source public

setOptions( array $options , boolean $merge true )

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

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

Параметры

массив $options

Массив параметров.

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

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

Возвращает

$this

setPlugin()source public

setPlugin( string|null|false $name )

Устанавливает имя используемого плагина.

False удаление текущего имени плагина устарело с версии 3.4.0. Используйте напрямую null вместо этого.

Параметры

строка|null|false $name

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

Возвращает

$this

setTemplate()source public

setTemplate( string $name )

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

Параметры

строка $name

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

Возвращает

$this

setTemplatePath()source public

setTemplatePath( string $path )

Устанавливает путь к файлам шаблонов.

Параметры

строка $path

Путь к файлам представлений.

Возвращает

$this

setTheme()source public

setTheme( string|null|false $theme )

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

False удаление текущей темы устарело с версии 3.4.0. Используйте напрямую null вместо этого.

Параметры

строка|null|false $theme

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

Возвращает

$this

template()source public

template( string|null $name null )

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

Устаревший

3.4.0 Используйте setTemplate()/getTemplate()

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

templatePath()source public

templatePath( string|null $path null )

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

Устаревший

3.4.0 Используйте setTemplatePath()/getTemplatePath() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

theme()source public

theme( string|null|false $theme null )

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

Устаревший

3.4.0 Используйте setTheme()/getTheme() вместо этого.

Параметры

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

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

Возвращает

строка|Cake\View\ViewBuilder
$this

unserialize()source public

unserialize( string $data )

Десериализует объект View Builder.

Параметры

строка $data

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

Возвращает

$this Конфигурированный экземпляр View Builder.

Реализация

Serializable::unserialize()

[]

[]