InputButton extends AbstractButton

This button type renders a HTML tag <button> and takes the HTML attributes name and value as additional attributes to those defined in AbstractButton.

public function __construct(
    protected readonly ComponentFactory $componentFactory,
) }

public function myAction(): ResponseInterface
{
    $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
    $saveButton = $this->componentFactory->createInputButton()
         ->setName('save')
         ->setValue('1')
         ->setIcon($this->iconFactory->getIcon('actions-document-save', IconSize::SMALL))
         ->setTitle('Save');
    $buttonBar->addButton($saveButton, ButtonBar::BUTTON_POSITION_LEFT, 1);
}

Table of Contents

Properties

$attributes  : array<string|int, mixed>

Attributes for the button

$classes  : string

CSS classes to apply to the rendered element

$dataAttributes  : array<string, string>

HTML data-* attributes for the control

$disabled  : bool

Whether the button is in disabled state

$form  : string

$icon  : Icon|null

Optional icon to display on the button

$name  : string

$showLabelText  : bool

Whether to show the button's label text (from title property).

$title  : string

Title/label text for the control

$value  : string

Methods

__toString()  : string

Implementation from ButtonInterface This object is an abstract, so no implementation is necessary

getAttributes()  : array<string, string>

getClasses()  : string

getDataAttributes()  : array<string|int, mixed>

getForm()  : string

getIcon()  : Icon|null

getName()  : string

getShowLabelText()  : bool

getTitle()  : string

getType()  : string

Returns the fully qualified class name as the component type identifier.

getValue()  : string

isDisabled()  : bool

isValid()  : bool

Implementation from ButtonInterface This object is an abstract, so no implementation is necessary

render()  : string

Implementation from ButtonInterface This object is an abstract, so no implementation is necessary

setAttributes()  : static

setClasses()  : static

setDataAttributes()  : static

setDisabled()  : static

setForm()  : static

setIcon()  : static

setName()  : static

setShowLabelText()  : static

setTitle()  : static

setValue()  : static