ButtonBar
Bar holding the buttons
Table of Contents
Constants
- BUTTON_POSITION_LEFT = 'left'
- Identifier for the left button bar
- BUTTON_POSITION_RIGHT = 'right'
- Identifier for the right button bar
Properties
- $buttons : array<string|int, mixed>
- Internal array of all registered buttons
Methods
- addButton() : $this
- Add button
- getButtons() : array<string|int, mixed>
- Returns an associative array of all buttons in the form of ButtonPosition > ButtonGroup > Button
- makeButton() : ButtonInterface
- Creates a new button of the given type
- makeDropDownButton() : DropDownButton
- Creates a new DropDownButton
- makeFullyRenderedButton() : FullyRenderedButton
- Creates a new FullyRenderedButton
- makeInputButton() : InputButton
- Creates a new InputButton
- makeLinkButton() : LinkButton
- Creates a new LinkButton
- makeShortcutButton() : ShortcutButton
- Creates a new ShortcutButton
- makeSplitButton() : SplitButton
- Creates a new SplitButton
Constants
BUTTON_POSITION_LEFT
Identifier for the left button bar
public
mixed
BUTTON_POSITION_LEFT
= 'left'
BUTTON_POSITION_RIGHT
Identifier for the right button bar
public
mixed
BUTTON_POSITION_RIGHT
= 'right'
Properties
$buttons
Internal array of all registered buttons
protected
array<string|int, mixed>
$buttons
= []
Methods
addButton()
Add button
public
addButton(ButtonInterface $button[, string $buttonPosition = self::BUTTON_POSITION_LEFT ][, int $buttonGroup = 1 ]) : $this
Parameters
- $button : ButtonInterface
-
The Button Object to add
- $buttonPosition : string = self::BUTTON_POSITION_LEFT
-
Position of the button (left/right)
- $buttonGroup : int = 1
-
Buttongroup of the button
Tags
Return values
$thisgetButtons()
Returns an associative array of all buttons in the form of ButtonPosition > ButtonGroup > Button
public
getButtons() : array<string|int, mixed>
Return values
array<string|int, mixed>makeButton()
Creates a new button of the given type
public
makeButton(string $button) : ButtonInterface
Parameters
- $button : string
-
ButtonClass to invoke. Must implement ButtonInterface
Tags
Return values
ButtonInterfacemakeDropDownButton()
Creates a new DropDownButton
public
makeDropDownButton() : DropDownButton
Return values
DropDownButtonmakeFullyRenderedButton()
Creates a new FullyRenderedButton
public
makeFullyRenderedButton() : FullyRenderedButton
Return values
FullyRenderedButtonmakeInputButton()
Creates a new InputButton
public
makeInputButton() : InputButton
Return values
InputButtonmakeLinkButton()
Creates a new LinkButton
public
makeLinkButton() : LinkButton
Return values
LinkButtonmakeShortcutButton()
Creates a new ShortcutButton
public
makeShortcutButton() : ShortcutButton
Return values
ShortcutButtonmakeSplitButton()
Creates a new SplitButton
public
makeSplitButton() : SplitButton