Joomla! API

下载
启动

ImageDocument

扩展 Document

ImageDocument 类，提供了一个用于输出图像数据的简单接口。

自

3.0.0
包

Joomla CMS

方法

__construct

类构造函数

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

3.0.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 = []) :
继承 static 已弃用
自

1.7.0
已弃用

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

参数

type

string要实例化的文档类型。

attributes

array<string|int, mixed>属性数组。

响应

static文档对象。

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 = []) :
自

3.0.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

stringURL。

响应

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

缓冲输出数组。

继承 static
自

1.7.0

类型

mixed

instances

文档实例容器。

继承 static
自

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 Asset 实例。

继承
自

4.0.0

类型

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