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

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

string|null

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

string|null

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

string|null

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

string|null

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

array

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

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

_checkViewVars() protected

Проходит по хешу для очистки и нормализации.
addHelper() 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

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

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

_checkViewVars() protected

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

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

Параметры

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

Возвращает

void

Выбрасывает

RuntimeException

addHelper() public

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

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

Параметры

string $helper: Помощник для использования.
array $options необязательно: Параметры.

Возвращает

$this

build() public

build(array $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. Если этот класс не существует, то будет использован Cake\View\View.

Параметры

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

Возвращает

Cake\View\View

Выбрасывает

Cake\View\Exception\MissingViewException

createFromArray() public

createFromArray(array $config): $this

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

Параметры

array $config: Массив конфигурации билдера представления.

Возвращает

$this

disableAutoLayout() public

disableAutoLayout(): $this

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

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

Возвращает

$this

enableAutoLayout() public

enableAutoLayout(bool $enable = true): $this

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

Параметры

bool $enable необязательно: Булевое значение для включения/выключения.

Возвращает

$this

getClassName() public

getClassName(): string|null

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

Возвращает

string|null

getHelpers() public

getHelpers(): array

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

Возвращает

array

getLayout() public

getLayout(): string|null

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

Возвращает

string|null

getLayoutPath() public

getLayoutPath(): string|null

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

Возвращает

string|null

getName() public

getName(): string|null

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

Возвращает

string|null

getOption() public

getOption(string $name): mixed

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

Параметры

string $name: Название параметра.

Возвращает

mixed

getOptions() public

getOptions(): array

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

Возвращает

array

getPlugin() public

getPlugin(): string|null

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

Возвращает

string|null

getTemplate() public

getTemplate(): string|null

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

Возвращает

string|null

getTemplatePath() public

getTemplatePath(): string|null

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

Возвращает

string|null

getTheme() public

getTheme(): string|null

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

Возвращает

string|null

getVar() public

getVar(string $name): mixed

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

Параметры

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

Возвращает

mixed

getVars() public

getVars(): array

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

Возвращает

array

hasVar() public

hasVar(string $name): bool

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

Параметры

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

Возвращает

bool

isAutoLayoutEnabled() public

isAutoLayoutEnabled(): bool

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

Возвращает

bool

jsonSerialize() public

jsonSerialize(): array

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

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

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

Возвращает

array

serialize() public

serialize(): string

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

Возвращает

string

setClassName() public

setClassName(string|null $name): $this

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

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

Параметры

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

Возвращает

$this

setHelpers() public

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

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

Параметры

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

Возвращает

$this

setLayout() public

setLayout(string|null $name): $this

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

Параметры

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

Возвращает

$this

setLayoutPath() public

setLayoutPath(string|null $path): $this

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

Параметры

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

Возвращает

$this

setName() public

setName(string|null $name): $this

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

Параметры

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

Возвращает

$this

setOption() public

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

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

Параметры

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

Возвращает

$this

setOptions() public

setOptions(array $options, bool $merge = true): $this

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

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

Параметры

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

Возвращает

$this

setPlugin() public

setPlugin(string|null $name): $this

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

Параметры

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

Возвращает

$this

setTemplate() public

setTemplate(string|null $name): $this

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

Параметры

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

Возвращает

$this

setTemplatePath() public

setTemplatePath(string|null $path): $this

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

Параметры

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

Возвращает

$this

setTheme() public

setTheme(string|null $theme): $this

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

Параметры

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

Возвращает

$this

setVar() public

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

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

Параметры

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

Возвращает

$this

setVars() public

setVars(array $data, bool $merge = true): $this

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

Параметры

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

Возвращает

$this

unserialize() public

unserialize(string $data): void

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

Параметры

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

Возвращает

void

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

`$_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

`$_plugin` protected

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

Тип

string|null

`$_template` protected

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

Тип

string|null

`$_templatePath` protected

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

Тип

string|null

`$_theme` protected

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

Тип

string|null

`$_vars` protected

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

Тип

array

© 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.2/class-Cake.View.ViewBuilder.html