Класс AjaxView

Класс представления, используемый для ответов AJAX. В настоящее время он только переключает стандартную макет и задаёт тип ответа — по умолчанию text/html.

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

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

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

Конфигурация во время выполнения
$_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

array<string>

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

array<string>

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

array<string>

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

array<string[]>

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

array<string>

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

string

Класс ViewBlock.
$autoLayout protected

bool

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

string

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

array

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

string

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

string

Имя подпапки макетов, содержащей макеты для этого представления.
$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, $subDir будет xml/
$template protected

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
Создание и настройка экземпляра ячейки.
_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 для него и запись в кэш, если используется кэш.
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

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

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

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

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

Рендерит представление для данного файла шаблона и макета.
renderLayout() public

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

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

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

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

Установить конфигурацию кэша, которую будет использовать представление для хранения кэшированных элементов.
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

_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

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

Параметры

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

Возвращает

string

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

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

_renderElement() protected

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

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

Параметры

string $file: Путь к файлу элемента
array $data: Данные для отображения
array<string, mixed> $options: Параметры элемента

Возвращает

string

append() public

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

Добавляет в существующий или новый блок.

Добавление в новый блок создаст блок.

Параметры

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::concat()

assign() public

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

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

Параметры

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::set()

blocks() public

blocks(): array<string>

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

Возвращает

array<string>

См. также

\Cake\View\ViewBlock::keys()

cache() public

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

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

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

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

Параметры

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

Возвращает

string

Выбрасывает

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');

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

Параметры

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: Параметры для конструктора ячейки

Возвращает

Cake\View\Cell

Выбрасывает

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']);

Параметры

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

Возвращает

$this

disableAutoLayout() public

disableAutoLayout(): $this

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

Возвращает

$this

dispatchEvent() public

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

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

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

Параметры

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

Возвращает

Cake\Event\EventInterface

element() public

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

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

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

Параметры

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

Возвращает

string

Выбрасывает

Cake\View\Exception\MissingElementException
Если элемент отсутствует, и `ignoreMissing` равно false.

elementExists() public

elementExists(string $name): bool

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

Параметры

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

Возвращает

bool

enableAutoLayout() public

enableAutoLayout(bool $enable = true): $this

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

Параметры

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

Возвращает

$this

end() public

end(): $this

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::end()

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 необязательный: Текст по умолчанию

Возвращает

string

См. также

\Cake\View\ViewBlock::get()

get() public

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

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

Параметры

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

Возвращает

mixed

getConfig() public

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

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

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

Параметры

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

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Параметры

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

Возвращает

InvalidArgumentException

Выбрасывает

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().

Параметры

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

Возвращает

Cake\View\Helper

См. также

\Cake\View\HelperRegistry::load()

loadHelpers() public

loadHelpers(): $this

Взаимодействует с HelperRegistry для загрузки всех помощников.

Возвращает

$this

log() public

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

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

Параметры

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

Возвращает

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

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

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

beforeRender
afterRender
beforeLayout
afterLayout

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

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

Parameters

string|null $template optional: Имя файла шаблона для использования
string|false|null $layout optional: Макет для использования. False для отключения.

Returns

string

Throws

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

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

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

Parameters

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

Returns

$this

setSubDir() public

setSubDir(string $subDir): $this

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

Parameters

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

Returns

$this

setTemplate() public

setTemplate(string $name): $this

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

Parameters

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

Returns

$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: Имя блока для захвата.

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

Тип

string|null

`$viewVars` protected

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

Тип

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.AjaxView.html

Класс AjaxView

Константы

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

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

__construct()public

__get()public

_checkFilePath()protected

_configDelete()protected

_configRead()protected

_configWrite()protected

_createCell()protected

_elementCache()protected

_evaluate()protected

_getElementFileName()protected

_getLayoutFileName()protected

_getSubPaths()protected

_getTemplateFileName()protected

_inflectTemplateFileName()protected

_paths()protected

_render()protected

_renderElement()protected

append()public

assign()public

blocks()public

cache()public

cell()protected

configShallow()public

disableAutoLayout()public

dispatchEvent()public

element()public

elementExists()public

enableAutoLayout()public

end()public

exists()public

extend()public

fetch()public

get()public

getConfig()public

getConfigOrFail()public

getCurrentType()public

getElementPaths()protected

getEventManager()public

getLayout()public

getLayoutPath()public

getLayoutPaths()protected

getName()public

getPlugin()public

getRequest()public

getResponse()public

getSubDir()public

getTemplate() public

getTemplatePath() public

getTheme() public

getVars() public

helpers() public

initialize() public

isAutoLayoutEnabled() public

loadHelper() public

loadHelpers() public

log() public

pluginSplit() public

prepend() public

render() public

renderLayout() public

reset() public

set() public

setConfig() public

setElementCache() public

setEventManager() public

setLayout() public

setLayoutPath() public

setPlugin() public

setRequest() public

setResponse() public

setSubDir() public

setTemplate() public

setTemplatePath() public

setTheme() public

start() public

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