类 AjaxView

用于 AJAX 响应的视图类。目前，它只切换默认布局并设置响应类型 - 默认情况下映射到 text/html。

命名空间: Cake\View

常量

字符串

NAME_TEMPLATE ¶
```
'templates'
```
用于 App::path() 的类型常量。
字符串

PLUGIN_TEMPLATE_FOLDER ¶
```
'plugin'
```
包含用于覆盖插件模板的文件的文件夹名称常量。
字符串

TYPE_ELEMENT ¶
```
'element'
```
视图文件类型 'element' 常量
字符串

TYPE_LAYOUT ¶
```
'layout'
```
视图文件类型 'layout' 常量
字符串

TYPE_MATCH_ALL ¶
```
'_match_all_'
```
视图可以使用的“匹配所有”魔法内容类型，在内容类型协商期间充当后备。
字符串

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

布尔值

配置属性是否已使用默认值配置
$_current protected

字符串

当前正在渲染的视图文件。用于解析父文件。
$_currentType protected

字符串

当前正在渲染元素。用于查找元素的父片段。
$_defaultConfig protected

array<string, mixed>

默认自定义配置选项。
$_eventClass protected

字符串

新事件对象的默认类名。
$_eventManager protected

Cake\Event\EventManagerInterface|null

此对象用于调度内部事件的 Cake\Event\EventManager 实例。
$_ext protected

字符串

文件扩展名。默认为 ".php"。
$_helpers protected

Cake\View\HelperRegistry|null

辅助程序集合
$_parents protected

array<string, string>

与 View::extend(); 一起使用的视图及其父级的名称。
$_passedVars protected

list<string>

从关联控制器收集的变量列表。
$_paths protected

list<string>

保存路径数组。
$_pathsForPlugin protected

array<string, list<string>>

保存插件路径数组。
$_stack protected

list<string>

内容堆栈，用于所有使用 View::extend(); 的嵌套模板。
$_viewBlockClass protected

字符串

ViewBlock 类。
$autoLayout protected

布尔值

开启或关闭 CakePHP 的应用布局文件的传统模式。默认开启。设置为关闭意味着布局不会自动应用于渲染的模板。
$elementCache protected

字符串

视图将用于存储缓存元素的缓存配置。更改此项将更改元素存储的默认配置。您也可以为每个元素选择一个缓存配置。
$helpers protected

array<string, array<string, mixed>>

要加载的辅助程序的配置数组。
$layout protected

字符串

要渲染模板的布局文件名称。指定的名称是 templates/layout/ 中的布局文件名，不带 .php 扩展名。
$layoutPath protected

字符串

包含此视图的布局子文件夹的名称。
$name protected

字符串

创建视图的控制器的名称（如果有）。
$plugin protected

字符串|空

插件的名称。
$request protected

Cake\Http\ServerRequest

包含有关当前请求的信息的 \Cake\Http\ServerRequest 对象的实例。此对象包含有关请求的所有信息，以及用于读取有关请求的附加信息的几种方法。
$response protected

Cake\Http\Response

对 Response 对象的引用
$subDir protected

字符串

此模板文件的子目录。这通常用于基于扩展名的路由。例如，使用 xml 扩展名，$subDir 将为 xml/
$template protected

字符串

要渲染的模板文件名称。指定的名称是 templates/<SubFolder>/ 中的文件名，不带 .php 扩展名。
$templatePath protected

字符串

包含此视图的模板子文件夹的名称。
$theme protected

字符串|空

要使用的视图主题。
$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() 受保护

将给定操作的模板文件的文件名作为字符串返回。默认情况下，驼峰式操作名称将被下划线化。这意味着你可以有 LongActionNames，它们对应于 long_action_names.php 模板。你可以通过覆盖 _inflectTemplateFileName 来更改词形变化规则。
_inflectTemplateFileName() 受保护

将视图模板文件名称更改为下划线格式。
_paths() 受保护

按顺序返回查找视图文件的所有可能路径。
_render() 受保护

渲染并返回给定模板文件名及其数据数组的输出。处理父/扩展模板。
_renderElement() 受保护

渲染一个元素并触发它的 before 和 afterRender 回调，如果使用缓存，则写入缓存。
addHelper() 受保护

在 initialize() 方法中添加一个助手。
append() 公共

