contao-community-alliance/dc-general
Back to top  

Class BaseButtonEvent.

This event is the base for all button events for the Contao 2 backend view.

 Methods

Get the HTML attributes for the button.

getAttributes() : string

Returns

string

Get the HTML code for the button.

getHtml() : string

Returns

string

Get the action key/name for the button.

getKey() : string

Returns

string

Get the button label text.

getLabel() : string

Returns

string

Get the button title.

getTitle() : string

Returns

string

Set the HTML attributes for the button.

setAttributes(string $attributes) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
This might be a string like: 'onclick="foo" style="float:left;"' etc.
fluent This method is part of a fluent interface and will return the same instance

Parameters

$attributes

string

The attributes to be used.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

Set the HTML code for the button.

setHtml(string $html) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
fluent This method is part of a fluent interface and will return the same instance

Parameters

$html

string

The HTML code.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

Set the key/name for the button.

setKey(string $key) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

string

The key/name to use.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

Set the button label text.

setLabel(string $label) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
fluent This method is part of a fluent interface and will return the same instance

Parameters

$label

string

The label text to use.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

Set the button title.

setTitle(string $title) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
fluent This method is part of a fluent interface and will return the same instance

Parameters

$title

string

The title text.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

 Properties

 

The html attributes to use for the button.

$attributes : string
 

The Html code to use for this button.

$html : string
 

The key/name of the button.

$key : string
 

The label to use for the button.

$label : string
 

The title to use for the button.

$title : string

 Constants

 

The name of the event.

NAME