类 SerializedView

生成序列化输出（如 JsonView 和 XmlView）的视图类的父类。

抽象
命名空间: 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

配置属性是否已使用默认值配置
$_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|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

string

ViewBlock 类。
$autoLayout protected

bool

启用或禁用 CakePHP 的传统模式，该模式用于应用布局文件。默认情况下启用。设置为关闭表示布局不会自动应用于渲染的模板。
$elementCache protected

string

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

array<string, array<string, mixed>>

用于加载助手的配置数组。
$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 回调，如果使用缓存，则写入缓存。
_serialize() abstract protected

序列化视图变量。
addHelper() protected

从 initialize() 方法中添加助手。
append() public

附加到现有或新块。
assign() public

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

获取所有现有块的名称。
cache() public

创建缓存的视图逻辑块。
cell() protected

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

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

此视图类渲染的 MIME 类型。
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

仅在禁用序列化时加载助手。
log() public

向日志写入消息的便捷方法。有关写入日志的更多信息，请参阅 Log::write()。
pluginSplit() public

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

附加到现有或新块。
render() public

渲染视图模板或返回序列化数据。
renderLayout() public

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

重置块的内容。这将覆盖任何现有内容。
serializeKeys() protected
set() public

保存变量或关联变量数组，以便在模板中使用。
setConfig() public

设置配置。
setContentType() protected

根据视图的 contentType() 设置响应内容类型。
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\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() ¶ 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, mixed>

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

参数

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

返回值

array<string, mixed>

_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
当找不到布局时
Cake\Core\Exception\CakeException

_getSubPaths() ¶ protected

_getSubPaths(string $basePath): list<string>

根据 $basePath 查找所有子模板路径。如果当前请求中定义了前缀，此方法会将前缀模板路径添加到 $basePath，在遇到嵌套前缀时，会级联向上查找。这主要用于查找元素和布局的前缀模板路径。

参数

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

返回值

list<string>

_getTemplateFileName() ¶ protected

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

以字符串形式返回给定操作的模板文件的文件名。默认情况下，骆驼式操作名称将被转换为下划线形式。这意味着你可以使用 LongActionNames 来引用 long_action_names.php 模板。你可以通过覆盖 _inflectTemplateFileName 来更改变形规则。

参数

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

返回值

string

抛出

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

_inflectTemplateFileName() ¶ protected

_inflectTemplateFileName(string $name): string

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

参数

string $name: 应该被词形转换的文件名。

返回值

string

_paths() ¶ protected

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

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

参数

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

返回值

list<string>

_render() ¶ protected

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

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

参数

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

返回值

string

抛出

LogicException
当块保持打开状态时。

_renderElement() ¶ protected

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

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

参数

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

返回值

string

_serialize() ¶ abstract protected

_serialize(array|string $serialize): string

序列化视图变量。

参数

array|string $serialize: 需要序列化的视图变量的名称。

返回值

string

addHelper() ¶ protected

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

从 initialize() 方法中添加助手。

参数

string $helper: 辅助函数。
array<string, mixed> $config optional: 配置。

返回值

void

append() ¶ public

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

附加到现有或新块。

追加到新的块将创建该块。

参数

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

返回值

$this

另请参阅

\Cake\View\ViewBlock::concat()

assign() ¶ public

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

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

参数

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

返回值

$this

另请参阅

\Cake\View\ViewBlock::set()

blocks() ¶ public

blocks(): list<string>

获取所有现有块的名称。

返回值

list<string>

另请参阅

\Cake\View\ViewBlock::keys()

cache() ¶ public

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

创建缓存的视图逻辑块。

这允许您将视图输出的块缓存到 elementCache 中定义的缓存中。

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

参数

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

返回值

string

抛出

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

cell() ¶ protected

cell(string $cell, array $data = [], array<string, mixed> $options = []): Cake\View\Cell

渲染给定的单元格。

示例

// Taxonomy\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('Taxonomy.TagCloud::smallList', ['limit' => 10]);

