Класс XmlView

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

Установив параметр 'serialize' в конструкторе представления вашего контроллера, вы можете указать переменную представления, которая должна быть сериализована в XML и использована в качестве ответа на запрос. Это позволяет вам опустить представления + макеты, если вам нужно только вывести одну переменную представления в качестве XML-ответа.

В вашем контроллере вы можете сделать следующее:

$this->set(['posts' => $posts]);
$this->viewBuilder()->setOption('serialize', true);

При отрисовке представления переменная представления $posts будет сериализована в XML.

Примечание Переменная представления, которую вы укажете, должна быть совместима с Xml::fromArray().

Вы также можете установить 'serialize' как массив. Это создаст дополнительный элемент верхнего уровня с именем <response>, содержащий все именованные переменные представления:

$this->set(compact('posts', 'users', 'stuff'));
$this->viewBuilder()->setOption('serialize', true);

Вышеприведённый код сгенерирует XML-объект, который выглядит следующим образом:

<response><posts>...</posts><users>...</users></response>

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

Если вы не установите параметр serialize, вам потребуется представление. Вы можете использовать расширенные представления для обеспечения функциональности макета.

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

Константы

string

NAME_TEMPLATE
```
'templates'
```
Константа для типа, используемого для App::path().
string

PLUGIN_TEMPLATE_FOLDER
```
'plugin'
```
Константа для имени папки, содержащей файлы для переопределения шаблонов плагинов.
string

TYPE_ELEMENT
```
'element'
```
Константа для типа файла представления 'element'
string

TYPE_LAYOUT
```
'layout'
```
Константа для типа файла представления 'layout'
string

TYPE_TEMPLATE
```
'template'
```
Константа для типа файла представления 'template'.

END_OF_DOCUMENT_MARKER

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

$Blocks public @property

Cake\View\ViewBlock
$Breadcrumbs public @property

Cake\View\Helper\BreadcrumbsHelper
$Flash public @property

Cake\View\Helper\FlashHelper
$Form public @property

Cake\View\Helper\FormHelper
$Html public @property

Cake\View\Helper\HtmlHelper
$Number public @property

Cake\View\Helper\NumberHelper
$Paginator public @property

Cake\View\Helper\PaginatorHelper
$Text public @property

Cake\View\Helper\TextHelper
$Time public @property

Cake\View\Helper\TimeHelper
$Url public @property

Cake\View\Helper\UrlHelper
$_config protected

array

Конфигурация в ходе выполнения
$_configInitialized protected

bool

Инициализирована ли конфигурация с использованием значений по умолчанию
$_current protected

string

Файл представления, который в данный момент отображается. Используется для определения родительских файлов.
$_currentType protected

string

В данный момент отображается элемент. Используется для поиска родительских фрагментов для элементов.
$_defaultConfig protected

array<string, mixed>

Параметры конфигурации по умолчанию.
$_eventClass protected

string

Имя класса по умолчанию для новых объектов событий.
$_eventManager protected

Cake\Event\EventManagerInterface|null

Экземпляр Cake\Event\EventManager, который используется данным объектом для передачи внутренних событий.
$_ext protected

string

Расширение файла. По умолчанию «.php».
$_helpers protected

Cake\View\HelperRegistry

Коллекция помощников
$_parents protected

string[]

Имена представлений и их родителей, используемые с View::extend();
$_passedVars protected

string[]

Список переменных для сбора из связанного контроллера.
$_paths protected

string[]

Содержит массив путей.
$_pathsForPlugin protected

string[][]

Содержит массив путей плагинов.
$_responseType protected

string

Тип ответа.
$_stack protected

string[]

Стек содержимого, используемый для вложенных шаблонов, которые все используют View::extend();
$_viewBlockClass protected

string

Класс ViewBlock.
$autoLayout protected

bool

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

string

Конфигурация кэша, которую будет использовать представление для хранения кэшированных элементов. Изменение этого параметра изменит конфигурацию по умолчанию, под которой хранятся элементы. Вы также можете выбрать конфигурацию кэша для каждого элемента.
$helpers protected

array

Массив имён встроенных помощников для включения.
$layout protected

