Класс 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 для получения текущих параметров.

логический $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( )

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

Возвращает

строка

Реализация

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

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

логический $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

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

логический $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 )

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

Параметры

строка $data

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

Возвращает

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

Реализация

Serializable::unserialize()

[]

[]