Joomla! CMS 5.1.x API » \Joomla\CMS\Document\ErrorDocument

类构造函数

__construct(mixed||string|int options = []) :

自	1.7.0

参数

options: array<string|int, mixed>属性的关联数组

响应

混合

获取模板并初始化参数

_fetchTemplate(mixed||string|int params = []) : \Joomla\CMS\Document\HtmlDocument

继承

自	1.7.0

参数

params: array<string|int, mixed>确定模板的参数

响应

HtmlDocument$this 的实例，允许链式调用

返回 lineEnd

_getLineEnd() :

继承

自	1.7.0

响应

字符串

返回一个包含 HTML 缩进单位的字符串

_getTab() :

继承

自	1.7.0

响应

字符串

加载模板文件

_loadTemplate( directory,  filename) :

继承

自	1.7.0

参数

directory: string模板的名称
filename: string实际的文件名

响应

string模板的内容

解析文档模板

_parseTemplate() : \Joomla\CMS\Document\HtmlDocument

继承

自	1.7.0

响应

HtmlDocument$this 的实例，允许链式调用

渲染预解析的模板

_renderTemplate() :

继承

自	1.7.0

响应

string渲染后的模板

将自定义 HTML 字符串添加到 head 块

addCustomTag( html) : \Joomla\CMS\Document\HtmlDocument

继承

自	1.7.0

参数

html: string要添加到 head 的 HTML

响应

HtmlDocument$this 的实例，允许链式调用

添加快捷图标 (favicon)

addFavicon( href,  type = 'image/vnd.microsoft.icon',  relation = 'icon') : \Joomla\CMS\Document\HtmlDocument

继承

这会在收藏夹列表中或地址栏中 URL 左侧显示的图标添加一个链接。一些浏览器也会在选项卡上显示它。

自	1.7.0

参数

href: string正在关联的链接。
type: string文件类型
relation: string链接的关系

响应

HtmlDocument$this 的实例，允许链式调用

将 <link> 标签添加到文档的头部

addHeadLink( href,  relation,  relType = 'rel', mixed||string|int attribs = []) : \Joomla\CMS\Document\HtmlDocument

继承

$relType 默认为 'rel'，因为它是使用最常见的关联类型。（'rev' 指反向关联，'rel' 指正常的前向关联。）典型标签： <link href="index.php" rel="Start">

自	1.7.0

参数

href: string正在关联的链接。
relation: string链接的关系。
relType: string关系类型属性。rel 或 rev（默认：'rel'）。
attribs: array<string|int, mixed>其余属性的关联数组。

响应

HtmlDocument$this 的实例，允许链式调用

将链接的脚本添加到页面

addScript( url, mixed||string|int options = [], mixed||string|int attribs = []) : \Joomla\CMS\Document\Document

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中移除使用 WebAssetManager 示例：$wa->registerAndUseScript(...);

参数

url: string链接脚本的 URL。
options: array<string|int, mixed>选项数组。示例：array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
attribs: array<string|int, mixed>属性数组。示例：array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

响应

Document$this 的实例，允许链式调用

将脚本添加到页面

addScriptDeclaration( content,  type = 'text/javascript') : \Joomla\CMS\Document\Document

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中移除使用 WebAssetManager 示例：$wa->addInlineScript(...);

参数

content: string脚本
type: string脚本 mime（默认为 'text/javascript'）

响应

Document$this 的实例，允许链式调用

添加脚本选项

addScriptOptions( key,  options,  merge = true) : \Joomla\CMS\Document\Document

继承

自	3.5

参数

key: string存储中的名称
options: mixed脚本选项，可以是数组或字符串
merge: bool是否与现有选项合并 (true) 或替换 (false)

响应

Document$this 的实例，允许链式调用

将样式表声明添加到页面

addStyleDeclaration( content,  type = 'text/css') : \Joomla\CMS\Document\Document

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中移除使用 WebAssetManager 示例：$wa->addInlineStyle(...);

参数

content: string样式声明
type: string样式表类型（默认为 'text/css'）

响应