// App\View\Cell\TagCloudCell::smallList()
$cell = $this->cell('TagCloud::smallList', ['limit' => 10]);

当没有提供操作时，默认情况下将使用 display 操作。

// Taxonomy\View\Cell\TagCloudCell::display()
$cell = $this->cell('Taxonomy.TagCloud');

单元格只有在回显后才会被渲染。

参数

string $cell: 您必须指定单元格名称，并可以选择指定单元格操作。例如：TagCloud::smallList 将调用 View\Cell\TagCloudCell::smallList()，默认情况下将调用 display 操作，如果未提供操作。
array $data optional: 单元格方法的附加参数。例如：cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2']) 映射到 View\Cell\TagCloud::smallList(v1, v2)
array<string, mixed> $options optional: 单元格构造函数的选项

返回值

Cake\View\Cell

抛出

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

configShallow() ¶ public

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

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

设置特定值

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

设置嵌套值

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

同时更新多个配置设置

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

参数

array<string, mixed>|string $key: 要设置的键，或完整配置数组。
mixed|null $value optional: 要设置的值。

返回值

$this

contentType() ¶ public static

contentType(): string

此视图类渲染的 MIME 类型。

返回值

string

disableAutoLayout() ¶ public

disableAutoLayout(): $this

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

返回值

$this

dispatchEvent() ¶ public

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

创建和分派事件的包装器。

返回一个已派发的事件。

参数

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

返回值

Cake\Event\EventInterface<TSubject>

element() ¶ public

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

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

这实现了元素的概念（或“局部布局”），$params 数组用于发送将在元素中使用的数据。元素可以被缓存，使用 `cache` 选项来提高性能。

参数

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

返回值

string

抛出

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

elementExists() ¶ public

elementExists(string $name): bool

检查元素是否存在。

参数

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

返回值

bool

enableAutoLayout() ¶ public

enableAutoLayout(bool $enable = true): $this

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

参数

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

返回值

$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

返回配置。

用法

读取整个配置

$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

检索当前模板类型。

返回值

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 扩展名。

返回值

string

getLayoutPath() ¶ public

getLayoutPath(): string

获取布局文件的路径。

返回值

string

getLayoutPaths() ¶ protected

getLayoutPaths(string|null $plugin): Generator

获取布局路径的迭代器。

参数

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

返回值

生成器

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

获取此模板文件所在的子目录。

返回值

string

另请参阅

\Cake\View\View::$subDir

getTemplate() ¶ public

getTemplate(): string

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

返回值

string

getTemplatePath() ¶ public

getTemplatePath(): string

获取模板文件的路径。

返回值

string

getTheme() ¶ public

getTheme(): string|null

获取当前视图主题。

返回值

string|null

getVars() ¶ public

getVars(): list<string>

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

返回值

list<string>

helpers() ¶ public

helpers(): Cake\View\HelperRegistry

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

返回值

Cake\View\HelperRegistry

initialize() ¶ public

initialize(): void

初始化钩子方法。

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

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

返回值

void

isAutoLayoutEnabled() ¶ public

isAutoLayoutEnabled(): bool

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

返回值

bool

loadHelper() ¶ public

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

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

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

参数

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

返回值

Cake\View\Helper

另请参阅

\Cake\View\HelperRegistry::load()

loadHelpers() ¶ public

loadHelpers(): $this

仅在禁用序列化时加载助手。

返回值

$this

log() ¶ public

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

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

参数

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

返回值

$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 可选: 正在渲染的布局。

返回值

string

抛出

Cake\View\Exception\SerializationFailureException
当序列化失败时。

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

serializeKeys() ¶ protected

serializeKeys(): array|string|false

返回值

array|string|false

set() ¶ public

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

保存变量或关联变量数组，以便在模板中使用。

参数

array|string $name: 字符串或数据数组。
mixed $value optional: 如果 $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 optional: 要设置的值。
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

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

类型

bool

`$_current` ¶ protected

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

类型

string

`$_currentType` ¶ protected

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

类型

string