string

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

string

XML макеты находятся в подкаталоге layouts/xml/
$name protected

string

Имя контроллера, который создал представление, если таковой имеется.
$plugin protected

string|null

Имя плагина.
$request protected

Cake\Http\ServerRequest

Экземпляр объекта \Cake\Http\ServerRequest, содержащий информацию об текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
$response protected

Cake\Http\Response

Ссылка на объект Response
$subDir protected

string

XML представления находятся в подкаталоге 'xml' для представлений контроллеров.
$template protected

string

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

$templatePath protected

string

Имя подкаталога, содержащего шаблоны для этого представления.
$theme protected

string|null

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

array

Массив переменных.
$xmlOptions protected

array|null

Параметр для задания массива настраиваемых опций для Xml::fromArray()

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

__construct() public

Конструктор
__get() public

Магический метод доступа к помощникам.
_checkFilePath() protected

Проверяет, что путь к файлу представления не выходит за пределы определенных путей шаблонов.
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
_createCell() protected

Создаёт и настраивает экземпляр ячейки.
_elementCache() protected

Генерирует параметры кэширования для элемента.
_evaluate() protected

Метод песочницы для оценки скрипта шаблона/представления.
_getElementFileName() protected

Находит имя файла элемента, возвращает false при ошибке.
_getLayoutFileName() protected

Возвращает имя файла макета для данного шаблона в виде строки.
_getSubPaths() protected

Находит все пути к подшаблонам, основанные на $basePath. Если в текущем запросе определён префикс, этот метод добавит префиксный путь шаблона к $basePath, откатываясь вверх в случае вложенного префикса. Это в основном используется для поиска префиксных путей шаблонов для элементов и макетов.
_getTemplateFileName() protected

Возвращает имя файла шаблона для данного действия в виде строки. Имена действий с CamelCase будут подчёркнуты по умолчанию. Это означает, что вы можете иметь LongActionNames, которые ссылаются на шаблоны long_action_names.php. Вы можете изменить правило инфлексии, переопределив _inflectTemplateFileName.
_inflectTemplateFileName() protected

Изменить имя файла шаблона представления в подчёркнутый формат.
_paths() protected

Возвращает все возможные пути для поиска файлов представлений в порядке.
_render() protected

Отображает и возвращает вывод для указанного имени файла шаблона с его массивом данных. Обрабатывает родительские/расширенные шаблоны.
_renderElement() protected

Отображает элемент и вызывает обратные вызовы before и afterRender для него и записывает в кеш, если используется кеш.
_serialize() protected

Сериализация переменных представления.
append() public

Добавить к существующему или новому блоку.
assign() public

Установить содержимое для блока. Это перезапишет любое существующее содержимое.
blocks() public

Получить имена всех существующих блоков.
cache() public

Создать кэшированный блок логики представления.
cell() protected

Отображает данную ячейку.
configShallow() public

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
disableAutoLayout() public

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

Обёртка для создания и отправки событий.
element() public

Отображает фрагмент PHP с предоставленными параметрами и возвращает HTML, XML или любую другую строку.
elementExists() public

Проверяет существование элемента.
enableAutoLayout() public

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

Завершить блок захвата. Дополнение к View::start()
exists() public

Проверить существование блока.
extend() public

Обеспечивает расширение/наследование шаблонов или элементов. Шаблоны могут расширять родительский шаблон и заполнять блоки в родительском шаблоне.
fetch() public

Получить содержимое блока. Если блок пуст или не определён, вернётся ''.
get() public

Возвращает содержимое указанной переменной представления.
getConfig() public

Получить значение конфигурации.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
getCurrentType() public

Получить текущий тип шаблона.
getElementPaths() protected

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

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
getLayout() public

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

Получить путь к файлам макетов.
getLayoutPaths() protected

Получить итератор для путей макетов.
getName() public

Возвращает имя контроллера представления.
getPlugin() public

Возвращает имя плагина.
getRequest() public

Получить экземпляр запроса.
getResponse() public

Получить экземпляр ответа.

getSubDir() public