Document$this 的实例，允许链式调用

将链接的样式表添加到页面

addStyleSheet( url, mixed||string|int options = [], mixed||string|int attribs = []) : \Joomla\CMS\Document\Document

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中移除使用 WebAssetManager 示例：$wa->registerAndUseStyle(...);

参数

url: string链接样式表的 URL
options: array<string|int, mixed>选项数组。示例：array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
attribs: array<string|int, mixed>属性数组。示例：array('id' => 'stylesheet', 'data-test' => 1)

响应

Document$this 的实例，允许链式调用

计算当前活动菜单项的子菜单项数量

countMenuChildren() :

继承已弃用

自	1.7.0
已弃用	4.4 将在 6.0 中移除直接加载活动菜单项并使用 php count 函数计算子项 `$children = count($app->getMenu()->getActive()->getChildren())` 注意 getActive 可能为 `null`

响应

int子菜单项的数量

计算给定位置的模块数量

countModules( positionName,  withContentOnly = false) :

继承

自	1.7.0

参数

positionName: string要使用的位置
withContentOnly: bool仅计算实际包含内容的模块

响应

int找到的模块数量

返回文档的基本 URI。

getBase() :

继承

自	1.7.0

响应

字符串

获取文档包含的内容

getBuffer( type = null,  name = null, mixed||string|int attribs = []) : mixed|string

继承

自	1.7.0

参数

type: string渲染器的类型
name: string要渲染的元素的名称
attribs: array<string|int, mixed>其余属性的关联数组。

响应

mixed|string渲染器的输出

获取 CacheControllerFactoryInterface。

getCacheControllerFactory() : \Joomla\CMS\Cache\CacheControllerFactoryInterface

继承

自	4.2.0

响应

CacheControllerFactoryInterface

返回文档字符集编码。

getCharset() :

继承

自	1.7.0

响应

字符串

返回文档的描述。

getDescription() :

继承

自	1.7.0

响应

字符串

返回文档的方向声明。

getDirection() :

继承

自	1.7.0

响应

字符串

返回文档生成器

getGenerator() :

继承

自	1.7.0

响应

字符串

获取 HTML 文档头部数据

getHeadData() : mixed||string|int

继承

自	1.7.0

响应

array<string|int, mixed>以数组形式表示的文档头部数据

返回全局 Document 对象，仅在它不存在时创建它。

getInstance( type = 'html', mixed||string|int attributes = []) :

继承静态已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中移除使用 \Joomla\CMS\Document\FactoryInterface 代替示例：Factory::getApplication()->getDocument();

参数

type: string要实例化的文档类型
attributes: array<string|int, mixed>属性数组

响应

static文档对象。

返回文档语言。

getLanguage() :

继承

自	1.7.0

响应

字符串

返回文档的基本 URL

getLink() :

继承

自	1.7.0

响应

字符串

返回媒体版本

getMediaVersion() :

继承

自	3.2

响应

字符串

获取元标签。

getMetaData( name,  attribute = 'name') :

继承

自	1.7.0

参数

name: string元 HTML 标签的名称
attribute: string要在元 HTML 标签中使用的属性

响应

字符串

返回发送到浏览器的文档 MIME 编码。

getMimeEncoding() :

继承

自	1.7.0

响应

字符串

返回文档修改日期

getModifiedDate() : string|\Joomla\CMS\Date\Date

继承

自	1.7.0

响应

字符串|Date

返回预加载管理器

getPreloadManager() : \Joomla\CMS\Document\PreloadManagerInterface

继承

自	4.0.0

响应

PreloadManagerInterface

获取脚本选项

getScriptOptions( key = null) : mixed||string|int

继承

自	3.5

参数

key: string存储中的名称

响应

array<string|int, mixed>给定 $key 的选项，或所有脚本选项

返回文档的标题。

getTitle() :

继承

自	1.7.0

响应

字符串

返回工具栏对象或 null

getToolbar( toolbar = 'toolbar',  create = true) : \Joomla\CMS\Toolbar\Toolbar

继承

自	5.0.0

