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

类构造函数

__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 渲染后的模板

在 head 块中添加一个自定义 HTML 字符串。

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 的实例，允许链式调用

在文档的 head 中添加 <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

inherited deprecated

自	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

inherited deprecated

自	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

inherited deprecated

自	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

inherited deprecated

自	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 文档 head 数据

getHeadData() : mixed||string|int

自	1.7.0

响应

array<string|int, mixed> 文档 head 数据，以数组形式

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

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

inherited static deprecated

自	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

响应

string|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: bool

响应

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

继承

自	1.7.0
抛出	`RuntimeException`

参数

type: string 渲染器类型

响应

RendererInterface

合并 HTML 文档 head 数据

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

自	1.7.0

参数

data: array<string|int, mixed> 文档 head 数据，以数组形式

响应

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

响应

void

将模板输出到浏览器。

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

自	1.7.0

参数

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

响应

string 渲染后的数据

重置 HTML 文档 head 数据

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

自	3.7.0

参数

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

响应

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

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

resetHeadDatum( type) :

自	3.7.0

参数

type: string 要重置的 head 元素的类型

响应

void

设置文档的基 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 要使用的缓存控制器工厂。

响应

void

设置文档的字符集

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 的实例，允许链式调用

设置工厂实例

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 文档 head 数据

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

自	1.7.0

参数

data: array<string|int, mixed> 文档 head 数据，以数组形式

响应

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

设置文档是否应输出为 HTML5

setHtml5( state) :

自	3.0.0

参数

状态: bool当应输出 HTML5 时为 True

响应

void

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

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

继承

自	1.7.0

参数

语言: string要设置的语言

响应

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

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

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

继承

自	1.7.0

参数

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

响应

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

设置文档链接

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

继承

自	1.7.0

参数

url: stringURL

响应

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

设置资产版本

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

继承

自	3.2

参数

媒体版本: 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
链接

参数

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

响应

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

设置文档修改日期

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

继承

自	1.7.0
抛出	`InvalidArgumentException`

参数

日期: string|Date要设置的日期

响应

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

设置预加载管理器

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

继承

自	4.0.0

参数

预加载管理器: 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

参数

标题: string要设置的标题

响应

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

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

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

自	5.0.0

参数

name: 字符串
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

类型

string|Date

制表符字符串

继承

自	1.7.0

类型

字符串

包含行尾字符串

继承

自	1.7.0

类型

字符串

包含字符编码字符串

继承

自	1.7.0

类型

字符串

文档 MIME 类型

继承

自	1.7.0

类型

字符串

文档命名空间

继承

自	1.7.0

类型

字符串

文档配置文件

继承

自	1.7.0

类型

字符串

链接脚本数组

inherited deprecated

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

类型

array<string|int, mixed>

放置在页眉中的脚本数组

inherited deprecated

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

类型

array<string|int, mixed>

脚本选项数组

继承

类型

array<string|int, mixed>

链接样式表数组

inherited deprecated

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

类型

array<string|int, mixed>

包含样式声明数组

inherited deprecated

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

类型

array<string|int, mixed>

元标签数组

继承

自	1.7.0

类型

array<string|int, mixed>

渲染引擎

继承

自	1.7.0

类型

对象

文档类型

继承

自	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

页眉 <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

类型

注册表

文件名

自	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

类型

bool

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

自	5.0.0

类型

array<string|int, Toolbar>

HtmlDocument

方法

__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