Получить подкаталог для файлов шаблонов.
getTemplate() public

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

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

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

Возвращает список переменных, доступных в текущем контексте представления.
helpers() public

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

Метод инициализации.
isAutoLayoutEnabled() public

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

Загружает помощника. Делегирует загрузку помощника HelperRegistry::load().
loadHelpers() public

Загрузить помощников только если сериализация отключена.
log() public

Удобный метод для записи сообщения в журнал. Подробнее о записи в журналы см. Log::write().
pluginSplit() public

Разделяет имя плагина в формате точка на имя плагина и имя файла. Если в $name нет точки, то индекс 0 будет null. Проверяет, загружен ли плагин, иначе имя файла останется без изменений для имён файлов, содержащих точку.
prepend() public

Добавить в начало существующего или нового блока.
render() public

Отобразить шаблон представления или вернуть сериализованные данные.
renderLayout() public

Отображает макет. Возвращает вывод от _render().
reset() public

Сбросить содержимое блока. Это перезапишет любое существующее содержимое.
set() public

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

Устанавливает конфигурацию.
setElementCache() public

Установить конфигурацию кэша, которую будет использовать View для хранения кэшированных элементов.
setEventManager() public

Возвращает экземпляр Cake\Event\EventManagerInterface для этого объекта.
setLayout() public

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

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

Устанавливает имя плагина.
setRequest() public

Устанавливает объекты запроса и настраивает ряд свойств контроллера на основе содержимого запроса. Свойства, которые устанавливаются:
setResponse() public

Устанавливает экземпляр ответа.
setSubDir() public

Установить подкаталог для файлов шаблонов.
setTemplate() public

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

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

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

Начать захват вывода для 'блока'.

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

__construct() public

__construct(Cake\Http\ServerRequest|null $request = null, Cake\Http\Response|null $response = null, Cake\Event\EventManager|null $eventManager = null, array $viewOptions = [])

Конструктор

Параметры

Cake\Http\ServerRequest|null $request optional: Экземпляр запроса.
Cake\Http\Response|null $response optional: Экземпляр ответа.
Cake\Event\EventManager|null $eventManager optional: Экземпляр менеджера событий.
array $viewOptions optional: Параметры представления. См. View::$_passedVars для списка параметров, которые устанавливаются как свойства класса.

__get() public

__get(string $name): mixed

Магический аксессор для помощников.

Параметры

string $name: Имя атрибута для получения.

Возвращает

mixed

_checkFilePath() protected

_checkFilePath(string $file, string $path): string

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

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

Параметры

string $file: Путь к файлу шаблона.
string $path: Базовый путь, внутри которого должен находиться $file.

Возвращает

string

Исключения

InvalidArgumentException

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Записывает ключ конфигурации.

Параметры

string|array $key: Ключ для записи.
mixed $value: Значение для записи.
bool|string $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_createCell() protected

_createCell(string $className, string $action, string|null $plugin, array $options): Cake\View\Cell

Создает и настраивает экземпляр ячейки.

Параметры

string $className: Имя класса ячейки.
string $action: Имя действия.
string|null $plugin: Имя плагина.
array $options: Параметры конструктора для ячейки.

Возвращает

Cake\View\Cell

_elementCache() protected

_elementCache(string $name, array $data, array $options): array

Генерирует параметры конфигурации кэша для элемента.

Параметры

string $name: Имя элемента
array $data: Данные
array $options: Параметры элемента

Возвращает

array

_evaluate() protected

_evaluate(string $templateFile, array $dataForView): string

Метод песочницы для оценки скрипта шаблона/представления.

Параметры

string $templateFile: Имя файла шаблона.
array $dataForView: Данные для включения в визуализированное представление.

Возвращает

string

_getElementFileName() protected

_getElementFileName(string $name, bool $pluginCheck = true): string|false

Находит имя файла элемента, возвращает false в случае неудачи.

Параметры

string $name

Имя элемента для поиска.

bool $pluginCheck optional

если false, будет игнорировать плагин запроса, если обработанный плагин не загружен

Возвращает

string|false

_getLayoutFileName() protected

_getLayoutFileName(string|null $name = null): string