参数

toolbar: 字符串
create: 布尔

响应

Toolbar|null

返回工具栏数组

getToolbars() : mixed||string|int

继承

自	5.0.0

响应

array<string|int, mixed>

返回文档类型

getType() :

继承

自	1.7.0

响应

字符串

返回 WebAsset 管理器

getWebAssetManager() : \Joomla\CMS\WebAsset\WebAssetManager

继承

自	4.0.0

响应

WebAssetManager

返回文档是否设置为以 HTML5 输出

isHtml5() :

继承

自	3.0.0

响应

bool使用 HTML5 时为 true

加载渲染器

loadRenderer( type) : \Joomla\CMS\Document\RendererInterface

自	4.0.0
抛出	`RuntimeException`

参数

type: string渲染器类型

响应

RendererInterface

合并 HTML 文档头部数据

mergeHeadData(mixed||string|int data) : \Joomla\CMS\Document\HtmlDocument

继承

自	1.7.0

参数

data: array<string|int, mixed>以数组形式表示的文档头部数据

响应

HtmlDocument$this 的实例，允许链式调用

解析模板并填充缓冲区

parse(mixed||string|int params = []) : \Joomla\CMS\Document\HtmlDocument

继承

自	1.7.0

参数

params: array<string|int, mixed>获取模板的参数

响应

HtmlDocument$this 的实例，允许链式调用

为配置为预加载的资源生成 Link 标头

preloadAssets() :

继承

自	4.0.0

响应

空

渲染文档

render( cache = false, mixed||string|int params = []) :

自	1.7.0

参数

cache: bool如果为 true，则缓存输出
params: array<string|int, mixed>属性的关联数组

响应

string渲染后的数据

渲染回溯

renderBacktrace() :

自	1.7.0

响应

string回溯的内容

重置 HTML 文档头部数据

resetHeadData( types = null) : \Joomla\CMS\Document\HtmlDocument

继承

自	3.7.0

参数

types: mixed要重置的头部元素的类型或类型

响应

HtmlDocument$this 的实例，允许链式调用

重置 HTML 文档头部数据的一部分

resetHeadDatum( type) :

继承

自	3.7.0

参数

type: string要重置的头部元素的类型

响应

空

设置文档的基本 URI

setBase( base) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

base: string要设置的基本 URI

响应

Document$this 的实例，允许链式调用

设置文档包含的内容

setBuffer( content, mixed||string|int options = []) : \Joomla\CMS\Document\HtmlDocument

继承

自	1.7.0

参数

content: string要设置在缓冲区中的内容。
options: array<string|int, mixed>可选元素的数组。

响应

HtmlDocument$this 的实例，允许链式调用

设置要使用的缓存控制器工厂。

setCacheControllerFactory(\Joomla\CMS\Cache\CacheControllerFactoryInterface cacheControllerFactory = null) :

继承

自	4.2.0

参数

cacheControllerFactory: CacheControllerFactoryInterface要使用的缓存控制器工厂。

响应

空

设置文档字符集

setCharset( type = 'utf-8') : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

type: string字符集编码字符串

响应

Document$this 的实例，允许链式调用

设置文档的描述

setDescription( description) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

description: string要设置的描述

响应

Document$this 的实例，允许链式调用

设置全局文档方向声明。默认值为从左到右 (ltr)。

setDirection( dir = 'ltr') : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

dir: string要设置的语言方向

响应

Document$this 的实例，允许链式调用

设置错误对象

setError(\Throwable error) :

自	1.7.0

参数

error: Throwable要设置的错误对象

响应

bool成功时为 True

设置工厂实例

setFactory(\Joomla\CMS\Document\FactoryInterface factory) : \Joomla\CMS\Document\Document

继承

自	4.0.0

参数

factory: FactoryInterface工厂实例

响应

Document

设置文档生成器

setGenerator( generator) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

generator: string要设置的生成器

响应

Document$this 的实例，允许链式调用

设置 HTML 文档头部数据

setHeadData(mixed||string|int data) : \Joomla\CMS\Document\HtmlDocument|null

