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

链接
自	4.0.0
包	Joomla CMS

类构造函数。

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

自	4.0.0

参数

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

响应

混合

映射到字符串。

__toString() :

自	4.0.0

响应

字符串

返回 lineEnd

_getLineEnd() :

继承

自	1.7.0

响应

字符串

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

_getTab() :

继承

自	1.7.0

响应

字符串

向输出添加链接。

addLink( key,  value) :

自	4.0.0

参数

键: string链接的名称
值: string链接

响应

$this

向输出添加链接。

addMeta( key,  value) :

自	4.0.0

参数

键: string元数据键的名称
值: string值

响应

$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。
选项: array<string|int, mixed>选项数组。示例：array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
属性: 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(...);

参数

内容: string脚本
类型: string脚本 mime（默认为 'text/javascript'）

响应

Document$this 的实例，允许链接

为脚本添加选项

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

继承

自	3.5

参数

键: string存储中的名称
选项: mixed脚本选项作为数组或字符串
合并: bool是否与现有选项合并（true）或替换（false）

响应

Document$this 的实例，允许链接

向页面添加样式表声明

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

继承已弃用

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

参数

内容: string样式声明
类型: 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
选项: array<string|int, mixed>选项数组。示例：array('version' => 'auto', 'conditional' => 'lt IE 9', 'preload' => array('preload'))
属性: array<string|int, mixed>属性数组。示例：array('id' => 'stylesheet', 'data-test' => 1)

响应

Document$this 的实例，允许链接

返回文档的基 URI。

getBase() :

继承

自	1.7.0

响应

字符串

获取文档缓冲区的内容

getBuffer() :

继承

自	1.7.0

响应

混合

返回文档字符集编码。

getCharset() :

继承

自	1.7.0

响应

字符串

返回文档描述。

getDescription() :

继承

自	1.7.0

响应

字符串

返回文档方向声明。

getDirection() :

继承

自	1.7.0

响应

字符串

返回文档生成器

getGenerator() :

继承

自	1.7.0

响应

字符串

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

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

继承静态已弃用

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

参数

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

响应

static文档对象。

返回文档语言。

getLanguage() :

继承

自	1.7.0

响应

字符串

返回文档基本 URL

getLink() :

继承

自	1.7.0

响应

字符串

返回媒体版本

getMediaVersion() :

继承

自	3.2

响应

字符串

获取元标签。

getMetaData( name,  attribute = 'name') :

继承

自	1.7.0

参数

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

响应

字符串

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

getMimeEncoding() :

继承

自	1.7.0

响应

字符串

返回文档修改日期

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

继承

自	1.7.0

响应

字符串|Date

返回文档名称

getName() :

继承

自	1.7.0

响应

字符串

返回预加载管理器

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

继承

自	4.0.0

响应

PreloadManagerInterface

获取脚本选项

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

继承

自	3.5

参数

键: string存储中的名称

响应

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

返回文档标题。

getTitle() :

继承

自	1.7.0

响应

字符串

返回文档类型

getType() :

继承

自	1.7.0

响应

字符串

返回 WebAsset 管理器

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

继承

自	4.0.0

响应

WebAssetManager

序列化以供 JSON 使用。

jsonSerialize() : mixed||string|int

自	4.0.0

响应

array<string|int, mixed>

加载渲染器

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

继承

自	1.7.0
抛出	`RuntimeException`

参数

类型: string渲染器类型

响应

RendererInterface

解析文档并准备缓冲区

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

继承

自	1.7.0

参数

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

响应

Document$this 的实例，允许链接

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

preloadAssets() :

继承

自	4.0.0

响应

空

输出文档。

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

自	4.0.0

参数

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

响应

string渲染后的数据。

设置文档的基 URI

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

继承

自	1.7.0

参数

基地: string要设置的基 URI

响应

Document$this 的实例，允许链接

设置文档缓冲区的内容

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

继承

自	1.7.0

参数

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

响应

Document$this 的实例，允许链接

设置文档字符集

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

继承

自	1.7.0

参数

类型: string字符集编码字符串

响应

Document$this 的实例，允许链接

设置数据对象。

setData(\Tobscure\JsonApi\ElementInterface element) :

自	4.0.0

参数

元素: ElementInterface元素接口。

响应

$this

设置文档描述

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

继承

自	1.7.0

参数

描述: string要设置的描述

响应

Document$this 的实例，允许链接

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

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

继承

自	1.7.0

参数

DIR: string要设置的语言方向

响应

Document$this 的实例，允许链接

设置错误数组。

setErrors(mixed||string|int errors) :

自	4.0.0

参数

错误: array<string|int, mixed>错误数组。

响应

$this

设置工厂实例

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

继承

自	4.0.0

参数

工厂: FactoryInterface工厂实例

响应

文档

设置文档生成器

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

继承

自	1.7.0

参数

发电机: string要设置的生成器

响应

Document$this 的实例，允许链接

设置 JSON-API 数组。

setJsonapi(mixed||string|int jsonapi) :

自	4.0.0

参数

jsonapi: array<string|int, mixed>JSON-API 数组。

响应

$this

设置全局文档语言声明。默认值为英语 (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

参数

风格: 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

参数

mediaVersion: string要使用的媒体版本

响应

Document$this 的实例，允许链接

设置或更改元标签。

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

继承

自	1.7.0

参数

名称: string元 HTML 标签的名称
内容: mixed元 HTML 标签的值作为数组或字符串
属性: 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
链接

参数

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

响应

Document$this 的实例，允许链接

设置文档修改日期

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

继承

自	1.7.0
抛出	`InvalidArgumentException`

参数

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

响应

Document$this 的实例，允许链接

设置文档名称

setName( name = 'joomla') : \Joomla\CMS\Document\JsonDocument

继承

自	1.7.0

参数

名称: string文档名称

响应

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

参数

标题: string要设置的标题

响应

Document$this 的实例，允许链接

设置文档类型

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

继承

自	1.7.0

参数

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

响应

Document$this 的实例，允许链接

设置 WebAsset 管理器

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

继承

自	4.0.0

参数

webAsset: WebAssetManagerWebAsset 实例

响应

文档

将所有内容映射到数组。

toArray() : mixed||string|int

自	4.0.0

响应

array<string|int, mixed>

文档标题

继承

自	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

类型

对象

文档类型

继承

自	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 资源实例

继承

自	4.0.0

类型

WebAssetManager

文档名称

继承

自	1.7.0

类型

字符串

JsonApi 文档对象。

自	4.0.0

类型

文档

JsonapiDocument

方法

__construct

参数

响应

__toString

响应

_getLineEnd

响应

_getTab

响应

addLink

参数

响应

addMeta

参数

响应

addScript

参数

响应

addScriptDeclaration

参数

响应

addScriptOptions

参数

响应

addStyleDeclaration

参数

响应

addStyleSheet

参数

响应

getBase

响应

getBuffer

响应

getCharset

响应

getDescription

响应

getDirection

响应

getGenerator

响应

getInstance

参数

响应

getLanguage

响应

getLink

响应

getMediaVersion

响应

getMetaData

参数

响应

getMimeEncoding

响应

getModifiedDate

响应

getName

响应

getPreloadManager

响应

getScriptOptions

参数

响应

getTitle

响应

getType

响应

getWebAssetManager

响应

jsonSerialize

响应

loadRenderer

参数

响应

parse

参数