TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Backend\Template\Components\ButtonBar Class Reference

Public Member Functions

 addButton (ButtonInterface $button, $buttonPosition=self::BUTTON_POSITION_LEFT, $buttonGroup=1)
 
 makeButton ($button)
 
 makeInputButton ()
 
 makeSplitButton ()
 
 makeLinkButton ()
 
 makeFullyRenderedButton ()
 
 makeShortcutButton ()
 
 makeHelpButton ()
 
 getButtons ()
 

Public Attributes

const BUTTON_POSITION_LEFT = 'left'
 
const BUTTON_POSITION_RIGHT = 'right'
 

Protected Attributes

 $buttons = []
 

Detailed Description

Bar holding the buttons

Definition at line 30 of file ButtonBar.php.

Member Function Documentation

◆ addButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::addButton ( ButtonInterface  $button,
  $buttonPosition = self::BUTTON_POSITION_LEFT,
  $buttonGroup = 1 
)

Add button

Parameters
ButtonInterface$buttonThe Button Object to add
string$buttonPositionPosition of the button (left/right)
int$buttonGroupButtongroup of the button
Exceptions

Definition at line 60 of file ButtonBar.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface\getType(), and TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface\isValid().

◆ getButtons()

TYPO3\CMS\Backend\Template\Components\ButtonBar::getButtons ( )

Returns an associative array of all buttons in the form of ButtonPosition > ButtonGroup > Button

Returns
array

Definition at line 162 of file ButtonBar.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\$buttons, $GLOBALS, $params, and TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction().

◆ makeButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeButton (   $button)

Creates a new button of the given type

Parameters
string$buttonButtonClass to invoke. Must implement ButtonInterface
Exceptions

Definition at line 88 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ makeFullyRenderedButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeFullyRenderedButton ( )

Creates a new FullyRenderedButton

Returns
FullyRenderedButton

Definition at line 131 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ makeHelpButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeHelpButton ( )

Creates a new HelpButton

Returns
HelpButton

Definition at line 151 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ makeInputButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeInputButton ( )

Creates a new InputButton

Returns
InputButton

Definition at line 101 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ makeLinkButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeLinkButton ( )

Creates a new LinkButton

Returns
LinkButton

Definition at line 121 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ makeShortcutButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeShortcutButton ( )

Creates a new ShortcutButton

Returns
ShortcutButton

Definition at line 141 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ makeSplitButton()

TYPO3\CMS\Backend\Template\Components\ButtonBar::makeSplitButton ( )

Creates a new SplitButton

Returns
SplitButton

Definition at line 111 of file ButtonBar.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Data Documentation

◆ $buttons

TYPO3\CMS\Backend\Template\Components\ButtonBar::$buttons = []
protected

◆ BUTTON_POSITION_LEFT

const TYPO3\CMS\Backend\Template\Components\ButtonBar::BUTTON_POSITION_LEFT = 'left'

Identifier for the left button bar

Definition at line 35 of file ButtonBar.php.

Referenced by TYPO3\CMS\Recordlist\RecordList\clearCache(), TYPO3\CMS\Extensionmanager\Controller\ConfigurationController\emitAfterExtensionConfigurationWriteSignal(), TYPO3\CMS\Beuser\Controller\BackendUserActionController\generateMenu(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\getButtons(), TYPO3\CMS\Info\Controller\InfoModuleController\getButtons(), TYPO3\CMS\Backend\Controller\Wizard\TableController\getButtons(), TYPO3\CMS\Backend\Controller\File\EditFileController\getButtons(), TYPO3\CMS\Backend\Controller\Wizard\RteController\getButtons(), TYPO3\CMS\Backend\Controller\NewRecordController\getButtons(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\getButtons(), TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getButtons(), TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons(), TYPO3\CMS\Filelist\Controller\FileListController\getModuleHeadline(), TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), TYPO3\CMS\Backend\Controller\BackendLayoutWizardController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeButtons(), TYPO3\CMS\Lang\Controller\LanguageController\prepareDocHeaderButtons(), TYPO3\CMS\Extensionmanager\Controller\DistributionController\showAction(), and TYPO3\CMS\Extensionmanager\Controller\ListController\showAllVersionsAction().

◆ BUTTON_POSITION_RIGHT