追加到现有或新的区块。
assign() 公共

设置区块的内容。这将覆盖任何现有内容。
blocks() 公共

获取所有现有区块的名称。
cache() 公共

创建一个缓存的视图逻辑区块。
cell() 受保护

渲染给定的单元格。
configShallow() 公共

将提供的配置与现有配置合并。与 config() 对嵌套键进行递归合并不同，此方法进行简单合并。
contentType() 公共静态

获取此视图的内容类型。
disableAutoLayout() 公共

关闭 CakePHP 的应用布局文件的常规模式。布局将不会自动应用于渲染的视图。
dispatchEvent() 公共

用于创建和调度事件的包装器。
element() 公共

使用提供的参数渲染一段 PHP 代码并返回 HTML、XML 或任何其他字符串。
elementExists() 公共

检查元素是否存在。
enableAutoLayout() 公共

打开或关闭 CakePHP 的应用布局文件的常规模式。默认情况下打开。设置为关闭意味着布局不会自动应用于渲染的视图。
end() 公共

结束捕获区块。View::start() 的补充。
exists() 公共

检查区块是否存在。
extend() 公共

提供模板或元素扩展/继承。模板可以扩展父模板并在父模板中填充区块。
fetch() 公共

获取区块的内容。如果区块为空或未定义，将返回 ''。
get() 公共

返回给定 View 变量的内容。
getConfig() 公共

返回配置。
getConfigOrFail() 公共

返回此特定键的配置。
getCurrentType() 公共

检索当前模板类型。
getElementPaths() 受保护

获取元素路径的迭代器。
getEventManager() 公共

返回此对象的 Cake\Event\EventManager 管理器实例。
getLayout() 公共

获取布局文件名称，用于渲染模板。指定的名字是 templates/layout/ 中的布局文件名，不含 .php 扩展名。
getLayoutPath() 公共

获取布局文件的路径。
getLayoutPaths() 受保护

获取布局路径的迭代器。
getName() 公共

返回 View 的控制器名称。
getPlugin() 公共

返回插件名称。
getRequest() 公共

获取请求实例。
getResponse() 公共

获取响应实例。
getSubDir() 公共

获取此模板文件子目录。
getTemplate() 公共

获取要渲染的模板文件名称。指定的名字是 templates/<SubFolder>/ 中的文件名，不含 .php 扩展名。
getTemplatePath() 公共

获取模板文件的路径。
getTheme() 公共

获取当前视图主题。
getVars() 公共

返回当前 View 上下文中可用的变量列表。
helpers() 公共

获取此 View 类使用的助手注册表。
initialize() 公共

初始化钩子方法。
isAutoLayoutEnabled() 公共

返回 CakePHP 的应用布局文件的常规模式是否启用。禁用意味着布局不会自动应用于渲染的视图。
loadHelper() 公共

加载助手。委托给 HelperRegistry::load() 来加载助手。
loadHelpers() 公共

与 HelperRegistry 交互以加载所有助手。
log() 公共

用于向 Log 写入消息的便利方法。有关写入日志的更多信息，请参见 Log::write()。
pluginSplit() 公共

将点语法插件名称拆分为其插件和文件名。如果 $name 没有点，则索引 0 将为 null。它检查插件是否加载，否则文件名将保持不变，以便文件名包含点。
prepend() 公共

追加到现有或新的区块。
render() 公共

为给定的模板文件和布局渲染视图。
renderLayout() 公共

渲染布局。返回 _render() 的输出。
reset() 公共

重置区块的内容。这将覆盖任何现有内容。
set() 公共

保存一个变量或一个关联变量数组，以便在模板内部使用。
setConfig() 公共

设置配置。
setContentType() 受保护

根据视图的 contentType() 设置响应内容类型。
setElementCache() 公共

设置 View 将用于存储缓存元素的缓存配置。
setEventManager() 公共

返回此对象的 Cake\Event\EventManagerInterface 实例。
setLayout() 公共

设置布局文件名称，用于渲染模板。指定的名字是 templates/layout/ 中的布局文件名，不含 .php 扩展名。
setLayoutPath() 公共

设置布局文件的路径。
setPlugin() 公共

设置插件名称。
setRequest() 公共

设置请求对象并根据请求内容配置许多控制器属性。设置的属性是
setResponse() 公共

