Класс ViewBuilder

Предоставляет API для поэтапного построения представления.

После настройки представления и определения всего контекста вы можете создать экземпляр представления с помощью build().

Пространство имён: Cake\View

Краткое описание свойств

$_autoLayout protected

bool

Включить автомакет.
$_className protected

string|null

Имя класса представления для использования. Можно использовать обозначение плагина, короткое имя или полное имя класса с пространством имён.
$_helpers protected

array

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

string|null

Имя шаблона макета для рендеринга.
$_layoutPath protected

string|null

Путь к шаблону макета для построения представления.
$_name protected

string|null

Переменные представления для использования
$_options protected

array<string, mixed>

Дополнительные параметры, используемые при построении представления.
$_plugin protected

string|null

Имя плагина для использования.
$_template protected

string|null

Файл шаблона для рендеринга.
$_templatePath protected

string|null

Подкаталог к шаблону.
$_theme protected

string|null

Имя темы для использования.
$_vars protected

array<string, mixed>

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

Краткое описание методов

__serialize() public

Магический метод, используемый для сериализации объекта билдера представления.
__unserialize() public

Магический метод, используемый для повторного построения объекта билдера представления.
_checkViewVars() protected

Итерируется по хэшу для очистки и нормализации.
addHelper() public

Добавляет помощника для использования.
addHelpers() public

Добавляет помощников для использования, объединяя их с существующими.
build() public

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

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

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

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

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

Получает помощников для использования.
getLayout() public

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

Получает путь к файлам макета.
getName() public

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

Получить параметр представления.
getOptions() public

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

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

Получает имя файла представления для рендеринга. Указанное имя является именем файла в templates/<SubFolder>/ без расширения .php.
getTemplatePath() public

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

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

Получить переменную представления.
getVars() public

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

Проверка наличия переменной представления.
isAutoLayoutEnabled() public

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

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

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

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

Устанавливает помощников для использования.
setLayout() public

Устанавливает имя файла макета, внутри которого должно рендериться представление. Указанное имя — имя файла макета в templates/layout/ без расширения .php.
setLayoutPath() public

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

Устанавливает имя представления.
setOption() public

Установить параметр представления.
setOptions() public

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

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

Устанавливает имя файла представления для рендеринга. Указанное имя является именем файла в templates/<SubFolder>/ без расширения .php.
setTemplatePath() public

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

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

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

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

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

Краткое описание методов

__serialize() public

__serialize(): array

Магический метод, используемый для сериализации объекта построителя представлений.

Returns

array

__unserialize() public

__unserialize(array<string, mixed> $data): void

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

Parameters

array<string, mixed> $data: Массив данных.

Returns

void

_checkViewVars() protected

_checkViewVars(mixed $item, string $key): void

Итерируется по хешу для очистки и нормализации.

Parameters

mixed $item: Ссылка на значение переменной представления.
string $key: Ключ переменной представления.

Returns

void

Throws

RuntimeException

addHelper() public

addHelper(string $helper, array<string, mixed> $options = []): $this

Добавляет вспомогательный элемент для использования.

Parameters

string $helper: Вспомогательный элемент для использования.
array<string, mixed> $options optional: Опции.

Returns

$this

addHelpers() public

addHelpers(array $helpers): $this

Добавляет вспомогательные элементы для использования путем слияния с существующими.

Parameters

array $helpers: Вспомогательные элементы для использования.

Returns

$this

build() public

build(array<string, mixed> $vars = [], Cake\Http\ServerRequest|null $request = null, Cake\Http\Response|null $response = null, Cake\Event\EventManagerInterface|null $events = null): Cake\View\View

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

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

Parameters

array<string, mixed> $vars optional: Переменные/контекст представления для использования.
Cake\Http\ServerRequest|null $request optional: Запрос для использования.
Cake\Http\Response|null $response optional: Ответ для использования.
Cake\Event\EventManagerInterface|null $events optional: Менеджер событий для использования.

Returns

Cake\View\View

Throws

Cake\View\Exception\MissingViewException

createFromArray() public

createFromArray(array<string, mixed> $config): $this

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

Parameters

array<string, mixed> $config: Массив конфигурации построителя представлений.

Returns

$this

disableAutoLayout() public

disableAutoLayout(): $this

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

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

Returns

$this

enableAutoLayout() public

enableAutoLayout(bool $enable = true): $this

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

Parameters

bool $enable optional: Логическое значение для включения/выключения.

Returns

$this

getClassName() public

getClassName(): string|null

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

Returns

string|null

getHelpers() public

getHelpers(): array

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

Returns

array

getLayout() public

getLayout(): string|null

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

Returns

string|null

getLayoutPath() public

getLayoutPath(): string|null

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

Returns

string|null

getName() public

getName(): string|null

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

Returns

