LinkButton extends AbstractButton

LinkButton

This button type renders a regular anchor tag with TYPO3s way to render a button control.

EXAMPLE USAGE TO ADD A BUTTON TO THE FIRST BUTTON GROUP IN THE LEFT BAR:

$buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar(); $saveButton = $buttonBar->makeLinkButton() ->setHref('#') ->setDataAttributes([ 'foo' => 'bar' ]) ->setIcon($this->iconFactory->getIcon('actions-document-save', IconSize::SMALL)) ->setTitle('Save'); $buttonBar->addButton($saveButton, ButtonBar::BUTTON_POSITION_LEFT, 1);

Table of Contents

Properties

$classes  : string
HTML tag attribute for class
$dataAttributes  : array<string|int, mixed>
HTML tag attributes for data-* Use key => value pairs
$disabled  : bool
Disabled state of the button
$href  : string
HREF attribute of the link
$icon  : Icon
Icon object
$showLabelText  : bool
Defines whether to show the title as a label within the button
$title  : string
HTML tag attribute for title

Methods

__toString()  : string
Magic method so Fluid can access a button via {button}
getClasses()  : string
Get classes
getDataAttributes()  : array<string|int, mixed>
Get Data attributes
getHref()  : string
Get href
getIcon()  : Icon
Get icon
getShowLabelText()  : bool
Show Label text
getTitle()  : string
Get Title
getType()  : string
Get type
isDisabled()  : bool
Check if button is disabled
isValid()  : bool
Validates the current button
render()  : string
Renders the markup for the button
setClasses()  : $this
Set classes
setDataAttributes()  : $this
Set Data attributes
setDisabled()  : AbstractButton
Set if button needs to be disabled
setHref()  : LinkButton
Set href
setIcon()  : $this
Set icon
setShowLabelText()  : $this
Show Label text
setTitle()  : $this
Set title attribute

Properties

$classes

HTML tag attribute for class

protected string $classes = ''

$dataAttributes

HTML tag attributes for data-* Use key => value pairs

protected array<string|int, mixed> $dataAttributes = []

$disabled

Disabled state of the button

protected bool $disabled = false

$href

HREF attribute of the link

protected string $href = ''

$showLabelText

Defines whether to show the title as a label within the button

protected bool $showLabelText = false

$title

HTML tag attribute for title

protected string $title = ''

Methods

__toString()

Magic method so Fluid can access a button via {button}

public __toString() : string
Return values
string

getClasses()

Get classes

public getClasses() : string
Return values
string

getDataAttributes()

Get Data attributes

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

getHref()

Get href

public getHref() : string
Return values
string

getShowLabelText()

Show Label text

public getShowLabelText() : bool
Return values
bool

getTitle()

Get Title

public getTitle() : string
Return values
string

getType()

Get type

public getType() : string
Return values
string

isDisabled()

Check if button is disabled

public isDisabled() : bool
Return values
bool

isValid()

Validates the current button

public isValid() : bool
Return values
bool

render()

Renders the markup for the button

public render() : string
Return values
string

setClasses()

Set classes

public setClasses(string $classes) : $this
Parameters
$classes : string

HTML class attribute to set

Return values
$this

setDataAttributes()

Set Data attributes

public setDataAttributes(array<string|int, mixed> $dataAttributes) : $this
Parameters
$dataAttributes : array<string|int, mixed>

HTML data attributes to set

Return values
$this

setIcon()

Set icon

public setIcon(Icon $icon) : $this
Parameters
$icon : Icon

Icon object for the button

Return values
$this

setShowLabelText()

Show Label text

public setShowLabelText(bool $showLabelText) : $this
Parameters
$showLabelText : bool
Return values
$this

setTitle()

Set title attribute

public setTitle(string $title) : $this
Parameters
$title : string

HTML title attribute to set

Return values
$this 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results