PublishedButton
扩展 ActionButtonPublishedButton 类。
自从 |
4.0.0 |
---|---|
包 |
Joomla CMS |
方法
__construct
ActionButton 构造函数。
__construct(mixed||string|int options = []) :
自从 |
4.0.0 |
---|
参数
- options
array<string|int, mixed>
此组中所有按钮的选项。
响应
mixed
__toString
渲染为字符串。
__toString() :
自从 |
4.0.0 |
---|
响应
string
addState
添加状态配置文件。
addState( value, task, icon = 'ok', title = '', mixed||string|int options = []) :
自从 |
4.0.0 |
---|
参数
- value
int
此状态的值。- task
string
单击此按钮后要执行的任务。- icon
string
要显示给用户的图标。- title
string
如果启用工具提示,则将显示标题文本。- options
array<string|int, mixed>
按钮选项,将覆盖组选项。
响应
static
返回自身以支持链式调用。
fetchIconClass
用于获取图标标识符的 CSS 类名称的方法。
fetchIconClass( identifier) :
可以在最终类中重新定义。
自从 |
4.0.0 |
---|
参数
- identifier
string
图标标识字符串。
响应
string
CSS 类名称。
getLayout
用于获取属性 layout 的方法。
getLayout() :
自从 |
4.0.0 |
---|
响应
string
getOption
获取选项值。
getOption( name, default = null) :
自从 |
4.0.0 |
---|
参数
- name
string
选项名称。- default
mixed
如果不存在,则为默认值。
响应
mixed
返回选项值或默认值。
getOptions
用于获取属性 options 的方法。
getOptions() : mixed||string|int
自从 |
4.0.0 |
---|
响应
array<string|int, mixed>
getState
按值名称获取状态配置文件。
getState( value) : array|null
自从 |
4.0.0 |
---|
参数
- value
int
我们要获取的值名称。
响应
array<string|int, mixed>|null
返回状态配置文件或 NULL。
preprocess
配置此对象。
preprocess() :
自从 |
4.0.0 |
---|
响应
void
removeState
按值名称删除状态。
removeState( value) :
自从 |
4.0.0 |
---|
参数
- value
int
按此值删除状态。
响应
static
返回以支持链式调用。
render
按项目值渲染操作按钮。
render(int|null value = null, int|null row = null, mixed||string|int options = [], string|\Joomla\CMS\Date\Date publishUp = null, string|\Joomla\CMS\Date\Date publishDown = null) :
setLayout
用于设置属性模板的方法。
setLayout( layout) :
自从 |
4.0.0 |
---|
参数
- layout
string
布局路径。
响应
static
返回自身以支持链式调用。
setOption
设置选项值。
setOption( name, value) :
自从 |
4.0.0 |
---|
参数
- name
string
选项名称。- value
mixed
选项值。
响应
static
返回自身以支持链式调用。
setOptions
用于设置属性 options 的方法。
setOptions(mixed||string|int options) :
自从 |
4.0.0 |
---|
参数
- options
array<string|int, mixed>
此按钮组的选项。
响应
static
返回自身以支持链式调用。
属性
states
按钮状态配置文件。
自从 |
4.0.0 |
---|
类型
array<string|int, mixed>
unknownState
未知状态的默认选项。
自从 |
4.0.0 |
---|
类型
array<string|int, mixed>
options
此按钮集的选项。
自从 |
4.0.0 |
---|
类型
注册表
layout
要渲染的布局路径。
自从 |
4.0.0 |
---|
类型
string