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

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

Public Member Functions
string	getHref ()
LinkButton	setHref ($href)
bool	isValid ()
string	render ()
	__toString ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton
bool	getShowLabelText ()
$this	setShowLabelText ($showLabelText)
Icon	getIcon ()
string	getType ()
$this	setIcon (Icon $icon)
	isDisabled ()
	setDisabled (bool $disabled)
‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Template\Components\AbstractControl
string	getClasses ()
string	getTitle ()
array	getDataAttributes ()
$this	setClasses ($classes)
$this	setTitle ($title)
$this	setDataAttributes (array $dataAttributes)

Protected Attributes
string	$href = ''
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton
Icon	$icon
bool	$showLabelText = false
bool	$disabled = false
‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Template\Components\AbstractControl
string	$classes = ''
string	$title = ''
array	$dataAttributes = array( )

Detailed Description

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);

Definition at line 38 of file LinkButton.php.

Member Function Documentation

__toString()

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

(

)

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

Reimplemented from TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton.

Definition at line 120 of file LinkButton.php.

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

getHref()

string TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton::getHref

(

)

Get href

Returns

‪string

Definition at line 51 of file LinkButton.php.

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

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

isValid()

bool TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton::isValid

(

)

Validates the current button

Returns

‪bool

Reimplemented from TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton.

Definition at line 74 of file LinkButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\getHref(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\getIcon(), TYPO3\CMS\Backend\Template\Components\AbstractControl\getTitle(), and TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\getType().

render()

string TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton::render

(

)

Renders the markup for the button

Returns

‪string

Reimplemented from TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton.

Definition at line 92 of file LinkButton.php.

References TYPO3\CMS\Backend\Template\Components\AbstractControl\$title, TYPO3\CMS\Backend\Template\Components\AbstractControl\getClasses(), TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton\getHref(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\getIcon(), TYPO3\CMS\Backend\Template\Components\AbstractControl\getTitle(), TYPO3\CMS\Backend\Template\Components\Buttons\AbstractButton\isDisabled(), and TYPO3\CMS\Core\Imaging\Icon\render().

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

setHref()

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

(

$href

)

Set href

Parameters

string

$href

‪HREF attribute

Returns

‪LinkButton

Definition at line 63 of file LinkButton.php.

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

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\makeEditButton(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeViewButton(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerCloseButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerColumnsOnlyButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerDuplicationButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerHistoryButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerNewButtonToButtonBar(), TYPO3\CMS\Backend\Controller\EditDocumentController\registerOpenInNewWindowButtonToButtonBar(), and TYPO3\CMS\Backend\Controller\EditDocumentController\registerViewButtonToButtonBar().

Member Data Documentation

$href

string TYPO3\CMS\Backend\Template\Components\Buttons\LinkButton::$href = ''

protected

HREF attribute of the link

Definition at line 44 of file LinkButton.php.

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