Класс ViewBuilder

autoLayout()source public deprecated

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.

Параметры

array $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 deprecated

className( string|null $name = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\View\ViewBuilder
$this

createFromArray()source public

createFromArray( array $config )

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

Параметры

array $config

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

Возвращает

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

disableAutoLayout()source public

disableAutoLayout( )

Отключает стандартный режим CakePHP по применению файлов макета.

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

Возвращает

$this

enableAutoLayout()source public

enableAutoLayout( boolean $enable = true )

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

Параметры

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

Логическое значение для включения/выключения.

Возвращает

$this

getClassName()source public

getClassName( )

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

Возвращает

string|null

getHelpers()source public

getHelpers( )

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

Возвращает

array

getLayout()source public

getLayout( )

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

Возвращает

string|null|false

getLayoutPath()source public

getLayoutPath( )

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

Возвращает

string|null

getName()source public

getName( )

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

Возвращает

string|null

getOptions()source public

getOptions( )

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

Возвращает

array

getPlugin()source public

getPlugin( )

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

Возвращает

string|null|false

getTemplate()source public

getTemplate( )

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

Возвращает

string|null

getTemplatePath()source public

getTemplatePath( )

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

Возвращает

string|null

getTheme()source public

getTheme( )

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

Возвращает

string|null|false

getVar()source public

getVar( string $name )

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

Параметры

string $name

Имя переменной

Возвращает

mixed
Значение переменной или null, если она не задана.

getVars()source public

getVars( )

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

Возвращает

array

hasVar()source public

hasVar( string $name )

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

Параметры

string $name

Имя переменной

Возвращает

boolean

helpers()source public deprecated

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

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

Устарело

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

Параметры

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

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

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

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

Возвращает

array|Cake\View\ViewBuilder
$this

isAutoLayoutEnabled()source public

isAutoLayoutEnabled( )

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

Возвращает

boolean|null

jsonSerialize()source public

jsonSerialize( )

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

Возвращает

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

Реализация

JsonSerializable::jsonSerialize()

layout()source public deprecated

layout( string|null $name = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\View\ViewBuilder
$this

layoutPath()source public deprecated

layoutPath( string|null $path = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\View\ViewBuilder
$this

name()source public deprecated

name( string|null $name = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\View\ViewBuilder
$this

options()source public deprecated

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

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

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

Устарело

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

Параметры

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

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

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

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

Возвращает

array|Cake\View\ViewBuilder
$this

plugin()source public deprecated

plugin( string|null|false $name = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|false|null|Cake\View\ViewBuilder
$this

serialize()source public

serialize( )

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

Возвращает

string

Реализация

Serializable::serialize()

setClassName()source public

setClassName( string|null $name )

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

Принимает либо короткое имя (Ajax), либо имя плагина (MyPlugin.Ajax), либо полностью именованное имя (App\View\AppView), или null для использования класса View, предоставляемого CakePHP.

Параметры

string|null $name

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

Возвращает

$this

setHelpers()source public

setHelpers( array $helpers , boolean $merge = true )

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

Параметры

array $helpers

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

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

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

Возвращает

$this

setLayout()source public

setLayout( string|null|false $name )

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

Параметры

string|null|false $name

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

Возвращает

$this

setLayoutPath()source public

setLayoutPath( string|null $path )

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

Параметры

string|null $path

Путь для файлов макетов.

Возвращает

$this

setName()source public

setName( string|null $name )

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

Параметры

string|null $name

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

Возвращает

$this

setOptions()source public

setOptions( array $options , boolean $merge = true )

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

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

Параметры

array $options

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

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

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

Возвращает

$this

setPlugin()source public

setPlugin( string|null|false $name )

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

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

Параметры

string|null|false $name

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

Возвращает

$this

setTemplate()source public

setTemplate( string|null $name )

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

Параметры

string|null $name

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

Возвращает

$this

setTemplatePath()source public

setTemplatePath( string|null $path )

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

Параметры

string|null $path

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

Возвращает

$this

setTheme()source public

setTheme( string|null|false $theme )

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

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

Параметры

string|null|false $theme

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

Возвращает

$this

setVar()source public

setVar( string $name , mixed $value = null )

Сохраняет переменную для использования в шаблоне.

Параметры

string $name

Строка или массив данных.

mixed $value необязательно null

Значение.

Возвращает

$this

setVars()source public

setVars( array $data , boolean $merge = true )

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

Параметры

array $data

Массив данных.

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

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

Возвращает

$this

template()source public deprecated

template( string|null $name = null )

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\View\ViewBuilder
$this

templatePath()source public устаревший

templatePath( string|null $path = null )

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

Устаревший

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

Параметры

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

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

Возвращает

string|Cake\View\ViewBuilder
$this

theme()source public устаревший

theme( string|null|false $theme = null )

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

Устаревший

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

Параметры

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

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

Возвращает

string|false|null|Cake\View\ViewBuilder
$this

unserialize()source public

unserialize( string $data )

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

Параметры

string $data

Строка, полученная в результате сериализации.

Возвращает

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

Реализация

Serializable::unserialize()

[]

[]

[]