Sidebar

用于渲染列表视图侧边栏的实用程序类

抽象
自版本

3.0

Joomla CMS

方法

addEntry

用于向子菜单添加菜单项的方法。

addEntry( name,  link = '',  active = false) : 
静态
自版本

3.0

参数

name

string菜单项的名称。

link

string菜单项的 URL。

active

bool如果项目处于活动状态,则为真,否则为假。

返回值

void

addFilter

用于向子菜单添加过滤器的方

addFilter( label,  name,  options,  noDefault = false) : 
静态
自版本

3.0

参数

label

string菜单项的标签。

name

string过滤器的名称。也用作 ID。

options

string选择字段的选项。

noDefault

bool不显示标签作为空选项

返回值

void

getAction

获取过滤器表单的 action 属性的值

getAction() : 
静态
自版本

3.0

返回值

string

getEntries

返回所有子菜单条目的数组

getEntries() : mixed||string|int
静态
自版本

3.0

返回值

array<string|int, mixed>

getFilters

返回所有过滤器的数组

getFilters() : mixed||string|int
静态
自版本

3.0

返回值

array<string|int, mixed>

render

渲染侧边栏。

render() : 
静态
自版本

3.0

返回值

string显示侧边栏所需的 HTML

setAction

设置过滤器表单的 action 属性的值

setAction( action) : 
静态
自版本

3.0

参数

action

string表单的 action 属性的值

返回值

void

属性

entries

菜单项

静态
自版本

3.0

类型

array<string|int, mixed>

filters

过滤器

静态
自版本

3.0

类型

array<string|int, mixed>

action

表单的 action 属性的值。

静态
自版本

3.0

类型

string