`$_defaultConfig` ¶ protected

默认配置选项。

在您的控制器中使用 ViewBuilder::setOption()/setOptions() 设置这些选项。

serialize: 将一组视图变量转换为序列化响应的选项。其值可以是字符串，用于单个变量名，也可以是数组，用于多个名称。如果为 true，所有视图变量都将被序列化。如果为 null 或 false，将渲染正常的视图模板。

类型

array<string, mixed>

`$_eventClass` ¶ protected

新事件对象的默认类名。

类型

string

`$_eventManager` ¶ protected

该对象用于分派内部事件的 Cake\Event\EventManager 的实例。

类型

Cake\Event\EventManagerInterface|null

`$_ext` ¶ protected

文件扩展名。默认为“.php”。

类型

string

`$_helpers` ¶ protected

助手集合

类型

Cake\View\HelperRegistry|null

`$_parents` ¶ protected

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

类型

array<string, string>

`$_passedVars` ¶ 受保护

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

类型

list<string>

`$_paths` ¶ 受保护

保存路径数组。

类型

list<string>

`$_pathsForPlugin` ¶ 受保护

保存插件路径数组。

类型

array<string, list<string>>

`$_stack` ¶ 受保护

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

类型

list<string>

`$_viewBlockClass` ¶ 受保护

ViewBlock 类。

类型

string

`$autoLayout` ¶ 受保护

启用或禁用 CakePHP 的传统模式，该模式用于应用布局文件。默认情况下启用。设置为关闭表示布局不会自动应用于渲染的模板。

类型

bool

`$elementCache` ¶ 受保护

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

类型

string

`$helpers` ¶ 受保护

用于加载助手的配置数组。

类型

array<string, array<string, mixed>>

`$layout` ¶ 受保护

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

类型

string

`$layoutPath` ¶ 受保护

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

类型

string

`$name` ¶ 受保护

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

类型

string

`$plugin` ¶ 受保护

插件的名称。

类型

string|null

`$request` ¶ 受保护

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

类型

Cake\Http\ServerRequest

`$response` ¶ 受保护

对 Response 对象的引用

类型

Cake\Http\Response

`$subDir` ¶ 受保护

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

类型

string

`$template` ¶ 受保护

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

类型

string

`$templatePath` ¶ 受保护

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

类型

string

`$theme` ¶ 受保护

要使用的视图主题。

类型

string|null

`$viewVars` ¶ 受保护

一个变量数组

类型

array<string, mixed>

命名空间

类 SerializedView

常量

属性摘要

方法摘要

__construct() public

__get() public

_checkFilePath() protected

_configDelete() protected

_configRead() protected

_configWrite() protected

_createCell() protected

_elementCache() protected

_evaluate() protected

_getElementFileName() protected

_getLayoutFileName() protected

_getSubPaths() protected

_getTemplateFileName() protected

_inflectTemplateFileName() protected

_paths() protected

_render() protected

_renderElement() protected

_serialize() abstract protected

addHelper() protected

append() public

assign() public

blocks() public

cache() public

cell() protected

configShallow() public

contentType() public static

disableAutoLayout() public

dispatchEvent() public

element() public

elementExists() public

enableAutoLayout() public

end() public

exists() public

extend() public

fetch() public

get() public

getConfig() public

getConfigOrFail() public

getCurrentType() public

getElementPaths() protected

getEventManager() public

getLayout() public

getLayoutPath() public

getLayoutPaths() protected

getName() public

getPlugin() public

getRequest() public

getResponse() public

getSubDir() public

getTemplate() public

getTemplatePath() public

getTheme() public

getVars() public

helpers() public

initialize() public

isAutoLayoutEnabled() public

loadHelper() public

loadHelpers() public

log() public

pluginSplit() public

prepend() public

render() public

renderLayout() public

reset() public

serializeKeys() protected

set() public

setConfig() public

setContentType() protected

setElementCache() public

setEventManager() public

setLayout() public

setLayoutPath() public

setPlugin() public

setRequest() public

setResponse() public