TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton:

Public Member Functions
	getModuleName ()
	setModuleName ($moduleName)
	getDisplayName ()
	setDisplayName ($displayName)
	getSetVariables ()
	setSetVariables (array $setVariables)
	getGetVariables ()
	setGetVariables (array $getVariables)
	getPosition ()
	getGroup ()
	getType ()
	isValid ()
	__toString ()
Public Member Functions inherited from TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface
	render ()

Protected Member Functions
	preProcess ()
	getBackendUser ()

Protected Attributes
	$moduleName
	$displayName
	$setVariables = []
	$getVariables = []
	$controllerContext

Detailed Description

ShortcutButton

Renders a shortcut button in the DocHeader which will be rendered to the right position using button group "91".

EXAMPLE USAGE TO ADD A SHORTCUT BUTTON:

$buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar(); $myButton = $buttonBar->makeShortcutButton() ->setModuleName('my_info'); $buttonBar->addButton($myButton);

Definition at line 38 of file ShortcutButton.php.

Member Function Documentation

__toString()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::__toString

(

)

Renders the button

Returns

string

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

Definition at line 204 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\getBackendUser(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface\render().

getBackendUser()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getBackendUser ( )

protected

Returns

BackendUserAuthentication

Definition at line 261 of file ShortcutButton.php.

References $GLOBALS.

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

getDisplayName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getDisplayName

(

)

Gets the display name of the module.

Returns

string

Definition at line 92 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$displayName.

getGetVariables()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getGetVariables

(

)

Gets the GET variables.

Returns

array

Definition at line 136 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$getVariables.

getGroup()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getGroup

(

)

Gets the button group.

Returns

int

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

Definition at line 168 of file ShortcutButton.php.

getModuleName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getModuleName

(

)

Gets the name of the module.

Returns

string

Definition at line 70 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$moduleName.

getPosition()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getPosition

(

)

Gets the button position.

Returns

string

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

Definition at line 158 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT.

getSetVariables()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getSetVariables

(

)

Gets the SET variables.

Returns

array

Definition at line 114 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$setVariables.

getType()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::getType

(

)

Gets the type of the button

Returns

string

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

Definition at line 178 of file ShortcutButton.php.

isValid()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::isValid

(

)

Determines whether the button shall be rendered. Depends on the backend user permission to create shortcuts and the defined module name.

Returns

bool

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

Definition at line 190 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\preProcess().

preProcess()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::preProcess ( )

protected

Pre-processes class member values.

Definition at line 236 of file ShortcutButton.php.

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

setDisplayName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::setDisplayName

(

$displayName

)

Sets the display name of the module.

Parameters

string

$displayName

Returns

ShortcutButton

Definition at line 103 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$displayName.

setGetVariables()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::setGetVariables

(

array

$getVariables

)

Sets the GET variables.

Parameters

array

$getVariables

Returns

ShortcutButton

Definition at line 147 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$getVariables.

setModuleName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::setModuleName

(

$moduleName

)

Sets the name of the module.

Parameters

string

$moduleName

Returns

ShortcutButton

Definition at line 81 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$moduleName.

setSetVariables()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::setSetVariables

(

array

$setVariables

)

Sets the SET variables.

Parameters

array

$setVariables

Returns

ShortcutButton

Definition at line 125 of file ShortcutButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\$setVariables.

Member Data Documentation

$controllerContext

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::$controllerContext

protected

Definition at line 63 of file ShortcutButton.php.

$displayName

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::$displayName

protected

Definition at line 48 of file ShortcutButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\getDisplayName(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\setDisplayName().

$getVariables

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::$getVariables = []

protected

Definition at line 58 of file ShortcutButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\getGetVariables(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\setGetVariables().

$moduleName

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::$moduleName

protected

Definition at line 43 of file ShortcutButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\getModuleName(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\setModuleName().

$setVariables

TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton::$setVariables = []

protected

Definition at line 53 of file ShortcutButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\getSetVariables(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\setSetVariables().