Класс NegotiationRequiredView

Класс представления, который реагирует на любой тип контента и может использоваться для создания ответа с пустым телом кодом состояния 406.

Это наиболее полезно при использовании переговорного типа контента через viewClasses() в вашем контроллере. Добавьте это представление в конец допустимых классов представлений, чтобы потребовать от клиентов выбрать доступный тип контента и у вас не было по умолчанию.

Пространство имен: 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_MATCH_ALL
```
'_match_all_'
```
Магический тип контента 'match-all', который представления могут использовать для работы как резервный вариант при переговорном типе контента.
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

Установлено ли свойству config значения по умолчанию
$_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

Возвращает имя файла шаблона данного действия в виде строки. Имена действий с верблюжьей нотацией по умолчанию преобразуются в нижний регистр с символом подчёркивания. Это означает, что вы можете использовать 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(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
contentType() public static

Получить тип содержимого
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

Отображает представление без тела и с кодом состояния 406.
renderLayout() public

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

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

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

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

Устанавливает тип контента ответа на основе contentType() представления.
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 для него, а также записывает в кэш, если используется кэш

Parameters

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

Returns

string

append() public

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

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

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

Parameters

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

Returns

$this

assign() public

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

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

Parameters

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

Returns

$this

blocks() public

blocks(): array<string>

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

Returns

array<string>

cache() public

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

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

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

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

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

Returns

Cake\View\Cell

Throws

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

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

contentType() public static

contentType(): string

Получить тип содержимого

Returns

string

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

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

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

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

Returns

array<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<string, mixed> $config = []): Cake\View\Helper

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

Parameters

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

Returns

Cake\View\Helper

loadHelpers() public

loadHelpers(): $this

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

Returns

$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. Проверяет, загружен ли плагин, иначе имя файла остаётся неизменным для имён файлов, содержащих точку

Параметры

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

Возвращает

array

prepend() public

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

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

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

Параметры

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::concat()

render() public

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

Отображает представление без тела и с кодом состояния 406.

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

beforeRender
afterRender
beforeLayout
afterLayout

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

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

Параметры

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

Возвращает

string

renderLayout() public

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

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

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

Параметры

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

Возвращает

string

Исключения

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

reset() public

reset(string $name): $this

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

Параметры

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

Возвращает

$this

См. также

\Cake\View\ViewBlock::set()

set() public

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

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

Параметры

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

Возвращает

$this

Исключения

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

setConfig() public

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

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

Использование

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

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

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

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

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

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

Параметры

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

Возвращает

$this

Исключения

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

setContentType() protected

setContentType(): void

Установить тип содержимого ответа на основе contentType() представления.

Возвращает

void

setElementCache() public

setElementCache(string $elementCache): $this

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

Параметры

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

Возвращает

$this

См. также

\Cake\View\View::$elementCache

setEventManager() public

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

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

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

Параметры

Cake\Event\EventManagerInterface $eventManager: устанавливаемый eventManager

Возвращает

$this

setLayout() public

setLayout(string $name): $this

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

Параметры

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

Возвращает

$this

setLayoutPath() public

setLayoutPath(string $path): $this

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

Параметры

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

Возвращает

$this

setPlugin() public

setPlugin(string|null $name): $this

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

Параметры

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

Возвращает

$this

setRequest() public

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

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

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

Параметры

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

Возвращает

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

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

Тип

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.4/class-Cake.View.NegotiationRequiredView.html