Возвращает имя файла макета для этого шаблона в виде строки.

Параметры

string|null $name optional: Имя макета для поиска.

Возвращает

string

Исключения

Cake\View\Exception\MissingLayoutException
когда макет не может быть найден
RuntimeException

_getSubPaths() protected

_getSubPaths(string $basePath): string[]

Находит все пути к подшаблонам, на основе $basePath. Если префикс определен в текущем запросе, этот метод будет добавлять путь к шаблону с префиксом к $basePath, каскадируя вверх в случае, если префикс вложен. Это используется для поиска путей к шаблонам с префиксами для элементов и макетов.

Параметры

string $basePath: Базовый путь, для которого нужно получить путь с префиксом.

Возвращает

string[]

_getTemplateFileName() protected

_getTemplateFileName(string|null $name = null): string

Возвращает имя файла шаблона данного действия в виде строки. Имена действий в стиле CamelCase по умолчанию будут преобразованы в имена с подчеркиваниями. Это означает, что вы можете иметь LongActionNames, которые ссылаются на шаблоны long_action_names.php. Вы можете изменить правило склонения, переопределив _inflectTemplateFileName.

Параметры

string|null $name optional: Действие контроллера, для которого нужно найти имя файла шаблона

Возвращает

string

Исключения

Cake\View\Exception\MissingTemplateException
когда файл шаблона не может быть найден.
RuntimeException
Когда имя шаблона не указано.

_inflectTemplateFileName() protected

_inflectTemplateFileName(string $name): string

Изменяет имя файла шаблона представления на формат с подчеркиваниями.

Параметры

string $name: Имя файла, которое должно быть преобразовано.

Возвращает

string

_paths() protected

_paths(string|null $plugin = null, bool $cached = true): string[]

Возвращает все возможные пути для поиска файлов представлений в порядке

Параметры

string|null $plugin optional: Необязательное имя плагина для поиска файлов представлений.
bool $cached optional: Установите в false, чтобы принудительно обновить пути к представлениям. По умолчанию true.

Возвращает

string[]

_render() protected

_render(string $templateFile, array $data = []): string

Рендерит и возвращает вывод для данного имени файла шаблона с его массивом данных. Обрабатывает родительские/расширенные шаблоны.

Параметры

string $templateFile: Имя файла шаблона
array $data optional: Данные для включения в визуализированное представление. Если пусто, будут использоваться текущие View::$viewVars.

Возвращает

string

Исключения

LogicException
Когда блок остается открытым.

_renderElement() protected

_renderElement(string $file, array $data, array $options): string

Рендерит элемент и запускает обратные вызовы before и afterRender для него, а также записывает в кэш, если используется кэш

Parameters

string $file: Путь к файлу элемента
array $data: Данные для рендеринга
array $options: Параметры элемента

Returns

string

_serialize() protected

_serialize(array|string $serialize): string

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

Parameters

array|string $serialize

Returns

string

append() public

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

Добавить к существующему или новому блоку.

Добавление к новому блоку создаст блок.

Parameters

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

Returns

$this

assign() public

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

Установить контент для блока. Это перезапишет любой существующий контент.

Parameters

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

Returns

$this

blocks() public

blocks(): string[]

Получить имена всех существующих блоков.

Returns

string[]

cache() public

cache(callable $block, array $options = []): string

Создать кэшированный блок логики представления.

Это позволяет кэшировать блок вывода представления в кэше, определенном в elementCache.

Этот метод сначала попытается прочитать кэш. Если кэш пуст, $block будет выполнен, а вывод сохранен.

Parameters

callable $block: Блок кода, вывод которого вы хотите кэшировать.
array $options optional: Параметры, определяющие ключ кэша и т.д.

Returns

string

Throws

RuntimeException
Когда в $options отсутствует параметр 'key'.

cell() protected

cell(string $cell, array $data = [], array $options = []): Cake\View\Cell

Рендерит заданный cell.

Пример:

// Taxonomy\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('Taxonomy.TagCloud::smallList', ['limit' => 10]);

// App\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('TagCloud::smallList', ['limit' => 10]);

