TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ShortcutButton Class Reference
Inheritance diagram for ShortcutButton:
ButtonInterface PositionInterface

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 ButtonInterface
 render ()
 

Protected Member Functions

 preProcess ()
 
 getBackendUser ()
 

Protected Attributes

 $moduleName
 
 $displayName
 
 $setVariables = array()
 
 $getVariables = array()
 
 $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'); $extbaseButton = $buttonBar->makeShortcutButton() ->setControllerContext($this->controllerContext); $buttonBar->addButton($myButton); $buttonBar->addButton($extbaseButton);

Definition at line 41 of file ShortcutButton.php.

Member Function Documentation

__toString ( )

Renders the button

Returns
string

Implements ButtonInterface.

Definition at line 207 of file ShortcutButton.php.

References ButtonInterface\render().

getBackendUser ( )
protected
Returns
BackendUserAuthentication

Definition at line 264 of file ShortcutButton.php.

References $GLOBALS.

getDisplayName ( )

Gets the display name of the module.

Returns
string

Definition at line 95 of file ShortcutButton.php.

References ShortcutButton\$displayName.

getGetVariables ( )

Gets the GET variables.

Returns
array

Definition at line 139 of file ShortcutButton.php.

References ShortcutButton\$getVariables.

getGroup ( )

Gets the button group.

Returns
int

Implements PositionInterface.

Definition at line 171 of file ShortcutButton.php.

getModuleName ( )

Gets the name of the module.

Returns
string

Definition at line 73 of file ShortcutButton.php.

References ShortcutButton\$moduleName.

getPosition ( )

Gets the button position.

Returns
string

Implements PositionInterface.

Definition at line 161 of file ShortcutButton.php.

References ButtonBar\BUTTON_POSITION_RIGHT.

getSetVariables ( )

Gets the SET variables.

Returns
array

Definition at line 117 of file ShortcutButton.php.

References ShortcutButton\$setVariables.

getType ( )

Gets the type of the button

Returns
string

Implements ButtonInterface.

Definition at line 181 of file ShortcutButton.php.

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 ButtonInterface.

Definition at line 193 of file ShortcutButton.php.

References ShortcutButton\preProcess().

preProcess ( )
protected

Pre-processes class member values.

Definition at line 239 of file ShortcutButton.php.

Referenced by ShortcutButton\isValid().

setDisplayName (   $displayName)

Sets the display name of the module.

Parameters
string$displayName
Returns
ShortcutButton

Definition at line 106 of file ShortcutButton.php.

References ShortcutButton\$displayName.

setGetVariables ( array  $getVariables)

Sets the GET variables.

Parameters
array$getVariables
Returns
ShortcutButton

Definition at line 150 of file ShortcutButton.php.

References ShortcutButton\$getVariables.

setModuleName (   $moduleName)

Sets the name of the module.

Parameters
string$moduleName
Returns
ShortcutButton

Definition at line 84 of file ShortcutButton.php.

References ShortcutButton\$moduleName.

setSetVariables ( array  $setVariables)

Sets the SET variables.

Parameters
array$setVariables
Returns
ShortcutButton

Definition at line 128 of file ShortcutButton.php.

References ShortcutButton\$setVariables.

Member Data Documentation

$controllerContext
protected

Definition at line 66 of file ShortcutButton.php.

$displayName
protected
$getVariables = array()
protected
$moduleName
protected
$setVariables = array()
protected