ToolbarButton
ToolbarButton 类。
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__call
Magiix 方法用于适应选项访问器。
__call( name, mixed||string|int args) :
| 抛出 |
|
|---|---|
| 自 |
4.0.0 |
参数
- name
string方法名称。- args
array<string|int, mixed>方法参数。
响应
混合
__construct
初始化此类。
__construct( name = '', text = '', mixed||string|int options = []) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string此按钮的名称。- text
string按钮文本，将自动翻译。- options
array<string|int, mixed>按钮选项。
响应
混合
attributes
attributes(mixed||string|int value) :
参数
- value
array<string|int, mixed>
响应
self
buttonClass
buttonClass( value) :
参数
- value
string
响应
self
ensureUniqueId
确保 ID 唯一
ensureUniqueId( id) :
| 自 |
4.0.0 |
|---|
参数
- id
stringID 字符串。
响应
string
fetchButton
获取按钮
fetchButton() :
在最终按钮类中定义
| 自 |
3.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除，请改用 render()。 |
响应
string
fetchIconClass
用于获取图标标识符的 CSS 类名称的方法
fetchIconClass( identifier) :
可以在最终类中重新定义
| 自 |
3.0 |
|---|
参数
- identifier
string图标标识字符串
响应
stringCSS 类名称
fetchId
获取按钮 CSS ID。
fetchId() :
| 自 |
3.0 |
|---|
响应
string按钮 CSS ID
findOptionName
从访问器中查找字段选项名称。
findOptionName( name) : bool|string
| 自 |
4.0.0 |
|---|
参数
- name
string字段名称。
响应
bool|string
form
form( value) :
参数
- value
string
响应
self
formValidation
formValidation( value) :
参数
- value
bool
响应
self
getAccessors
用于配置可用选项访问器的方法。
getAccessors() : mixed||string|int
| 自 |
4.0.0 |
|---|
响应
array<string|int, mixed>
getAttributes
getAttributes() : mixed||string|int
响应
array<string|int, mixed>
getButtonClass
getButtonClass() :
响应
string
getForm
getForm() :
响应
string
getFormValidation
getFormValidation() :
响应
bool
getIcon
getIcon() :
响应
string
getLayout
获取布局路径。
getLayout() :
| 自 |
4.0.0 |
|---|
响应
string
getListCheck
getListCheck() :
响应
bool
getListCheckMessage
getListCheckMessage() :
响应
string
getName
获取按钮名称。
getName() :
| 自 |
4.0.0 |
|---|
响应
string
getOnclick
getOnclick() :
响应
string
getOption
获取单个选项值。
getOption( name, default = null) :
| 自 |
4.0.0 |
|---|
参数
- name
string选项名称。- default
mixed如果此名称不存在，则为默认值。
响应
混合
getOptions
获取按钮选项。
getOptions() : mixed||string|int
| 自 |
4.0.0 |
|---|
响应
array<string|int, mixed>
getTask
getTask() :
响应
string
getText
getText() :
响应
string
icon
icon( value) :
参数
- value
string
响应
self
layout
设置布局路径。
layout( layout) :
| 自 |
4.0.0 |
|---|
参数
- layout
string要渲染的布局路径名称。
响应
static返回 self 以支持链接。
listCheck
listCheck( value) :
参数
- value
bool
响应
self
listCheckMessage
listCheckMessage( value) :
参数
- value
string
响应
self
name
设置按钮名称。
name( name) :
| 自 |
4.0.0 |
|---|
参数
- name
string按钮名称。
响应
static返回 self 以支持链接。
onclick
onclick( value) :
参数
- value
string
响应
self
prepareOptions
准备此按钮的选项。
prepareOptions(mixed||string|int &options) :
| 自 |
4.0.0 |
|---|
参数
- options
array<string|int, mixed>有关此按钮的选项。
响应
void
render
获取用于渲染按钮的 HTML
render(mixed||string|int &definition = null) :
| 自 |
3.0 |
|---|---|
| 抛出 |
|
参数
- definition
array<string|int, mixed>要传递的参数
响应
string
renderButton
渲染按钮 HTML。
renderButton(mixed||string|int &options) :
| 自 |
4.0.0 |
|---|
参数
- options
array<string|int, mixed>按钮选项。
响应
string按钮 HTML。
setOption
设置选项值。
setOption( name, value) :
| 自 |
4.0.0 |
|---|
参数
- name
string要存储值的选项名称。- value
mixed选项值。
响应
static
setOptions
设置所有选项。
setOptions(mixed||string|int options) :
| 自 |
4.0.0 |
|---|
参数
- options
array<string|int, mixed>按钮选项。
响应
static返回 self 以支持链接。
setParent
设置父工具栏实例。
setParent(\Joomla\CMS\Toolbar\Toolbar parent) :
task
task( value) :
参数
- value
string
响应
self
text
text( value) :
参数
- value
string
响应
self
属性
name
此按钮的名称。
| 自 |
4.0.0 |
|---|
类型
string
layout
用于渲染此按钮的布局路径。
| 自 |
4.0.0 |
|---|
类型
string
options
按钮选项。
| 自 |
4.0.0 |
|---|
类型
array<string|int, mixed>
idCounter
用于跟踪 ID，以避免重复
| 自 |
4.0.0 |
|---|
类型
array<string|int, mixed>