Joomla! API

下载
启动

Document

Document 类，提供了一个解析和显示文档的简单接口

自版本

1.7.0
包

Joomla CMS

方法

__construct

类构造函数。

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

1.7.0

参数

options

array<string|int, mixed>选项的关联数组

返回值

mixed

_getLineEnd

返回 lineEnd

_getLineEnd() :
自版本

1.7.0

返回值

string

_getTab

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

_getTab() :
自版本

1.7.0

返回值

string

addScript

向页面添加链接脚本

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

向页面添加脚本

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

添加脚本选项

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

3.5

参数

key

string存储中的名称

options

mixed脚本选项，可以是数组或字符串

merge

bool是否与现有选项合并 (true) 或替换 (false)

返回值

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

addStyleDeclaration

向页面添加样式表声明

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

向页面添加链接样式表

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

getBase

返回文档的基本 URI。

getBase() :
自版本

1.7.0

返回值

string

getBuffer

获取文档缓冲区的内容

getBuffer() :
自版本

1.7.0

返回值

mixed

getCharset

返回文档字符集编码。

getCharset() :
自版本

1.7.0

返回值

string

getDescription

返回文档的描述。

getDescription() :
自版本

1.7.0

返回值

string

getDirection

返回文档的方向声明。

getDirection() :
自版本

1.7.0

返回值

string

getGenerator

返回文档生成器

getGenerator() :
自版本

1.7.0

返回值

string

getInstance

返回全局 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>属性数组

返回值

静态文档对象。

getLanguage

返回文档语言。

getLanguage() :
自版本

1.7.0

返回值

string

getLink

返回文档的基本 URL

getLink() :
自版本

1.7.0

返回值

string

getMediaVersion

返回媒体版本

getMediaVersion() :
自版本

3.2

返回值

string

getMetaData

获取元标记。

getMetaData( name,  attribute = 'name') :
自版本

1.7.0

参数

name

string元 HTML 标记的名称

attribute

string要在元 HTML 标记中使用的属性

返回值

string

getMimeEncoding

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

getMimeEncoding() :
自版本

1.7.0

返回值

string

getModifiedDate

返回文档修改日期

getModifiedDate() : string|\Joomla\CMS\Date\Date
自版本

1.7.0

返回值

string|Date

getPreloadManager

返回预加载管理器

getPreloadManager() : \Joomla\CMS\Document\PreloadManagerInterface
自版本

4.0.0

返回值

PreloadManagerInterface

getScriptOptions

获取脚本选项

getScriptOptions( key = null) : mixed||string|int
自版本

3.5

参数

key

string存储中的名称

返回值

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

getTitle

返回文档的标题。

getTitle() :
自版本

1.7.0

返回值

string

getType

返回文档类型

getType() :
自版本

1.7.0

返回值

string

getWebAssetManager

返回 WebAsset 管理器

getWebAssetManager() : \Joomla\CMS\WebAsset\WebAssetManager
自版本

4.0.0

返回值

WebAssetManager

loadRenderer

加载渲染器

loadRenderer( type) : \Joomla\CMS\Document\RendererInterface
自版本

1.7.0
抛出

RuntimeException

参数

type

string渲染器类型

返回值

RendererInterface

parse

解析文档并准备缓冲区

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

1.7.0

参数

params

array<string|int, mixed>参数数组

返回值

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

preloadAssets

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

preloadAssets() :
自版本

4.0.0

返回值

void

render

输出文档

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

1.7.0

参数

cache

bool如果为 true，则缓存输出

params

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

返回值

string渲染后的数据

setBase

设置文档的基本 URI

setBase( base) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

base

string要设置的基本 URI

返回值

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

setBuffer

设置文档缓冲区的内容

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

1.7.0

参数

content

string要设置到缓冲区中的内容。

options

array<string|int, mixed>可选元素的数组。

返回值

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

setCharset

设置文档字符集

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

1.7.0

参数

type

string字符集编码字符串

返回值

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

setDescription

设置文档的描述

setDescription( description) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

description

string要设置的描述

返回值

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

setDirection

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

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

1.7.0

参数

dir

string要设置的语言方向

返回值

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

setFactory

设置工厂实例

setFactory(\Joomla\CMS\Document\FactoryInterface factory) : \Joomla\CMS\Document\Document
自版本

4.0.0

参数

factory

FactoryInterface工厂实例

返回值

Document

setGenerator

设置文档生成器

setGenerator( generator) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

generator

string要设置的生成器

返回值

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

setLanguage

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

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