设置响应实例。
setSubDir() 公共

设置此模板文件的子目录。
setTemplate() 公共

设置要渲染的模板文件名称。指定的名字是 templates/<SubFolder>/ 中的文件名，不含 .php 扩展名。
setTemplatePath() 公共

设置模板文件的路径。
setTheme() 公共

设置要使用的视图主题。
start() 公共

开始捕获 '区块' 的输出。

方法详细说明

__construct() ¶ 公共

__construct(Cake\Http\ServerRequest|null $request = null, Cake\Http\Response|null $response = null, Cake\Event\EventManagerInterface|null $eventManager = null, array<string, mixed> $viewOptions = [])

构造函数

参数

Cake\Http\ServerRequest|null $request 可选: 请求实例。
Cake\Http\Response|null $response 可选: 响应实例。
Cake\Event\EventManagerInterface|null $eventManager 可选: 事件管理器实例。
array<string, mixed> $viewOptions 可选: 视图选项。有关作为类属性设置的选项列表，请参见 {@link View::$_passedVars}。

__get() ¶ 公共

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

辅助程序的魔术访问器。

参数

string $name: 要获取的属性名称。

返回值

Cake\View\Helper|null

_checkFilePath() ¶ 受保护

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

检查视图文件路径是否超出定义的模板路径。

只有包含 .. 的路径才会被检查，因为它们最有可能具有解析到模板路径之外的文件的能力。

参数

string $file: 模板文件路径。
string $path: $file 应该位于的基路径。

返回值

字符串

抛出

InvalidArgumentException

_configDelete() ¶ 受保护

_configDelete(string $key): void

删除单个配置键。

参数

string $key: 要删除的键。

返回值

void

抛出

Cake\Core\Exception\CakeException
如果尝试覆盖现有配置

_configRead() ¶ 受保护

_configRead(string|null $key): mixed

读取配置键。

参数

string|null $key: 要读取的键。

返回值

mixed

_configWrite() ¶ 受保护

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

写入配置键。

参数

array<string, mixed>|string $key: 要写入的键。
mixed $value: 要写入的值。
string|bool $merge 可选: True 表示递归合并，'shallow' 表示简单合并，false 表示覆盖，默认为 false。

返回值

void

抛出

Cake\Core\Exception\CakeException
如果尝试覆盖现有配置

_createCell() ¶ 受保护

_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() ¶ 受保护

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

为元素生成缓存配置选项。

参数

string $name: 元素名称
array $data: 数据
array<string, mixed> $options: 元素选项

返回值

array<string, mixed>

_evaluate() ¶ 受保护

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

用于评估模板/视图脚本的安全沙箱方法。

参数

string $templateFile: 模板的文件名。
array $dataForView: 要包含在渲染视图中的数据。

返回值

字符串

_getElementFileName() ¶ 受保护

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

查找元素文件名，失败时返回 false。

参数

string $name

要查找的元素名称。

bool $pluginCheck 可选

如果为 false，将忽略请求的插件，即使解析的插件未加载。

返回值

string|false

_getLayoutFileName() ¶ 受保护

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

返回此模板的布局文件名作为字符串。

参数

string|null $name 可选: 要查找的布局名称。

返回值

字符串

抛出

Cake\View\Exception\MissingLayoutException
当找不到布局时
Cake\Core\Exception\CakeException

_getSubPaths() ¶ 受保护

_getSubPaths(string $basePath): list<string>

查找所有子模板路径，基于 $basePath。如果当前请求中定义了前缀，此方法将把前缀模板路径添加到 $basePath，在嵌套前缀的情况下级联向上。这实际上用于查找元素和布局的前缀模板路径。

参数

string $basePath: 获取前缀路径的基础路径。

返回值

list<string>

_getTemplateFileName() ¶ 受保护

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

将给定操作的模板文件的文件名作为字符串返回。默认情况下，驼峰式操作名称将被下划线化。这意味着你可以有 LongActionNames，它们对应于 long_action_names.php 模板。你可以通过覆盖 _inflectTemplateFileName 来更改词形变化规则。

参数

string|null $name 可选: 要查找模板文件名的控制器操作

返回值

字符串

抛出

Cake\View\Exception\MissingTemplateException
当找不到模板文件时。
Cake\Core\Exception\CakeException
当未提供模板名称时。

