Класс JsonView

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

Он позволяет опустить шаблоны, если вам нужно просто вывести JSON-строку в качестве ответа.

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

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

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

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

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

Это сгенерирует JSON-объект, который выглядит следующим образом:

{"posts": [...], "users": [...]}

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

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

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

Пространство имён: 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'.

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

$Blockspublic@property
Cake\View\ViewBlock
$Breadcrumbspublic@property
Cake\View\Helper\BreadcrumbsHelper
$Flashpublic@property
Cake\View\Helper\FlashHelper
$Formpublic@property
Cake\View\Helper\FormHelper
$Htmlpublic@property
Cake\View\Helper\HtmlHelper
$Numberpublic@property
Cake\View\Helper\NumberHelper
$Paginatorpublic@property
Cake\View\Helper\PaginatorHelper
$Textpublic@property
Cake\View\Helper\TextHelper
$Timepublic@property
Cake\View\Helper\TimeHelper
$Urlpublic@property
Cake\View\Helper\UrlHelper
$_configprotected
array<string, mixed>
Конфигурация выполнения
$_configInitializedprotected
bool
Указывает, была ли конфигурация свойств уже настроена со значениями по умолчанию
$_currentprotected
string
Файл представления, который в настоящий момент отображается. Используется для разрешения родительских файлов.
$_currentTypeprotected
string
В настоящий момент отображается элемент. Используется для поиска родительских фрагментов для элементов.
$_defaultConfigprotected
array<string, mixed>
Параметры конфигурации по умолчанию.
$_eventClassprotected
string
Имя класса по умолчанию для новых объектов событий.
$_eventManagerprotected
Cake\Event\EventManagerInterface|null
Экземпляр Cake\Event\EventManager, используемый этим объектом для отправки внутренних событий.
$_extprotected
string
Расширение файла. По умолчанию «.php».
$_helpersprotected
Cake\View\HelperRegistry
Коллекция помощников
$_parentsprotected
array<string>
Имена представлений и их родителей, используемые с View::extend();
$_passedVarsprotected
array<string>
Список переменных для сбора из связанного контроллера.
$_pathsprotected
array<string>
Содержит массив путей.
$_pathsForPluginprotected
array<string[]>
Содержит массив путей плагинов.
$_responseTypeprotected
string
Тип ответа.
$_stackprotected
array<string>
Стек содержимого, используемый для вложенных шаблонов, которые все используют View::extend();
$_viewBlockClassprotected
string
Класс ViewBlock.
$autoLayoutprotected
bool
Включает или отключает стандартный режим CakePHP по применению файлов макета. Включено по умолчанию. Отключение означает, что макеты не будут автоматически применяться к рендеряемым шаблонам.
$elementCacheprotected
string
Конфигурация кэша, которую будет использовать View для хранения кэшированных элементов. Изменение этого параметра изменит стандартную конфигурацию, под которой хранятся элементы. Также вы можете выбрать конфигурацию кэша для каждого элемента.
$helpersprotected
array
Массив имён встроенных помощников для включения.
$layoutprotected
string
Имя файла макета для рендеринга шаблона. Указанное имя — имя файла макета в templates/layout/ без расширения .php.
$layoutPathprotected
string
JSON-макеты расположены в подкаталоге JSON Layouts/
$nameprotected
string
Имя контроллера, который создал представление, если таковой имеется.
$pluginprotected
string|null
Имя плагина.
$requestprotected
Cake\Http\ServerRequest
Экземпляр объекта \Cake\Http\ServerRequest, содержащий информацию о текущем запросе. Этот объект содержит всю информацию о запросе и несколько методов для чтения дополнительной информации о запросе.
$responseprotected
Cake\Http\Response
Ссылка на объект Response
$subDirprotected
string
JSON-представления расположены в подкаталоге «json» для представлений контроллеров.
$templateprotected
string
Имя файла шаблона для рендеринга. Указанное имя — имя файла в templates/<SubFolder>/ без расширения .php.

$templatePath protected

string

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

string|null

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

array<string, mixed>

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

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

__construct() public

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

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

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

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

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

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

Создаёт и настраивает экземпляр ячейки.
_dataToSerialize() 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

Получить используемую систему помощи (helpers).
initialize() public

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

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

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

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

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

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

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

