Joomla! API

下载
启动

DropdownButton

扩展 AbstractGroupButton

呈现下拉按钮。

自

4.0.0
包

Joomla CMS

方法

__call

Magiix 方法，用于调整选项访问器。

__call( name, mixed||string|int args) :
继承
抛出

LogicException
自

4.0.0

参数

name

string方法名称。

args

array<string|int, mixed>方法参数。

响应

mixed

__construct

初始化此类。

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

4.0.0
抛出

InvalidArgumentException

参数

name

string此按钮的名称。

text

string按钮文本，将自动翻译。

options

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

响应

mixed

attributes

attributes(mixed||string|int value) :
继承

参数

value

array<string|int, mixed>

响应

self

buttonClass

buttonClass( value) :
继承

参数

value

string

响应

self

configure

将子按钮添加为下拉菜单。

configure(
Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768
|Array handler) :
继承
自

4.0.0

参数

handler

callable配置下拉项目回调。

响应

static

ensureUniqueId

确保 id 是唯一的

ensureUniqueId( id) :
继承
自

4.0.0

参数

id

stringid 字符串。

响应

string

fetchButton

获取按钮的 HTML

fetchButton( type = 'Basic') :
inherited deprecated
自

3.0
已弃用

4.3 将在 6.0 中移除，请改用 render()。
抛出

LogicException

参数

type

string未使用字符串。

响应

void

fetchIconClass

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

fetchIconClass( identifier) :
继承

可以在最终类中重新定义

自

3.0

参数

identifier

string图标标识字符串

响应

stringCSS 类名称

fetchId

获取按钮 CSS Id。

fetchId() :
自

4.0.0

响应

string按钮 CSS Id

findOptionName

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

findOptionName( name) : bool|string
inherited static
自

4.0.0

参数

name

string字段名称。

响应

bool|string

form

form( value) :
继承

参数

value

string

响应

self

formValidation

formValidation( value) :
继承

参数

value

bool

响应

self

getAccessors

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

getAccessors() : mixed||string|int
static
自

4.0.0

响应

array<string|int, mixed>

getAttributes

getAttributes() : mixed||string|int
继承

响应

array<string|int, mixed>

getButtonClass

getButtonClass() :
继承

响应

string

getChildToolbar

获取子工具栏。

getChildToolbar() : \Joomla\CMS\Toolbar\Toolbar
继承
自

4.0.0

响应

Toolbar返回新的子工具栏实例。

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如果此名称不存在，则为默认值。

响应

mixed

getOptions

获取按钮选项。

getOptions() : mixed||string|int
继承
自

4.0.0

响应

array<string|int, mixed>

getParent

获取父工具栏实例。

getParent() : \Joomla\CMS\Toolbar\Toolbar
继承
自

4.0.0

响应

Toolbar

getTask

getTask() :
继承

响应

string

getText

getText() :
继承

响应

string

getToggleButtonClass

getToggleButtonClass() :

响应

string

getToggleSplit

getToggleSplit() :

响应

bool

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
抛出

Exception

参数

options

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

响应

void

render

获取用于呈现按钮的 HTML

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

3.0
抛出

Exception

参数

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) :
继承
自

4.0.0

参数

parent

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

响应

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

task

task( value) :
继承

参数

value

string

响应

self

text

text( value) :
继承

参数

value

string

响应

self

toggleButtonClass

toggleButtonClass( value) :

参数

value

string

响应

self

toggleSplit

toggleSplit( value) :

参数

value

bool

响应

self

属性

name

此按钮的名称。

继承
自

4.0.0

类型

string

parent

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

继承
自

4.0.0

类型

Toolbar

layout

属性 layout。

自

4.0.0

类型

string

options

按钮选项。

继承
自

4.0.0

类型

array<string|int, mixed>

idCounter

用于跟踪 id，以避免重复

inherited static
自

4.0.0

类型

array<string|int, mixed>

child

子工具栏实例。

继承
自

4.0.0

类型

Toolbar
  • \ Joomla
  • \ CMS
  • \ Toolbar
  • \ Button
  • \ DropdownButton