Класс Вид

Вид, V в триаде MVC. Вид взаимодействует с помощниками и переменными представления, переданными из контроллера, для отображения результатов действия контроллера. Часто это HTML, но также может быть JSON, XML, PDF или потоковые файлы.

CakePHP использует двухэтапный шаблон представления. Это означает, что сначала содержимое шаблона отображается, а затем вставляется в выбранную макетную страницу. Это также означает, что вы можете передавать данные из шаблона в макетную страницу с помощью $this->set()

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

public function beforeRender(\Cake\Event\EventInterface $event)
{
     $this->viewBuilder()->setTheme('SuperHot');
}

в вашем контроллере, чтобы использовать плагин SuperHot в качестве темы. Например, если текущее действие - PostsController::index(), то класс представления будет искать файл шаблона plugins/SuperHot/templates/Posts/index.php. Если шаблон темы для текущего действия не найден, используется файл шаблона по умолчанию приложения.

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

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

string[]

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

string[]

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

string[]

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

string[][]

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

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

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

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

__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

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

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

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

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

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

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

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

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

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

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

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

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

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

__construct() public

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

Конструктор

Параметры

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

__get() public

__get(string $name): mixed

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

Параметры

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

Возвращает

mixed

_checkFilePath() protected

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

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

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

Параметры

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

Возвращает

string

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

InvalidArgumentException

_configDelete() protected

_configDelete(string $key): void

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

Параметры

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

Возвращает

void

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

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() protected

_configRead(string|null $key): mixed

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

Параметры

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

Возвращает

mixed

_configWrite() protected

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

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

Параметры

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

Возвращает

void

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

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_createCell() protected

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

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

Параметры

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

Возвращает

Cake\View\Cell

_elementCache() protected

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

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

Параметры

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

Возвращает

array

_evaluate() protected

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

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

Параметры

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

Возвращает

string

_getElementFileName() protected

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

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

Параметры

string $name

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

bool $pluginCheck optional

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

Возвращает

string|false

_getLayoutFileName() protected

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

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

Параметры

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

Возвращает

string

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

Cake\View\Exception\MissingLayoutException
when a layout cannot be located
RuntimeException

_getSubPaths() protected

_getSubPaths(string $basePath): string[]

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

Параметры

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

Возвращает

string[]

_getTemplateFileName() protected

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

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

Параметры

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

Возвращает

string

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

Cake\View\Exception\MissingTemplateException
when a template file could not be found.
RuntimeException
When template name not provided.

_inflectTemplateFileName() protected

_inflectTemplateFileName(string $name): string

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

Параметры

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

Возвращает

string

_paths() protected

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

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

Параметры

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

Возвращает

string[]

_render() protected

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

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

Параметры

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

Возвращает

string

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

LogicException
When a block is left open.

_renderElement() protected

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

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

Параметры

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

Возвращает

string

append() public

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

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

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

Параметры

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

Возвращает

$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(): string[]

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

Возвращает

string[]

См. также

\Cake\View\ViewBlock::keys()

cache() public

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

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

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

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

Параметры

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

Возвращает

string

Выбрасывает

RuntimeException
При отсутствии опции 'key' в $options.

cell() protected

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

Возвращает

Cake\View\Cell

Выбрасывает

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

configShallow() public

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

$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 необязательно: Любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели.
object|null $subject необязательно: Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\EventInterface

element() public

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

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

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

Параметры

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

Возвращает

string

Выбрасывает

Cake\View\Exception\MissingElementException
Когда элемент отсутствует и `ignoreMissing` — ложь.

elementExists() public

elementExists(string $name): bool

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

Параметры

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

Возвращает

bool

enableAutoLayout() public

enableAutoLayout(bool $enable = true): $this

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

Параметры

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

Возвращает

$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: Ключ для получения.

Возвращает

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

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

Параметры

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

Возвращает

Cake\View\Helper

См. также

\Cake\View\HelperRegistry::load()

loadHelpers() public

loadHelpers(): $this

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

Возвращает

$this

log() public

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

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

Параметры

string $message: Сообщение журнала.
int|string $level необязательный: Уровень ошибки.
string|array $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(string|array $name, mixed $value = null): $this

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

Parameters

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

Returns

$this

Throws

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

setConfig() public

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

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

Usage

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

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

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

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

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

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

Parameters

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

Returns

$this

Throws

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

setElementCache() public

setElementCache(string $elementCache): $this

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

Parameters

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

Returns

$this

setEventManager() public

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

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

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

Parameters

Cake\Event\EventManagerInterface $eventManager: 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

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.View.View.html