继承

自	1.7.0

参数

data: array<string|int, mixed>以数组形式表示的文档头部数据

响应

HtmlDocument|null$this 的实例以允许链式调用，或对于空输入数据则为 null

设置文档是否应输出为 HTML5

setHtml5( state) :

继承

自	3.0.0

参数

state: bool当应输出 HTML5 时为 True

响应

空

设置全局文档语言声明。默认值为英语 (en-gb)。

setLanguage( lang = 'en-gb') : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

lang: string要设置的语言

响应

Document$this 的实例，允许链式调用

将行尾样式设置为 Windows、Mac、Unix 或自定义字符串。

setLineEnd( style) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

style: string“win”、“mac”、“unix”或自定义字符串。

响应

Document$this 的实例，允许链式调用

设置文档链接

setLink( url) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

url: string一个 URL

响应

Document$this 的实例，允许链式调用

设置资源版本

setMediaVersion( mediaVersion) : \Joomla\CMS\Document\Document

继承

自	3.2

参数

mediaVersion: string要使用的媒体版本

响应

Document$this 的实例，允许链式调用

设置或更改元标记。

setMetaData( name,  content,  attribute = 'name') : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

name: string元 HTML 标签的名称
content: mixed作为数组或字符串的元 HTML 标记的值
attribute: string要在元 HTML 标签中使用的属性

响应

Document$this 的实例，允许链式调用

设置发送到浏览器的文档 MIME 编码。

setMimeEncoding( type = 'text/html',  sync = true) : \Joomla\CMS\Document\Document

继承

