Joomla! CMS 5.1.x API » \Joomla\CMS\Toolbar\Button\HelpButton

Magiix 方法以适应选项访问器。

__call( name, mixed||string|int args) :

继承

抛出	`LogicException`
自	4.0.0

参数

name: string方法名称。
args: array<string|int, mixed>方法参数。

响应

mixed

初始化此类。

__construct( name = '',  text = '', mixed||string|int options = []) :

继承

自	4.0.0
抛出	`InvalidArgumentException`

参数

name: string此按钮的名称。
text: string按钮文本，将自动翻译。
options: array<string|int, mixed>按钮选项。

响应

mixed

获取按钮的 JavaScript 命令

_getCommand() :

自	3.0

响应

stringJavaScript 命令字符串

attributes(mixed||string|int value) :

继承

参数

value: array<string|int, mixed>

响应

self

buttonClass( value) :

继承

参数

value: string

响应

self

component( value) :

参数

value: string

响应

self

确保 ID 唯一

ensureUniqueId( id) :

继承

自	4.0.0

参数

id: stringID 字符串。

响应

string

获取按钮 HTML 代码。

fetchButton( type = 'Help',  ref = '',  com = false,  override = null,  component = null) :

已弃用

自	3.0
已弃用	4.3 将在 6.0 中移除使用 render() 代替。

参数

type: string未使用的字符串。
ref: string帮助屏幕的名称（其键引用）。
com: bool使用组件目录中的帮助文件。
override: string使用此 URL 而不是任何其他 URL。
component: string获取帮助的组件名称（当前组件为 null）

响应

string

获取图标标识符的 CSS 类名称的方法

fetchIconClass( identifier) :

继承

可以在最终类中重新定义

自	3.0

参数

identifier: string图标识别字符串

响应

stringCSS 类名称

获取按钮 CSS ID。

fetchId() :

继承

自	3.0

响应

string按钮 CSS ID

从访问器查找字段选项名称。

findOptionName( name) : bool|string

继承静态

自	4.0.0

参数

name: string字段名称。

响应

bool|string

form( value) :

继承

参数

value: string

响应

self

formValidation( value) :

继承

参数

value: bool

响应

self

配置可用选项访问器的方法。

getAccessors() : mixed||string|int

静态

自	4.0.0

响应

array<string|int, mixed>

getAttributes() : mixed||string|int

继承

响应

array<string|int, mixed>

getButtonClass() :

继承

响应

string

getComponent() :

响应

string

getForm() :

继承

响应

string

getFormValidation() :

继承

响应

bool

getIcon() :

继承

响应

string

获取布局路径。

getLayout() :

继承

自	4.0.0

响应

string

getListCheck() :

继承

响应

bool

getListCheckMessage() :

继承

响应

string

获取按钮名称。

getName() :

继承

自	4.0.0

响应

string

getOnclick() :

继承

响应

string

获取单个选项值。

getOption( name,  default = null) :

继承

自	4.0.0

参数

name: string选项名称。
default: mixed如果此名称不存在，则为默认值。

响应

mixed

获取按钮选项。

getOptions() : mixed||string|int

继承

自	4.0.0

响应

array<string|int, mixed>

获取父工具栏实例。

getParent() : \Joomla\CMS\Toolbar\Toolbar

继承

自	4.0.0

响应

Toolbar

getRef() :

响应

string

getTask() :

继承

响应

string

getText() :

继承

响应

string

getUrl() :

响应

string

getUseComponent() :

响应

bool

icon( value) :

继承

参数

value: string

响应

self

设置布局路径。

layout( layout) :

继承

自	4.0.0

参数

layout: string要渲染的布局路径名称。

响应

static返回 self 以支持链式调用。

listCheck( value) :

继承

参数

value: bool

响应

self

listCheckMessage( value) :

继承

参数

value: string

响应

self

设置按钮名称。

name( name) :

继承

自	4.0.0

参数

name: string按钮名称。

响应

static返回 self 以支持链式调用。

onclick( value) :

继承

参数

value: string

响应

self

准备此按钮的选项。

prepareOptions(mixed||string|int &options) :

自	4.0.0

参数

options: array<string|int, mixed>关于此按钮的选项。

响应

void

ref( value) :

参数

value: string

响应

self

获取渲染按钮的 HTML

render(mixed||string|int &definition = null) :

继承

自	3.0
抛出	`Exception`

参数

definition: array<string|int, mixed>要传递的参数

响应

string

渲染按钮 HTML。

renderButton(mixed||string|int &options) :

继承

自	4.0.0

参数

options: array<string|int, mixed>按钮选项。

响应

string按钮 HTML。

设置选项值。

setOption( name,  value) :

继承

自	4.0.0

参数

name: string要存储值的选项名称。
value: mixed选项值。

响应

静态

设置所有选项。

setOptions(mixed||string|int options) :

继承

自	4.0.0

参数

options: array<string|int, mixed>按钮选项。

响应

static返回 self 以支持链式调用。

设置父工具栏实例。

setParent(\Joomla\CMS\Toolbar\Toolbar parent) :

继承

自	4.0.0

参数

parent: Toolbar要设置的父工具栏实例。

响应

static返回 self 以支持链式调用。

task( value) :

继承

参数

value: string

响应

self

text( value) :

继承

参数

value: string

响应

self

url( value) :

参数

value: string

响应

self

useComponent( value) :

参数

value: bool

响应

self

此按钮的名称。

继承

自	4.0.0

类型

string

对实例化元素的对象的引用

继承

自	4.0.0

类型

Toolbar

属性布局。

继承

自	4.0.0

类型

string

按钮选项。

继承

自	4.0.0

类型

array<string|int, mixed>

用于跟踪 ID，以避免重复

继承静态

自	4.0.0

类型

array<string|int, mixed>