Действие display будет использоваться по умолчанию, если действие не указано:

// Taxonomy\View\Cell\TagCloudCell::display()
$cell = $this->cell('Taxonomy.TagCloud');

Cells не рендерятся, пока не будут выведены.

Parameters

string $cell: Вы должны указать имя cell и, необязательно, действие cell. например: TagCloud::smallList вызовет View\Cell\TagCloudCell::smallList(), действие display будет вызываться по умолчанию, если оно не указано.
array $data optional: Дополнительные аргументы для метода cell. например: cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2']) сопоставляется с View\Cell\TagCloud::smallList(v1, v2)
array $options optional: Параметры для конструктора Cell

Returns

Cake\View\Cell

Throws

Cake\View\Exception\MissingCellException
Если класс Cell не найден.
BadMethodCallException
Если класс Cell не указал действие cell.

configShallow() public

configShallow(string|array $key, mixed|null $value = null): $this

Объединить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.

Returns

$this

disableAutoLayout() public

disableAutoLayout(): $this

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

Returns

$this

dispatchEvent() public

dispatchEvent(string $name, array|null $data = null, object|null $subject = null): Cake\Event\EventInterface

Обёртка для создания и отправки событий.

Возвращает отправленное событие.

Parameters

string $name: Имя события.
array|null $data optional: Любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели.
object|null $subject optional: Объект, к которому относится это событие ($this по умолчанию).

Returns

Cake\Event\EventInterface

element() public

element(string $name, array $data = [], array $options = []): string

Рендерит фрагмент PHP с предоставленными параметрами и возвращает HTML, XML или любую другую строку.

Это реализует концепцию элементов (или «частичных макетов»), а массив $params используется для отправки данных, которые будут использоваться в элементе. Элементы могут быть кэшированы, что улучшает производительность, используя параметр cache.

Parameters

string $name: Имя файла шаблона в папке templates/element/, или MyPlugin.template для использования элемента шаблона из MyPlugin. Если элемент не найден в плагине, будет выполнен обычный поиск по каскаду путей представлений.
array $data optional: Массив данных, которые будут доступны для отображаемого представления (т.е. элемента)
array $options optional: Массив параметров. Возможные ключи:

Returns

string

Throws

Cake\View\Exception\MissingElementException
Когда элемента не хватает, а `ignoreMissing` имеет значение false.

elementExists() public

elementExists(string $name): bool

Проверяет, существует ли элемент

Parameters

string $name: Имя файла шаблона в папке templates/element/, или MyPlugin.template для проверки элемента шаблона из MyPlugin. Если элемент не найден в плагине, будет выполнен обычный поиск по каскаду путей представлений.

Returns

bool

enableAutoLayout() public

enableAutoLayout(bool $enable = true): $this

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

Parameters

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

Returns

$this

end() public

end(): $this

Завершить блок захвата. Дополнение к View::start()

Returns

$this

exists() public

exists(string $name): bool

Проверить, существует ли блок

Parameters

string $name: Имя блока

Returns

bool

extend() public

extend(string $name): $this

Обеспечивает расширение/наследование шаблона или элемента. Шаблоны могут расширять родительский шаблон и заполнять блоки в родительском шаблоне.

Parameters

string $name: Шаблон или элемент, с помощью которого нужно «расширить» текущий.

Returns

$this

Throws

LogicException
при расширении шаблона самим собой или создании циклов расширения.
LogicException
при расширении несуществующего элемента

fetch() public

fetch(string $name, string $default = ''): string

Извлекает содержимое блока. Если блок пуст или не определен, будет возвращено ''.

Parameters

string $name: Имя блока
string $default optional: Текст по умолчанию

Returns

string

get() public

get(string $var, mixed $default = null): mixed

Возвращает содержимое заданной переменной представления.

Parameters

string $var: Переменная представления, содержимое которой нужно получить.
mixed $default optional: Содержимое $var по умолчанию/резервное.

Returns

mixed

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Получить значение конфигурации.

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

Parameters

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Returns

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для этого конкретного ключа.

Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.

Parameters

string $key: Ключ для получения.

Returns

mixed

Throws