string|null

getOption() public

getOption(string $name): mixed

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

Parameters

string $name: Имя параметра.

Returns

mixed

getOptions() public

getOptions(): array<string, mixed>

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

Returns

array<string, mixed>

getPlugin() public

getPlugin(): string|null

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

Returns

string|null

getTemplate() public

getTemplate(): string|null

Получает имя файла представления для отрисовки. Указанное имя - это имя файла в templates/<SubFolder>/ без расширения .php.

Returns

string|null

getTemplatePath() public

getTemplatePath(): string|null

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

Returns

string|null

getTheme() public

getTheme(): string|null

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

Returns

string|null

getVar() public

getVar(string $name): mixed

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

Parameters

string $name: Имя переменной

Returns

mixed

getVars() public

getVars(): array<string, mixed>

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

Returns

array<string, mixed>

hasVar() public

hasVar(string $name): bool

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

Parameters

string $name: Имя переменной

Returns

bool

isAutoLayoutEnabled() public

isAutoLayoutEnabled(): bool

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

Returns

bool

jsonSerialize() public

jsonSerialize(): array

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

Существуют ограничения для viewVars, о которых полезно знать:

ORM\Query выполняется и сохраняется как набор результатов
SimpleXMLElements хранятся как ассоциативный массив
Исключения хранятся как строки
Ресурсы, \Closure и \PDO не поддерживаются.

Returns

array

serialize() public

serialize(): string

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

Returns

string

setClassName() public

setClassName(string|null $name): $this

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

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

Parameters

string|null $name: Имя класса для представления.

Returns

$this

setHelpers() public

setHelpers(array $helpers, bool $merge = true): $this

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

Parameters

array $helpers: Помощники для использования.
bool $merge optional: Объединять ли существующие данные с новыми данными.

Returns

$this

setLayout() public

setLayout(string|null $name): $this

Устанавливает имя файла макета для отрисовки представления внутри него. Указанное имя — это имя файла макета в templates/layout/ без расширения .php.

Parameters

string|null $name: Имя файла макета для установки.

Returns

$this

setLayoutPath() public

setLayoutPath(string|null $path): $this

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

Parameters

string|null $path: Путь к файлам макетов.

Returns

$this

setName() public

setName(string|null $name): $this

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

Parameters

string|null $name: Имя представления или null для удаления текущего имени.

Returns

$this

setOption() public

setOption(string $name, mixed $value): $this

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

Parameters

string $name: Имя параметра.
mixed $value: Значение для установки.

Returns

$this

setOptions() public

setOptions(array<string, mixed> $options, bool $merge = true): $this

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

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

Parameters

array<string, mixed> $options: Массив параметров.
bool $merge optional: Объединять ли существующие данные с новыми данными.

Returns

$this

setPlugin() public

setPlugin(string|null $name): $this

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

Parameters

string|null $name: Имя плагина. Используйте null для удаления текущего имени плагина.

Returns

$this

setTemplate() public

setTemplate(string|null $name): $this

Устанавливает имя файла представления для отрисовки. Указанное имя — это имя файла в templates/<SubFolder>/ без расширения .php.

Parameters

string|null $name: Имя файла представления для установки или null для удаления имени шаблона.

Returns

$this

setTemplatePath() public

setTemplatePath(string|null $path): $this

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

Parameters

string|null $path: Путь к файлам представлений.

Returns

$this

setTheme() public

setTheme(string|null $theme): $this

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

Parameters

string|null $theme: Имя темы. Используйте null для удаления текущей темы.

Returns

$this

setVar() public

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

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

Parameters

string $name: Строка или массив данных.
mixed $value optional: Значение.

Returns

$this

setVars() public

setVars(array<string, mixed> $data, bool $merge = true): $this

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

Parameters

array<string, mixed> $data: Массив данных.
bool $merge optional: Объединять ли с существующими переменными, по умолчанию true.

Returns

$this

unserialize() public

unserialize(string $data): void

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

Parameters

string $data: Сериализованная строка.

Returns

void

Подробное описание свойств

`$_autoLayout` protected

Должен ли быть включен autoLayout.

Type

bool

`$_className` protected

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

Type

string|null

`$_helpers` protected

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

Type

array

`$_layout` protected

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

Type

string|null

`$_layoutPath` protected

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

Type

string|null

`$_name` protected

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

Type

string|null

`$_options` protected

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

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

Type

array<string, mixed>

`$_plugin` protected

Имя используемого плагина.

Type

string|null

`$_template` protected

Файл шаблона для отрисовки.

Type

string|null

`$_templatePath` protected

Подкаталог к шаблону.

Type

string|null

`$_theme` protected

Имя используемой темы.

Type

string|null

`$_vars` protected

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

Type

array<string, mixed>

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.View.ViewBuilder.html