Отобразить представление в формате JSON.
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<string, mixed> $viewOptions = [])

Конструктор

Параметры

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

__get() public

__get(string $name): Cake\View\Helper|null

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

Параметры

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

Возвращает

Cake\View\Helper|null

_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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

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

Параметры

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

Возвращает

void

Вызывает исключение

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

_createCell() protected

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

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

Параметры

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

Возвращает

Cake\View\Cell

_dataToSerialize() protected

_dataToSerialize(array|string $serialize): mixed

Возвращает данные для сериализации.

Параметры

array|string $serialize: Имя (имена) переменной (переменных) представления, которые необходимо сериализовать.

Возвращает

mixed

_elementCache() protected

_elementCache(string $name, array $data, array<string, mixed> $options): array

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

Параметры

string $name: Имя элемента
array $data: Данные
array<string, mixed> $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): array<string>

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

Параметры

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

Возвращает

array<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): array<string>

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

Параметры

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

Возвращает

array<string>

_render() protected

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

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

Parameters

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

Returns

string

Throws

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

_renderElement() protected

_renderElement(string $file, array $data, array<string, mixed> $options): string

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

Parameters

string $file: Путь к файлу элемента
array $data: Данные для рендеринга
array<string, mixed> $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(): array<string>

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

Returns

array<string>

cache() public

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

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

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

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

Parameters

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

Returns

string

Throws

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

cell() protected

cell(string $cell, array $data = [], array<string, mixed> $options = []): Cake\View\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');

Ячейки не рендерятся, пока не будут выведены.

Parameters

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

Returns

Cake\View\Cell

Throws

Cake\View\Exception\MissingCellException
Если класс ячейки не найден.

configShallow() public

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

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

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

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

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

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

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

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

Parameters

array<string, mixed>|string $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<string, mixed> $options = []): string

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

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

Parameters

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

Parameters

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

Returns

$this

end() public

end(): $this

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

Returns

$this

exists() public

exists(string $name): bool

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

Параметры

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

Возвращает

bool

extend() public

extend(string $name): $this

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

Параметры

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

Возвращает

$this

Выбрасывает

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

fetch() public

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

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

Параметры

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

Возвращает

string

См. также

\Cake\View\ViewBlock::get()

get() public

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

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

Параметры

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

Возвращает

mixed

getConfig() public

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

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

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

Параметры

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

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getCurrentType() public

getCurrentType(): string

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

Возвращает

string

getElementPaths() protected

getElementPaths(string|null $plugin): Generator

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

Параметры

string|null $plugin: Плагин для получения путей.

Возвращает

Generator

getEventManager() public

getEventManager(): Cake\Event\EventManagerInterface

getLayoutPaths(string|null $plugin): Generator

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

Параметры

string|null $plugin: Плагин для получения путей.

Возвращает

Generator

getName() public

getName(): string

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

Возвращает

string

getPlugin() public

getPlugin(): string|null

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

Возвращает

string|null

getRequest() public

getRequest(): Cake\Http\ServerRequest

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

Возвращает

Cake\Http\ServerRequest

getResponse() public

getResponse(): Cake\Http\Response

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

Возвращает

Cake\Http\Response

getSubDir() public

getSubDir(): string

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

initialize(): void

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

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

Возвращает

void

isAutoLayoutEnabled() public

isAutoLayoutEnabled(): bool

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

Возвращает

bool

loadHelper() public

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

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

Parameters

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

Returns

Cake\View\Helper

loadHelpers() public

loadHelpers(): $this

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

Returns

$this

log() public

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

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

Parameters

string $message: Сообщение для лога.
string|int $level optional: Уровень ошибки.
array|string $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: Контент для блока. Значение будет приведено к строковому типу.

Returns

$this

render() public

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

Рендеринг JSON представления.

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

beforeRender
afterRender
beforeLayout
afterLayout

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

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

Parameters

string|null $template optional: Рендеринг шаблона.
string|false|null $layout optional: Рендеринг макета.

Returns

string

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(array|string $name, mixed $value = null): $this

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

Parameters

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

Returns

$this

Throws

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

setConfig() public

setConfig(array<string, mixed>|string $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

array<string, mixed>|string $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: 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

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

Параметры

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

Возвращает

$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<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.JsonView.html