_inflectTemplateFileName() ¶ 受保护

_inflectTemplateFileName(string $name): string

将视图模板文件名称更改为下划线格式。

参数

string $name: 应该进行词形变化的文件的名称。

返回值

字符串

_paths() ¶ 受保护

_paths(string|null $plugin = null, bool $cached = true): list<string>

按顺序返回查找视图文件的所有可能路径。

参数

string|null $plugin 可选: 可选的插件名称，用于扫描视图文件。
bool $cached 可选: 设置为 false 以强制刷新视图路径。默认值为 true。

返回值

list<string>

_render() ¶ 受保护

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

渲染并返回给定模板文件名及其数据数组的输出。处理父/扩展模板。

参数

string $templateFile: 模板的文件名
array $data 可选: 要包含在渲染视图中的数据。如果为空，将使用当前 View::$viewVars。

返回值

字符串

抛出

LogicException
当块未关闭时。

_renderElement() ¶ 受保护

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

渲染一个元素并触发它的 before 和 afterRender 回调，如果使用缓存，则写入缓存。

参数

string $file: 元素文件路径
array $data: 要渲染的数据
array<string, mixed> $options: 元素选项

返回值

字符串

addHelper() ¶ 受保护

addHelper(string $helper, array<string, mixed> $config = []): void

在 initialize() 方法中添加一个助手。

参数

string $helper: 助手。
array<string, mixed> $config 可选: 配置。

返回值

void

append() ¶ 公共

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

追加到现有或新的区块。

追加到新的块将创建块。

参数

string $name: 块的名称
mixed $value 可选: 块的内容。值将被类型强制转换为字符串。

返回值

$this

另请参阅

\Cake\View\ViewBlock::concat()

assign() ¶ 公共

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

设置区块的内容。这将覆盖任何现有内容。

参数

string $name: 块的名称
mixed $value: 块的内容。值将被类型强制转换为字符串。

返回值

$this

另请参阅

\Cake\View\ViewBlock::set()

blocks() ¶ 公共

blocks(): list<string>

获取所有现有区块的名称。

返回值

list<string>

另请参阅

\Cake\View\ViewBlock::keys()

cache() ¶ 公共

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

创建一个缓存的视图逻辑区块。

这使您可以将视图输出的块缓存到 elementCache 中定义的缓存中。

此方法将首先尝试读取缓存。如果缓存为空，则将运行 $block 并存储输出。

参数

callable $block: 您要缓存其输出的代码块。
array<string, mixed> $options 可选: 定义缓存键等的选项。

返回值

字符串

抛出

InvalidArgumentException
当 $options 缺少 'key' 选项时。

cell() ¶ 受保护

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 可选: 单元格方法的附加参数。例如：cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2']) 对应于 View\Cell\TagCloud::smallList(v1, v2)
array<string, mixed> $options 可选: 单元格构造函数的选项

返回值

Cake\View\Cell

抛出

Cake\View\Exception\MissingCellException
如果未找到单元格类。

configShallow() ¶ 公共

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 可选: 要设置的值。

返回值

$this

contentType() ¶ 公共静态

contentType(): string

获取此视图的内容类型。

返回值

字符串

disableAutoLayout() ¶ 公共

disableAutoLayout(): $this

关闭 CakePHP 的应用布局文件的常规模式。布局将不会自动应用于渲染的视图。

返回值

$this

dispatchEvent() ¶ 公共

dispatchEvent(string $name, array $data = [], TSubject|null $subject = null): Cake\Event\EventInterface<TSubject>

用于创建和调度事件的包装器。

返回一个已分派的事件。

参数

string $name: 事件名称。
array $data 可选: 您希望随此事件一起传输的任何值，侦听器都可以读取。
TSubject|null $subject 可选: 此事件适用的对象（默认情况下为 $this）。

返回值

Cake\Event\EventInterface<TSubject>

element() ¶ 公共

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

使用提供的参数渲染一段 PHP 代码并返回 HTML、XML 或任何其他字符串。

这实现了元素（或“部分布局”）的概念，$params 数组用于发送要用于元素中的数据。元素可以使用 cache 选项进行缓存，从而提高性能。

参数

