Joomla! API

下载
启动

AbstractView

实现 ViewInterface, DispatcherAwareInterface, DocumentAwareInterface, LanguageAwareInterface

Joomla 视图的基类

抽象

包含用于显示展示数据的类的类。

自

2.5.5
包

Joomla CMS

方法

__construct

构造函数

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

3.0

参数

config

array<string|int, mixed> 用于对象构造的命名配置数组。name: 视图的名称（可选），默认为视图类名称的后缀。charset: 用于显示的字符集 escape: 用于转义字符串的函数名称（可选） base_path: 视图目录的父路径（可选），默认为组件文件夹 template_plath: 布局目录的路径（可选），默认为 base_path + /views/ + 视图名称 helper_path: 帮助器文件的路径（可选），默认为 base_path + /helpers/ layout: 用于显示视图的布局（可选）

响应

混合

def

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

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

1.7.0
已弃用

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

参数

属性

string 属性的名称。

默认

mixed 默认值。

响应

混合

dispatchEvent

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

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

4.1.0
已弃用

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

参数

事件

EventInterface 事件

响应

void

display

执行并显示模板脚本。

display( tpl = null) :
抽象
自

3.0

参数

tpl

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

响应

void

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 如果未设置文档，可能会抛出。

响应

文档

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 如果未设置语言，可能会抛出。

响应

语言

getModel

获取模型对象的方法

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

3.0

参数

name

string 模型的名称（可选）

响应

BaseDatabaseModel 模型对象

getName

获取视图名称的方法

getName() :

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

自

3.0
抛出

异常

响应

string 模型的名称

getProperties

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

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

1.7.0
见 CMSObject::get()
已弃用

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

参数

public

bool 如果为真，则仅返回公共属性。

响应

array<string|int, mixed>

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

语言

继承
自

4.4.0

类型

语言

document

活动的文档对象

已弃用
自

3.0
已弃用

4.4.0 将在 6.0 中删除 代替使用 $this->getDocument()

类型

文档

option

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

自

3.0

类型

string

_name

视图的名称

自

3.0

类型

string

_models

注册的模型

自

3.0

类型

array<string|int, mixed>

_defaultModel

默认模型

自

3.0

类型

string
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ View
  • \ AbstractView