TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton:

Public Member Functions
	setTag (string $tag)
	getTag ()
	getIcon ()
	setIcon (?Icon $icon)
	getLabel ()
	setLabel (?string $label)
	getTitle ()
	setTitle (?string $title)
	getHref ()
	setHref (?string $href)
	getClasses ()
	setClasses (string $classes)
	setAttributes (array $attributes)
	getShowLabelText ()
	setShowLabelText (bool $showLabelText)
	isValid ()
	getType ()
	render ()
	__toString ()

Public Attributes
array< string, function getAttributes():array { return $this->	attributes

Protected Member Functions
	getAttributesString ()

Protected Attributes
string	$tag = 'button'
Icon	$icon = null
string	$label = ''
string	$title = null
string	$href = null
string	$classes = ''
array	$attributes = []
bool	$showLabelText = false

Detailed Description

GenericButton

$button = GeneralUtility::makeInstance(GenericButton::class) ->setTag('a') ->setHref('#') ->setLabel('Label') ->setTitle('Title') ->setIcon($this->iconFactory->getIcon('actions-heart')) ->setAttributes(['data-value' => '123']);

Definition at line 33 of file GenericButton.php.

Member Function Documentation

__toString()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::__toString

(

)

Definition at line 178 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\render().

getAttributesString()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getAttributesString ( )

protected

Definition at line 151 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$attributes, TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getClasses(), TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getHref(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getTitle().

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\render().

getClasses()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getClasses

(

)

Definition at line 100 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$classes.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getAttributesString().

getHref()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getHref

(

)

Definition at line 89 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$href.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getAttributesString().

getIcon()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getIcon

(

)

Definition at line 55 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$icon.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\isValid(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\render().

getLabel()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getLabel

(

)

Definition at line 67 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$label.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\isValid(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\render().

getShowLabelText()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getShowLabelText

(

)

Definition at line 128 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$showLabelText.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\render().

getTag()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getTag

(

)

Definition at line 50 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$tag.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\render().

getTitle()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getTitle

(

)

Definition at line 78 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$label.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getAttributesString().

getType()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::getType

(

)

Returns the fully qualified class name of the button as a string

Returns

‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 146 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\isValid().

isValid()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::isValid

(

)

Validates all set parameters of a button.

Returns

‪bool

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 139 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getIcon(), TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getLabel(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getType().

render()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::render

(

)

Renders the markup for the button

Returns

‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 165 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getAttributesString(), TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getIcon(), TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getLabel(), TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getShowLabelText(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getTag().

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\__toString().

setAttributes()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setAttributes

(

array

$attributes

)

Parameters

array<string,string>

‪$attributes

Definition at line 114 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$attributes, and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\attributes.

setClasses()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setClasses

(

string

$classes

)

Definition at line 105 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$classes.

setHref()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setHref

(

?string

$href

)

Definition at line 94 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$href.

setIcon()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setIcon

(

?Icon

$icon

)

Definition at line 60 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$icon, and TYPO3\CMS\Core\Imaging\Icon\setSize().

setLabel()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setLabel

(

?string

$label

)

Definition at line 72 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$label.

setShowLabelText()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setShowLabelText

(

bool

$showLabelText

)

Definition at line 133 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$showLabelText.

setTag()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setTag

(

string

$tag

)

Definition at line 44 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$tag.

setTitle()

TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::setTitle

(

?string

$title

)

Definition at line 83 of file GenericButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\$title.

Member Data Documentation

$attributes

array TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$attributes = []

protected

Definition at line 41 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getAttributesString(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setAttributes().

$classes

string TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$classes = ''

protected

Definition at line 40 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getClasses(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setClasses().

$href

string TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$href = null

protected

Definition at line 39 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getHref(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setHref().

$icon

Icon TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$icon = null

protected

Definition at line 36 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getIcon(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setIcon().

$label

string TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$label = ''

protected

Definition at line 37 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getLabel(), TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getTitle(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setLabel().

$showLabelText

bool TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$showLabelText = false

protected

Definition at line 42 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getShowLabelText(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setShowLabelText().

$tag

string TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$tag = 'button'

protected

Definition at line 35 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\getTag(), and TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setTag().

$title

string TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::$title = null

protected

Definition at line 38 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setTitle().

attributes

array<string, function getAttributes(): array { return $this-> TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton::attributes

Returns

‪array<string, string>

Definition at line 125 of file GenericButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\GenericButton\setAttributes().