string $name: templates/element/ 文件夹中的模板文件名称，或 MyPlugin.template 以使用 MyPlugin 中的模板元素。如果在插件中找不到元素，则将搜索正常的视图路径级联。
array $data 可选: 要使渲染视图（即元素）可用的数据数组
array<string, mixed> $options 可选: 选项数组。可能的键是

返回值

字符串

抛出

Cake\View\Exception\MissingElementException
当元素丢失且 `ignoreMissing` 为 false 时。

elementExists() ¶ 公共

elementExists(string $name): bool

检查元素是否存在。

参数

string $name: templates/element/ 文件夹中的模板文件名称，或 MyPlugin.template 以检查 MyPlugin 中的模板元素。如果在插件中找不到元素，则将搜索正常的视图路径级联。

返回值

布尔值

enableAutoLayout() ¶ 公共

enableAutoLayout(bool $enable = true): $this

打开或关闭 CakePHP 的应用布局文件的常规模式。默认情况下打开。设置为关闭意味着布局不会自动应用于渲染的视图。

参数

bool $enable 可选: 用于打开/关闭的布尔值。

返回值

$this

end() ¶ 公共

end(): $this

结束捕获区块。View::start() 的补充。

返回值

$this

另请参阅

\Cake\View\ViewBlock::end()

exists() ¶ 公共

exists(string $name): bool

检查区块是否存在。

参数

string $name: 块的名称

返回值

布尔值

extend() ¶ 公共

extend(string $name): $this

提供模板或元素扩展/继承。模板可以扩展父模板并在父模板中填充区块。

参数

string $name: 要“扩展”当前模板或元素的模板或元素。

返回值

$this

抛出

LogicException
当您使用自身扩展模板或进行扩展循环时。
LogicException
当您扩展不存在的元素时

fetch() ¶ 公共

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

获取区块的内容。如果区块为空或未定义，将返回 ''。

参数

string $name: 块的名称
string $default 可选: 默认文本

返回值

字符串

另请参阅

\Cake\View\ViewBlock::get()

get() ¶ public

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

返回给定 View 变量的内容。

参数

string $var: 您要获取内容的视图变量。
mixed $default 可选: $var 的默认/回退内容。

返回值

mixed

getConfig() ¶ public

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

返回配置。

用法

读取整个配置

$this->getConfig();

读取特定值

$this->getConfig('key');

读取嵌套值

$this->getConfig('some.nested.key');

使用默认值读取

$this->getConfig('some-key', 'default-value');

参数

string|null $key 可选: 要获取的键，或 null 代表整个配置。
mixed $default 可选: 当键不存在时的返回值。

返回值

mixed

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

返回此特定键的配置。

此键的配置值必须存在，不能为 null。

参数

string $key: 要获取的键。

返回值

mixed

抛出

InvalidArgumentException

getCurrentType() ¶ public

getCurrentType(): string

检索当前模板类型。

返回值

字符串

getElementPaths() ¶ protected

getElementPaths(string|null $plugin): Generator

获取元素路径的迭代器。

参数

string|null $plugin: 要获取路径的插件。

返回值

生成器

getEventManager() ¶ public

getEventManager(): Cake\Event\EventManagerInterface

返回此对象的 Cake\Event\EventManager 管理器实例。

您可以使用此实例向对象事件注册任何新的监听器或回调，或创建您自己的事件并随意触发它们。

返回值

Cake\Event\EventManagerInterface

getLayout() ¶ public

getLayout(): string

获取布局文件名称，用于渲染模板。指定的名字是 templates/layout/ 中的布局文件名，不含 .php 扩展名。

返回值

字符串

getLayoutPath() ¶ public

getLayoutPath(): string

获取布局文件的路径。

返回值

字符串

getLayoutPaths() ¶ protected

getLayoutPaths(string|null $plugin): Generator

获取布局路径的迭代器。

参数

string|null $plugin: 要获取路径的插件。

返回值

生成器

getName() ¶ public

getName(): string

返回 View 的控制器名称。

返回值

字符串

getPlugin() ¶ public

getPlugin(): string|null

返回插件名称。

返回值

字符串|空

getRequest() ¶ public

getRequest(): Cake\Http\ServerRequest

获取请求实例。

返回值

Cake\Http\ServerRequest

getResponse() ¶ public

getResponse(): Cake\Http\Response

获取响应实例。