InvalidArgumentException

getCurrentType() public

getCurrentType(): string

Получить текущий тип шаблона

Returns

string

getElementPaths() protected

getElementPaths(string|null $plugin): Generator

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

Parameters

string|null $plugin: Плагин, для которого нужно получить пути.

Returns

Generator

getEventManager() public

getEventManager(): Cake\Event\EventManagerInterface

getLayoutPaths(string|null $plugin): Generator

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

Parameters

string|null $plugin: Плагин, для которого нужно получить пути.

Returns

Generator

getName() public

getName(): string

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

Returns

string

getPlugin() public

getPlugin(): string|null

Возвращает имя плагина.

Returns

string|null

getRequest() public

getRequest(): Cake\Http\ServerRequest

Получает экземпляр запроса.

Returns

Cake\Http\ServerRequest

getResponse() public

getResponse(): Cake\Http\Response

Получает экземпляр ответа.

Returns

Cake\Http\Response

getSubDir() public

getSubDir(): string

Получить подкаталог для этих файлов шаблона.

Returns

string

getTemplate() public

getTemplate(): string

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

Returns

string

getTemplatePath() public

getTemplatePath(): string

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

Returns

string

getTheme() public

getTheme(): string|null

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

Returns

string|null

getVars() public

getVars(): string[]

Возвращает список переменных, доступных в текущем контексте представления

Returns

string[]

helpers() public

helpers(): Cake\View\HelperRegistry

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

Returns

Cake\View\HelperRegistry

initialize() public

initialize(): void

Метод хука инициализации.

Свойства, такие как $helpers и т. д., не могут быть инициализированы статически в вашем пользовательском классе представления, поскольку они перезаписываются значениями из контроллера в конструкторе. Таким образом, этот метод позволяет вам управлять ими по мере необходимости после создания экземпляра представления.

Returns

void

isAutoLayoutEnabled() public

isAutoLayoutEnabled(): bool

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

Returns

bool

loadHelper() public

loadHelper(string $name, array $config = []): Cake\View\Helper

Загружает помощник. Делегирует HelperRegistry::load() для загрузки помощника

Parameters

string $name: Имя помощника для загрузки.
array $config optional: Настройки для помощника

Returns

Cake\View\Helper

loadHelpers() public

loadHelpers(): $this

Загрузить помощники только если сериализация отключена.

Returns

$this

log() public