这通常将是 text/html，因为大多数浏览器尚无法接受 XHTML 的正确 mime 设置：application/xhtml+xml 以及在较小程度上 application/xml 和 text/xml。有关更多详细信息，请参阅 W3C 说明（{@link https://www.w3.org/TR/xhtml-media-types/}）。

自	1.7.0
link

参数

type: string要发送的文档类型
sync: bool类型是否应与 HTML 同步？

响应

Document$this 的实例，允许链式调用

设置文档修改日期

setModifiedDate(string|\Joomla\CMS\Date\Date date) : \Joomla\CMS\Document\Document

继承

自	1.7.0
抛出	`InvalidArgumentException`

参数

date: string|Date要设置的日期

响应

Document$this 的实例，允许链式调用

设置预加载管理器

setPreloadManager(\Joomla\CMS\Document\PreloadManagerInterface preloadManager) : \Joomla\CMS\Document\Document

继承

自	4.0.0

参数

preloadManager: PreloadManagerInterface预加载管理器服务

响应

Document$this 的实例，允许链式调用

设置用于缩进 HTML 的字符串

setTab( string) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

字符串: string用于缩进的字符串（“\11”、“\t”、“ ”等）。

响应

Document$this 的实例，允许链式调用

设置文档标题

setTitle( title) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

title: string要设置的标题

响应

Document$this 的实例，允许链式调用

添加新的或替换现有的工具栏对象

setToolbar( name, \Joomla\CMS\Toolbar\Toolbar toolbar) :

继承

自	5.0.0

参数

name: 字符串
toolbar: Toolbar

响应

$this

设置文档类型

setType( type) : \Joomla\CMS\Document\Document

继承

自	1.7.0

参数

type: string要设置为的文档类型

响应

Document$this 的实例，允许链式调用

设置 WebAsset 管理器

setWebAssetManager(\Joomla\CMS\WebAsset\WebAssetManager webAsset) : \Joomla\CMS\Document\Document

继承

自	4.0.0

参数

webAsset: WebAssetManagerWebAsset 实例

响应

Document

文档标题

继承

自	1.7.0

类型

字符串

文档描述

继承

自	1.7.0

类型

字符串

文档完整 URL

继承

自	1.7.0

类型

字符串

文档基本 URL

继承

自	1.7.0

类型

字符串

包含文档语言设置

继承

自	1.7.0

类型

字符串

包含文档方向设置

继承

自	1.7.0

类型

字符串

文档生成器

继承

自	1.7.0

类型

字符串

文档修改日期

继承

自	1.7.0

类型

字符串|Date

制表符字符串

继承

自	1.7.0

类型

字符串

包含行尾字符串

继承

自	1.7.0

类型

字符串

包含字符编码字符串

继承

自	1.7.0

类型

字符串

文档 MIME 类型

继承

自	1.7.0

类型

字符串

文档命名空间

继承

自	1.7.0

类型

字符串

文档配置文件

继承

自	1.7.0

类型

字符串

链接脚本数组

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中删除使用 WebAssetManager

类型

array<string|int, mixed>

放置在头部中的脚本数组

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中删除使用 WebAssetManager

类型

array<string|int, mixed>

脚本选项数组

继承

类型

array<string|int, mixed>

链接样式表数组

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中删除使用 WebAssetManager

类型

array<string|int, mixed>

包含的样式声明数组

继承已弃用

自	1.7.0
已弃用	4.3 将在 6.0 中删除使用 WebAssetManager

类型

array<string|int, mixed>

元标记数组

继承

自	1.7.0

类型

array<string|int, mixed>

渲染引擎

继承

自	1.7.0

类型

object

文档类型

继承

自	1.7.0

类型

字符串

缓冲输出数组

继承静态

自	1.7.0

类型

混合

文档实例容器。

继承静态

自	1.7.3

类型

array<string|int, mixed>

添加到资源的媒体版本

继承

自	3.2

类型

字符串

用于创建 JDocument API 对象的工厂

继承

自	4.0.0

类型

FactoryInterface

预加载管理器

继承

自	4.0.0

类型

PreloadManagerInterface

支持的预加载类型

继承

自	4.0.0

类型

array<string|int, mixed>

Web Asset 实例

继承

自	4.0.0

类型

WebAssetManager

CacheControllerFactoryInterface

继承

自	4.2.0

类型

CacheControllerFactoryInterface

Header <link> 标记数组

继承

自	1.7.0

类型

array<string|int, mixed>

自定义标记数组

继承

自	1.7.0

类型

array<string|int, mixed>

模板名称

继承

自	1.7.0

类型

字符串

基本 URL

继承

自	1.7.0

类型

字符串

模板参数注册表

继承

自	1.7.0

类型

Registry

文件名

继承

自	1.7.0

类型

array<string|int, mixed>

脚本 nonce（如果设置则为字符串，否则为 null）

继承

自	4.0.0

类型

string|null

保存已解析模板的字符串

继承

自	1.7.0

类型

字符串

已解析模板 JDoc 标记数组

继承

自	1.7.0

类型

array<string|int, mixed>

包含缓存设置的整数

继承

自	1.7.0

类型

int

当文档应输出为 HTML5 时设置为 true

继承

自	4.0.0

类型

布尔

类型为 \Joomla\CMS\Toolbar\Toolbar 的列表

继承

自	5.0.0

类型

array<string|int, Toolbar>

调试模式是否已启用的标志

自	1.7.0

类型

布尔

错误对象

自	1.7.0

类型

Throwable

错误对象

自	1.7.0

类型

Throwable

ErrorDocument

方法

__construct

参数

响应

_fetchTemplate

参数

响应

_getLineEnd

响应

_getTab

响应

_loadTemplate

参数

响应

_parseTemplate

响应

_renderTemplate

响应

addCustomTag

参数

响应

addFavicon

参数

响应

addHeadLink

参数

响应

addScript

参数

响应

addScriptDeclaration

参数

响应

addScriptOptions

参数

响应

addStyleDeclaration

参数

响应

addStyleSheet

参数

响应

countMenuChildren

响应

countModules

参数

响应

getBase

响应

getBuffer

参数

响应

getCacheControllerFactory

响应

getCharset

响应

getDescription

响应

getDirection

响应

getGenerator

响应

getHeadData

响应

getInstance

参数

响应

getLanguage

响应

getLink

响应

getMediaVersion

响应

getMetaData

参数

响应

getMimeEncoding

响应

getModifiedDate