返回值

Cake\Http\Response

getSubDir() ¶ public

getSubDir(): string

获取此模板文件子目录。

返回值

字符串

另请参阅

\Cake\View\View::$subDir

getTemplate() ¶ public

getTemplate(): string

获取要渲染的模板文件名称。指定的名字是 templates/<SubFolder>/ 中的文件名，不含 .php 扩展名。

返回值

字符串

getTemplatePath() ¶ public

getTemplatePath(): string

获取模板文件的路径。

返回值

字符串

getTheme() ¶ public

getTheme(): string|null

获取当前视图主题。

返回值

字符串|空

getVars() ¶ public

getVars(): list<string>

返回当前 View 上下文中可用的变量列表。

返回值

list<string>

helpers() ¶ public

helpers(): Cake\View\HelperRegistry

获取此 View 类使用的助手注册表。

返回值

Cake\View\HelperRegistry

initialize() ¶ public

initialize(): void

初始化钩子方法。

像 $helpers 这样的属性不能在您的自定义视图类中静态初始化，因为它们会被控制器在构造函数中的值覆盖。因此，此方法允许您在视图实例构建后按需操作它们。

可以使用 {@link addHelper()} 方法添加助手。

返回值

void

isAutoLayoutEnabled() ¶ public

isAutoLayoutEnabled(): bool

返回 CakePHP 的应用布局文件的常规模式是否启用。禁用意味着布局不会自动应用于渲染的视图。

返回值

布尔值

loadHelper() ¶ public

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

加载助手。委托给 HelperRegistry::load() 来加载助手。

您应该在 AppView 或其他自定义视图类的 initialize() 钩子中使用 addHelper() 而不是此方法。

参数

string $name: 要加载的助手的名称。
array<string, mixed> $config 可选: 助手的设置

返回值

Cake\View\Helper

另请参阅

\Cake\View\HelperRegistry::load()

loadHelpers() ¶ public

loadHelpers(): $this

与 HelperRegistry 交互以加载所有助手。

返回值

$this

log() ¶ public

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

用于向 Log 写入消息的便利方法。有关写入日志的更多信息，请参见 Log::write()。

参数

Stringable|string $message: 日志消息。
string|int $level 可选: 错误级别。
array|string $context 可选: 与此消息相关的其他日志数据。

返回值

布尔值

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: 块的内容。值将被类型强制转换为字符串。

返回值

$this

另请参阅

\Cake\View\ViewBlock::concat()

render() ¶ public

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

为给定的模板文件和布局渲染视图。

渲染触发助手回调，这些回调在模板渲染前后以及布局前后被触发。助手回调被称为

beforeRender
afterRender
beforeLayout
afterLayout

如果 View::$autoLayout 设置为 false，则模板将以裸露形式返回。

模板和布局名称可以指向插件模板或布局。使用 Plugin.template 语法，可以使用插件模板/布局/ 而不是应用程序模板/布局/。如果找不到选择的插件，则模板将沿着常规视图路径级联定位。

参数

string|null $template 可选: 要使用的模板文件名
string|false|null $layout 可选: 要使用的布局。False 表示禁用。

返回值

字符串

抛出

Cake\Core\Exception\CakeException
如果视图中存在错误。

renderLayout() ¶ public

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

渲染布局。返回 _render() 的输出。

为在布局中使用创建了多个变量。

参数

string $content: 要在模板中渲染的内容，由周围的布局包裹。
string|null $layout 可选: 布局名称

返回值

字符串

抛出

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

抛出

Cake\Core\Exception\CakeException
如果数组合并操作失败。

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: 要捕获的块的名称。

返回值

$this

另请参阅

\Cake\View\ViewBlock::start()

属性详情