1.7.0

参数

lang

string要设置的语言

返回值

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

setLineEnd

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

setLineEnd( style) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

style

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

返回值

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

setLink

设置文档链接

setLink( url) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

url

string一个 URL

返回值

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

setMediaVersion

设置资源版本

setMediaVersion( mediaVersion) : \Joomla\CMS\Document\Document
自版本

3.2

参数

mediaVersion

string要使用的媒体版本

返回值

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

setMetaData

设置或更改元标记。

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

1.7.0

参数

name

string元 HTML 标记的名称

content

mixed元 HTML 标记的值，可以是数组或字符串

attribute

string要在元 HTML 标记中使用的属性

返回值

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

setMimeEncoding

设置发送到浏览器的文档 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

设置文档修改日期

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

1.7.0
抛出

InvalidArgumentException

参数

date

string|Date要设置的日期

返回值

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

setPreloadManager

设置预加载管理器

setPreloadManager(\Joomla\CMS\Document\PreloadManagerInterface preloadManager) : \Joomla\CMS\Document\Document
自版本

4.0.0

参数

preloadManager

PreloadManagerInterface预加载管理器服务

返回值

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

setTab

设置用于缩进 HTML 的字符串

setTab( string) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

string

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

返回值

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

setTitle

设置文档的标题

setTitle( title) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

title

string要设置的标题

返回值

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

setType

设置文档类型

setType( type) : \Joomla\CMS\Document\Document
自版本

1.7.0

参数

type

string要设置为文档的类型

返回值

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

setWebAssetManager

设置 WebAsset 管理器

setWebAssetManager(\Joomla\CMS\WebAsset\WebAssetManager webAsset) : \Joomla\CMS\Document\Document
自版本

4.0.0

参数

webAsset

WebAssetManagerWebAsset 实例

返回值

Document

属性

title

文档标题

自版本

1.7.0

类型

string

description

文档描述

自版本

1.7.0

类型

string

link

文档完整 URL

自版本

1.7.0

类型

string

base

文档基本 URL

自版本

1.7.0

类型

string

language

包含文档语言设置

自版本

1.7.0

类型

string

direction

包含文档方向设置

自版本

1.7.0

类型

string

_generator

文档生成器

自版本

1.7.0

类型

string

_mdate

文档修改日期

自版本

1.7.0

类型

string|Date

_tab

制表符字符串

自版本

1.7.0

类型

string

_lineEnd

包含行结束字符串

自版本

1.7.0

类型

string

_charset

包含字符编码字符串

自版本

1.7.0

类型

string

_mime

文档 MIME 类型

自版本

1.7.0

类型

string

_namespace

文档命名空间

自版本

1.7.0

类型

string

_profile

文档配置文件

自版本

1.7.0

类型

string

_scripts

链接脚本数组

已弃用
自版本

1.7.0
已弃用

4.3 将在 6.0 中移除 使用 WebAssetManager

类型

array<string|int, mixed>

_script

放置在页眉中的脚本数组

已弃用
自版本

1.7.0
已弃用

4.3 将在 6.0 中移除 使用 WebAssetManager

类型

array<string|int, mixed>

scriptOptions

脚本选项数组

类型

array<string|int, mixed>

_styleSheets

链接样式表数组

已弃用
自版本

1.7.0
已弃用

4.3 将在 6.0 中移除 使用 WebAssetManager

类型

array<string|int, mixed>

_style

包含的样式声明数组

已弃用
自版本

1.7.0
已弃用

4.3 将在 6.0 中移除 使用 WebAssetManager

类型

array<string|int, mixed>

_metaTags

元标记数组

自版本

1.7.0

类型

array<string|int, mixed>

_engine

渲染引擎

自版本

1.7.0

类型

object

_type

文档类型

自版本

1.7.0

类型

string

_buffer

缓冲输出数组

静态
自版本

1.7.0

类型

mixed

instances

文档实例容器。

静态
自版本

1.7.3

类型

array<string|int, mixed>

mediaVersion

添加到资源的媒体版本

自版本

3.2

类型

string

factory

用于创建 JDocument API 对象的工厂

自版本

4.0.0

类型

FactoryInterface

preloadManager

预加载管理器

自版本

4.0.0

类型

PreloadManagerInterface

preloadTypes

支持的预加载类型

自版本

4.0.0

类型

array<string|int, mixed>

webAssetManager

Web 资源实例

自版本

4.0.0

类型

WebAssetManager
  • \ Joomla
  • \ CMS
  • \ Document
  • \ Document