Joomla! API

下载
启动

JsonApiView

继承自 JsonView

Joomla Json 列表视图的基类

抽象

包含用于显示演示数据的方法的类。

自

4.0.0
包

Joomla CMS

方法

__construct

构造函数。

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

4.0.0

参数

config

array<string|int, mixed>用于对象构造的命名配置数组。contentType：要用于序列化的内容类型的名称（可选）

响应

mixed

def

如果尚未分配，则设置默认值

def( property,  default = null) :
继承 已弃用
自

1.7.0
已弃用

4.3.0 将在 6.0 中删除 不应再使用定义动态属性

参数

属性

string属性的名称。

默认值

mixed默认值。

响应

mixed

dispatchEvent

在内部调度器上分派给定的事件，回退到全局调度器。

dispatchEvent(\Joomla\Event\EventInterface event) :
继承 已弃用
自

4.1.0
已弃用

4.4 将在 6.0 中删除。直接使用 $this->getDispatcher()。

参数

事件

EventInterface事件

响应

void

display

执行并显示模板脚本。

display( tpl = null) :
继承
自

4.0.0

参数

tpl

string要解析的模板文件的名称；自动搜索模板路径。

响应

void

displayItem

执行并显示模板脚本。

displayItem( item = null) :
自

4.0.0

参数

item

object项目

响应

string

displayList

执行并显示模板脚本。

displayList(array|null items = null) :
自

4.0.0

参数

items

array<string|int, mixed>|null项目数组

响应

string

get

从注册的模型或视图属性中获取数据的方法

get( property,  default = null) :
继承
自

3.0

参数

属性

string要对模型调用的方法的名称或要获取的属性

默认值

string要引用的模型的名称或默认值 [可选]

响应

mixed方法的返回值

getDispatcher

获取事件调度器。

getDispatcher() : \Joomla\Event\DispatcherInterface
继承

为了保持对旧组件的向后兼容性而进行了覆盖。TODO：在 6.0 中删除覆盖

自

4.4.0
抛出

UnexpectedValueException如果未设置调度器，则可能会抛出。

响应

DispatcherInterface

getDocument

获取文档。

getDocument() : \Joomla\CMS\Document\Document
继承
自

4.4.0
抛出

UnexpectedValueException如果未设置文档，则可能会抛出。

响应

Document

getError

获取最新的错误消息。

getError( i = null,  toString = true) :
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除 将被删除而不会被替换 捕获抛出的异常，而不是 getError

参数

i

int可选错误索引。

toString

bool指示 Exception 对象是否应返回其错误消息。

响应

string错误消息

getErrors

返回所有错误（如果有）。

getErrors() : mixed||string|int
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除 将被删除而不会被替换 捕获抛出的异常，而不是 getErrors

响应

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

getLanguage

获取语言。

getLanguage() : \Joomla\CMS\Language\Language
继承
自

4.4.0
抛出

UnexpectedValueException如果未设置语言，则可能会抛出。

响应

Language

getModel

用于获取模型对象的方法

getModel( name = null) : \Joomla\CMS\MVC\Model\BaseDatabaseModel
继承
自

3.0

参数

name

string模型的名称（可选）

响应

BaseDatabaseModel模型对象

getName

用于获取视图名称的方法

getName() :
继承

模型名称默认情况下使用类名解析，也可以通过在类构造函数中传递 $config['name'] 来设置

自

3.0
抛出

Exception

响应

string模型的名称

getProperties

返回对象属性的关联数组。

getProperties( public = true) : mixed||string|int
继承 已弃用
自

1.7.0
参见 CMSObject::get()
已弃用

4.3.0 将在 6.0 中删除 为属性创建适当的 getter 函数

参数

public

bool如果为 true，则仅返回公有属性。

响应

array<string|int, mixed>

prepareItem

在渲染之前准备项目。

prepareItem( item) :
自

4.0.0

参数

item

object模型项目

响应

object

queryEncode

根据 JSON API 规范，对 URI 查询中的方括号进行编码。

queryEncode( query) :
自

4.0.0

参数

query

stringURI 查询

响应

string

set

修改对象的属性，如果该属性不存在则创建它。

set( property,  value = null) :
继承 已弃用
自

1.7.0
已弃用

4.3.0 将在 6.0 中删除 为属性创建适当的 setter 函数

参数

属性

string属性的名称。

value

mixed要设置的属性的值。

响应

mixed属性的先前值。

setDocument

设置要使用的文档。

setDocument(\Joomla\CMS\Document\Document document) :
继承
自

4.4.0

参数

document

Document要使用的文档

响应

void

setError

添加错误消息。

setError( error) :
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除 将被删除而不会被替换 抛出异常，而不是使用 setError

参数

error

string错误消息。

响应

void

setLanguage

设置要使用的语言。

setLanguage(\Joomla\CMS\Language\Language language) :
继承
自

4.4.0

参数

language

Language要使用的语言

响应

void

setModel

用于向视图添加模型的方法。我们支持多个模型单视图系统，通过该系统，模型以类名引用。类名引用的一个注意事项是，以 \JModel 为前缀的任何类名都将以不带 \JModel 的名称引用，例如 \JModelCategory 只是 Category。

setModel(\Joomla\CMS\MVC\Model\BaseDatabaseModel model,  default = false) : \Joomla\CMS\MVC\Model\BaseDatabaseModel
继承
自

3.0

参数

model

BaseDatabaseModel要添加到视图的模型。

默认值

bool这是默认模型吗？

响应

BaseDatabaseModel添加的模型。

setProperties

根据命名数组/散列设置对象属性。

setProperties( properties) :
继承 已弃用
自

1.7.0
参见 CMSObject::set()
已弃用

4.3.0 将在 6.0 中删除 为属性创建适当的 setter 函数

参数

properties

mixed关联数组或其他对象。

响应

bool

属性

_errors

错误消息或 Exception 对象的数组。

继承 已弃用
自

1.7.0
已弃用

3.1.4 JError 已弃用

类型

array<string|int, mixed>

language

Language

继承
自

4.4.0

类型

Language

document

活动文档对象（重新声明用于类型提示）

自

3.0

类型

JsonapiDocument

option

组件的 URL 选项。它通常由控制器在创建视图时传递

继承
自

3.0

类型

string

_name

视图的名称

继承
自

3.0

类型

string

_models

注册的模型

继承
自

3.0

类型

array<string|int, mixed>

_defaultModel

默认模型

继承
自

3.0

类型

string

_basePath

视图的基路径

继承
自

4.0.0

类型

string

_charset

在转义机制中使用的字符集；默认为 urf8 (UTF-8)

继承
自

4.0.0

类型

string

_output

视图的输出。

继承
自

4.0.0

类型

array<string|int, mixed>

type

内容类型

类型

string

relationship

项目关系

自

4.0.0

类型

array<string|int, mixed>

serializer

序列化器数据

自

4.0.0

类型

AbstractSerializer

fieldsToRenderItem

要在文档中渲染项目的字段

自

4.0.0

类型

array<string|int, mixed>

fieldsToRenderList

要在文档中渲染项目的字段

自

4.0.0

类型

array<string|int, mixed>
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ View
  • \ JsonApiView