`$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

配置属性是否已使用默认值配置

类型

布尔值

`$_current` ¶ protected

当前正在渲染的视图文件。用于解析父文件。

类型

字符串

`$_currentType` ¶ protected

当前正在渲染元素。用于查找元素的父片段。

类型

字符串

`$_defaultConfig` ¶ protected

默认自定义配置选项。

类型

array<string, mixed>

`$_eventClass` ¶ protected

新事件对象的默认类名。

类型

字符串

`$_eventManager` ¶ protected

此对象用于调度内部事件的 Cake\Event\EventManager 实例。

类型

Cake\Event\EventManagerInterface|null

`$_ext` ¶ protected

文件扩展名。默认为 ".php"。

类型

字符串

`$_helpers` ¶ protected

辅助程序集合

类型

Cake\View\HelperRegistry|null

`$_parents` ¶ protected

与 View::extend(); 一起使用的视图及其父级的名称。

类型

array<string, string>

`$_passedVars` ¶ protected

从关联控制器收集的变量列表。

类型

list<string>

`$_paths` ¶ protected

保存路径数组。

类型

list<string>

`$_pathsForPlugin` ¶ protected

保存插件路径数组。

类型

array<string, list<string>>

`$_stack` ¶ protected

内容堆栈，用于所有使用 View::extend(); 的嵌套模板。

类型

list<string>

`$_viewBlockClass` ¶ protected

ViewBlock 类。

类型

字符串

`$autoLayout` ¶ protected

开启或关闭 CakePHP 的应用布局文件的传统模式。默认开启。设置为关闭意味着布局不会自动应用于渲染的模板。

类型

布尔值

`$elementCache` ¶ protected

视图将用于存储缓存元素的缓存配置。更改此项将更改元素存储的默认配置。您也可以为每个元素选择一个缓存配置。

类型

字符串

`$helpers` ¶ protected

要加载的辅助程序的配置数组。

类型

array<string, array<string, mixed>>

`$layout` ¶ protected

要渲染模板的布局文件名称。指定的名称是 templates/layout/ 中的布局文件名，不带 .php 扩展名。

类型

字符串

`$layoutPath` ¶ protected

包含此视图的布局子文件夹的名称。

类型

字符串

`$name` ¶ protected

创建视图的控制器的名称（如果有）。

类型

字符串

`$plugin` ¶ protected

插件的名称。

类型

字符串|空

`$request` ¶ protected

包含有关当前请求的信息的 \Cake\Http\ServerRequest 对象的实例。此对象包含有关请求的所有信息，以及用于读取有关请求的附加信息的几种方法。

类型

Cake\Http\ServerRequest

`$response` ¶ protected

对 Response 对象的引用

类型

Cake\Http\Response

`$subDir` ¶ protected

此模板文件的子目录。这通常用于基于扩展名的路由。例如，使用 xml 扩展名，$subDir 将为 xml/

类型

字符串

`$template` ¶ protected

要渲染的模板文件名称。指定的名称是 templates/<SubFolder>/ 中的文件名，不带 .php 扩展名。

类型

字符串

`$templatePath` ¶ protected

包含此视图的模板子文件夹的名称。

类型

字符串

`$theme` ¶ protected

要使用的视图主题。

类型

字符串|空

`$viewVars` ¶ protected

变量数组

类型

array<string, mixed>

命名空间

类 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() 受保护

_inflectTemplateFileName() 受保护

_paths() 受保护

_render() 受保护

_renderElement() 受保护

addHelper() 受保护

append() 公共

assign() 公共

blocks() 公共

cache() 公共

cell() 受保护

configShallow() 公共

contentType() 公共 静态

disableAutoLayout() 公共

dispatchEvent() 公共

element() 公共

elementExists() 公共

enableAutoLayout() 公共

end() 公共

exists() 公共

extend() 公共

fetch() 公共

get() 公共

getConfig() 公共

getConfigOrFail() 公共

getCurrentType() 公共

getElementPaths() 受保护

getEventManager() 公共

getLayout() 公共

getLayoutPath() 公共

getLayoutPaths() 受保护

getName() 公共

getPlugin() 公共

getRequest() 公共

getResponse() 公共

getSubDir() 公共

getTemplate() 公共

getTemplatePath() 公共

getTheme() 公共

getVars() 公共

helpers() 公共

initialize() 公共

isAutoLayoutEnabled() 公共

loadHelper() 公共

loadHelpers() 公共

log() 公共

pluginSplit() 公共

prepend() 公共

render() 公共

renderLayout() 公共

reset() 公共

set() 公共

setConfig() 公共

setContentType() 受保护

setElementCache() 公共

setEventManager() 公共

setLayout() 公共

setLayoutPath() 公共

setPlugin() 公共

setRequest() 公共

setResponse() 公共

setSubDir() 公共

setTemplate() 公共

contentType() 公共静态