log(string $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

Вспомогательный метод для записи сообщения в Log. См. Log::write() для получения дополнительной информации о записи в журналы.

Parameters

string $message: Сообщение журнала.
int|string $level optional: Уровень ошибки.
string|array $context optional: Дополнительные данные журнала, относящиеся к этому сообщению.

Returns

bool

pluginSplit() public

pluginSplit(string $name, bool $fallback = true): array

Разделяет имя плагина в синтаксисе с точками на его плагин и имя файла. Если $name не содержит точку, то индекс 0 будет равен null. Проверяет, загружен ли плагин, иначе имя файла останется неизменным для имен файлов, содержащих точку.

Parameters

string $name: Имя, которое вы хотите разделить на плагин.
bool $fallback optional: Если true, использует плагин, установленный в текущем запросе, когда обработанный плагин не загружен.

Returns

array

prepend() public

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

Добавить в начало существующего или нового блока.

Добавление в начало нового блока создаст этот блок.

Parameters

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

Returns

$this

render() public

render(string|null $template = null, string|false|null $layout = null): string

Рендеринг шаблона представления или возврат сериализованных данных.

Render вызывает обратные вызовы помощников, которые вызываются до и после рендеринга шаблона, а также до и после макета. Обратные вызовы помощников вызываются:

beforeRender
afterRender
beforeLayout
afterLayout

Если View::$autoLayout установлено на false, шаблон будет возвращен без изменений.

Имена шаблонов и макетов могут указывать на шаблоны или макеты плагинов. Используя синтаксис Plugin.template, можно использовать шаблон/макет/ плагина вместо шаблонов приложения. Если выбранный плагин не найден, шаблон будет расположен вдоль обычного каскада путей просмотра.

Parameters

string|null $template optional: Рендеринг шаблона.
string|false|null $layout optional: Макет, который рендерится.

Returns

string

Throws

Cake\View\Exception\SerializationFailureException
При сбое сериализации.

renderLayout() public

renderLayout(string $content, string|null $layout = null): string

Рендерит макет. Возвращает вывод из _render().

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

Parameters

string $content: Содержимое для рендеринга в шаблоне, заключенное в окружающий макет.
string|null $layout optional: Имя макета

Returns

string

Throws

Cake\Core\Exception\CakeException
если есть ошибка в представлении.

reset() public

reset(string $name): $this

Сбросить содержимое блока. Это перезапишет любое существующее содержимое.

Parameters

string $name: Имя блока

Returns

$this

set() public

set(string|array $name, mixed $value = null): $this

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

Parameters

string|array $name: Строка или массив данных.
mixed $value optional: Значение, если $name является строкой (которая затем работает как ключ). Не используется, если $name является ассоциативным массивом, в противном случае служит значениями для ключей $name.

Returns

$this

Throws

RuntimeException
Если операция объединения массивов завершилась неудачей.

setConfig() public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Usage

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких параметров конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Следует ли рекурсивно объединять или перезаписывать существующую конфигурацию, по умолчанию true.

Returns

$this

Throws

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

setElementCache() public

setElementCache(string $elementCache): $this

Установить конфигурацию кэша, которую View будет использовать для хранения кэшированных элементов

Parameters

string $elementCache: Имя конфигурации кэша.

Returns

$this

setEventManager() public

setEventManager(Cake\Event\EventManagerInterface $eventManager): $this

Возвращает экземпляр Cake\Event\EventManagerInterface для этого объекта.

Вы можете использовать этот экземпляр для регистрации любых новых прослушивателей или обратных вызовов к событиям объекта или для создания собственных событий и их вызова по желанию.

Parameters

Cake\Event\EventManagerInterface $eventManager: менеджер событий для установки

Returns

$this

setLayout() public

setLayout(string $name): $this

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

Parameters

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

Returns

$this

setLayoutPath() public

setLayoutPath(string $path): $this

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

Parameters

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

Returns

$this

setPlugin() public

setPlugin(string|null $name): $this

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

Parameters

string|null $name: Имя плагина.

Returns

$this

setRequest() public

setRequest(Cake\Http\ServerRequest $request): $this

Устанавливает объекты запроса и настраивает ряд свойств контроллера на основе содержимого запроса. Устанавливаемые свойства:

$this->request - на параметр $request
$this->plugin - на значение, возвращаемое $request->getParam('plugin')

Parameters

Cake\Http\ServerRequest $request: Экземпляр запроса.

Returns

$this

setResponse() public

setResponse(Cake\Http\Response $response): $this

Устанавливает экземпляр ответа.

Parameters

Cake\Http\Response $response: Экземпляр ответа.

Returns

$this

setSubDir() public

setSubDir(string $subDir): $this

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

Параметры

string $subDir: Имя подкаталога.

Возвращает

$this

См. также

\Cake\View\View::$subDir

setTemplate() public

setTemplate(string $name): $this

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

Параметры

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

Возвращает

$this

setTemplatePath() public

setTemplatePath(string $path): $this

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

Параметры

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

Возвращает

$this

setTheme() public

setTheme(string|null $theme): $this

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

Параметры

string|null $theme: Имя темы.

Возвращает

$this

start() public

start(string $name): $this

Начать захват вывода для «блока».

Можно использовать start несколько раз для добавления или предварения содержимого в режиме захвата.

// Append content to an existing block.
$this->start('content');
echo $this->fetch('content');
echo 'Some new content';
$this->end();

// Prepend content to an existing block
$this->start('content');
echo 'Some new content';
echo $this->fetch('content');
$this->end();

Параметры

string $name: Имя блока для захвата.

Массив переменных

Тип

array

`$xmlOptions` protected

Параметр для установки массива пользовательских параметров для Xml::fromArray()

Например, 'format' как 'attributes' вместо 'tags'.

Тип

array|null

© 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.XmlView.html