Joomla! API

下载
启动

CategoryView

扩展自 HtmlView

类别列表的基类 HTML 视图

自

3.2
包

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：用于显示视图的布局（可选）

响应

混合

_addPath

将模板和资源的搜索路径添加到搜索路径中。

_addPath( type,  path) :
继承
自

3.0

参数

类型

string要添加的路径类型。

path

mixed要搜索的目录或流，或二者的数组。

响应

空

_createFileName

创建资源的文件名

_createFileName( type, mixed||string|int parts = []) :
继承
自

3.0

参数

类型

string要为其创建文件名的资源类型

parts

array<string|int, mixed>包含文件名信息的关联数组

响应

string文件名

_setPath

设置模板或资源的整个搜索路径数组。

_setPath( type,  path) :
继承
自

3.0

参数

类型

string要设置的路径类型，通常为“template”。

path

mixed新的搜索路径，或搜索路径的数组。如果为 null 或 false，则重置为仅当前目录。

响应

空

addFeed

方法是将替代供稿链接添加到类别布局。

addFeed() :
自

3.2

响应

空

addHelperPath

按 LIFO 顺序将帮助器脚本路径添加到堆栈中。

addHelperPath( path) :
继承
自

3.0

参数

path

mixed目录路径或路径数组。

响应

空

addTemplatePath

按 LIFO 顺序将视图脚本路径添加到堆栈中。

addTemplatePath( path) :
继承
自

3.0

参数

path

mixed目录路径或路径数组。

响应

空

commonCategoryDisplay

具有类别列表显示中使用的常用显示元素的方法

commonCategoryDisplay() :
自

3.2

响应

空

def

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

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

1.7.0
已弃用

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

参数

property

string属性的名称。

default

mixed默认值。

响应

混合

dispatchEvent

在内部调度程序上调度给定的事件，并在全局调度程序上执行回退。

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

4.1.0
已弃用

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

参数

event

EventInterface事件

响应

空

display

执行并显示模板脚本。

display( tpl = null) :
自

3.2
抛出

异常

参数

tpl

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

响应

空

escape

转义视图脚本中输出的值。

escape( var) :
继承

如果转义机制为 htmlspecialchars，请使用 {@link $_charset} 设置。

注意

ENT_COMPAT 标志已在 Joomla 4.0 中替换为 ENT_QUOTES，以同时转义单引号
自

3.0

参数

var

mixed要转义的输出。

响应

mixed转义的值。

get

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

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

3.0

参数

property

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

default

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

响应

mixed方法的返回值

getCurrentUser

返回当前用户，如果未设置，则返回全局应用程序的身份。这将在 6.0 中更改，并将返回空用户。

getCurrentUser() : \Joomla\CMS\User\User
继承
自

4.2.0

响应

用户

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指示异常对象是否应返回其错误消息。

响应

string错误消息

getErrors

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

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

1.7.0
已弃用

3.1.4 将在 6.0 中删除 将在没有替换的情况下删除 而是捕获抛出的异常而不是 getErrors

响应

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

getForm

返回表单对象

getForm() :
继承
自

3.2

响应

mixed成功时为 \JForm 对象，失败时为 false

getLanguage

获取语言。

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

4.4.0
抛出

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

响应

语言

getLayout

获取布局。

getLayout() :
继承
自

3.0

响应

string布局名称

getLayoutTemplate

获取布局模板。

getLayoutTemplate() :
继承
自

3.0

响应

string布局模板名称

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如果为 true，则仅返回公共属性。

响应

array<string|int, mixed>

loadHelper

加载帮助器文件

loadHelper( hlp = null) :
继承
自

3.0

参数

hlp

string帮助器源文件的名称 自动搜索帮助器路径并根据需要进行编译。

响应

空

loadTemplate

加载模板文件 - 首先查看模板文件夹中的覆盖

loadTemplate( tpl = null) :
继承
自

3.0
抛出

异常

参数

tpl

string模板源文件的名称；自动搜索模板路径并根据需要进行编译。

响应

string模板脚本的输出。

prepareDocument

方法是准备文档

prepareDocument() :
自

3.2

响应

空

set

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

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

1.7.0
已弃用

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

参数

property

string属性的名称。

value

mixed要设置的属性的值。

响应

mixed属性的先前值。

setCurrentUser

设置当前用户。

setCurrentUser(\Joomla\CMS\User\User currentUser) :
继承
自

4.2.0

参数

currentUser

User当前用户对象

响应

空

setDocument

设置要使用的文档。

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

4.4.0

参数

document

Document要使用的文档

响应

空

setDocumentTitle

根据全局配置选项设置文档标题

setDocumentTitle( title) :
继承
自

3.6

参数

title

string页面标题

响应

空

setError

添加错误消息。

setError( error) :
继承 已弃用
自

1.7.0
已弃用

3.1.4 将在 6.0 中删除 将在没有替换的情况下删除 而是抛出异常而不是使用 setError

参数

error

string错误消息。

响应

空

setLanguage

设置要使用的语言。

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

4.4.0

参数

language

Language要使用的语言

响应

空

setLayout

设置要使用的布局名称

setLayout( layout) :
继承
自

3.0

参数

layout

string布局名称或格式的字符串