‪TYPO3CMS  ‪main
TYPO3\CMS\Backend\Template\Components\ButtonBar Class Reference

Public Member Functions

$this addButton (ButtonInterface $button, $buttonPosition=self::BUTTON_POSITION_LEFT, $buttonGroup=1)
 
ButtonInterface makeButton ($button)
 
InputButton makeInputButton ()
 
SplitButton makeSplitButton ()
 
DropDownButton makeDropDownButton ()
 
LinkButton makeLinkButton ()
 
FullyRenderedButton makeFullyRenderedButton ()
 
ShortcutButton makeShortcutButton ()
 
 getButtons ()
 

Public Attributes

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

Protected Attributes

array $buttons = array( )
 

Detailed Description

Bar holding the buttons

Definition at line 32 of file ButtonBar.php.

Member Function Documentation

◆ addButton()

◆ getButtons()

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

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

Definition at line 161 of file ButtonBar.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\$buttons.

◆ makeButton()

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

Creates a new button of the given type

Parameters
string$button‪ButtonClass to invoke. Must implement ButtonInterface
Exceptions

Definition at line 89 of file ButtonBar.php.

◆ makeDropDownButton()

DropDownButton TYPO3\CMS\Backend\Template\Components\ButtonBar::makeDropDownButton ( )

Creates a new DropDownButton

Returns
‪DropDownButton

Definition at line 122 of file ButtonBar.php.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\makeLanguageSwitchButton().

◆ makeFullyRenderedButton()

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

Creates a new FullyRenderedButton

Returns
‪FullyRenderedButton

Definition at line 142 of file ButtonBar.php.

◆ makeInputButton()

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

Creates a new InputButton

Returns
‪InputButton

Definition at line 102 of file ButtonBar.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\registerSaveButtonToButtonBar().

◆ makeLinkButton()

◆ makeShortcutButton()

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

Creates a new ShortcutButton

Returns
‪ShortcutButton

Definition at line 152 of file ButtonBar.php.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\registerShortcutButtonToButtonBar().

◆ makeSplitButton()

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

Creates a new SplitButton

Returns
‪SplitButton

Definition at line 112 of file ButtonBar.php.

Member Data Documentation

◆ $buttons

array TYPO3\CMS\Backend\Template\Components\ButtonBar::$buttons = array( )
protected

Internal array of all registered buttons

Definition at line 48 of file ButtonBar.php.

Referenced by TYPO3\CMS\Backend\Template\Components\ButtonBar\getButtons().

◆ BUTTON_POSITION_LEFT

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

Identifier for the left button bar

Definition at line 37 of file ButtonBar.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addDocHeaderAddTaskButton(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addDocHeaderAddTaskGroupButton(), TYPO3\CMS\Filelist\Controller\File\EditFileController\addDocHeaderButtons(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addDocHeaderCloseAndSaveButtons(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addDocHeaderDeleteButton(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addDocHeaderNewButton(), TYPO3\CMS\Workspaces\Controller\ReviewController\addEditWorkspaceRecordButton(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\addFormButtons(), TYPO3\CMS\Tstemplate\Controller\AbstractTemplateModuleController\addPreviewButtonToDocHeader(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureEditViewDocHeader(), TYPO3\CMS\Info\Controller\InfoModuleController\getButtons(), TYPO3\CMS\Backend\Controller\NewRecordController\getButtons(), TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons(), TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), TYPO3\CMS\Form\Controller\FormEditorController\initializeModuleTemplate(), TYPO3\CMS\Form\Controller\FormManagerController\initializeModuleTemplate(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\mainAction(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeButtons(), TYPO3\CMS\Filelist\Controller\FileListController\registerAdditionalDocHeaderButtons(), TYPO3\CMS\Webhooks\Controller\ManagementController\registerDocHeaderButtons(), TYPO3\CMS\Reactions\Controller\ManagementController\registerDocHeaderButtons(), TYPO3\CMS\Redirects\Controller\ManagementController\registerDocHeaderButtons(), TYPO3\CMS\Beuser\Controller\PermissionController\registerDocHeaderButtons(), and TYPO3\CMS\Beuser\Controller\BackendUserController\showAction().

◆ BUTTON_POSITION_RIGHT

const TYPO3\CMS\Backend\Template\Components\ButtonBar::BUTTON_POSITION_RIGHT = 'right'

Identifier for the right button bar

Definition at line 42 of file ButtonBar.php.

Referenced by TYPO3\CMS\SysNote\Provider\ButtonBarProvider\__invoke(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\addDocHeaderReloadButton(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\addOverviewButtons(), TYPO3\CMS\Beuser\Controller\BackendUserController\compareAction(), TYPO3\CMS\Beuser\Controller\BackendUserController\compareGroupsAction(), TYPO3\CMS\Backend\Controller\SiteConfigurationController\configureOverViewDocHeader(), TYPO3\CMS\Info\Controller\InfoModuleController\getButtons(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigRecordsOverviewController\getButtons(), TYPO3\CMS\Backend\Controller\EditDocumentController\getButtons(), TYPO3\CMS\Backend\Controller\RecordListController\getDocHeaderButtons(), TYPO3\CMS\Backend\Template\Components\Buttons\Action\ShortcutButton\getPosition(), TYPO3\CMS\Beuser\Controller\BackendUserController\groupsAction(), TYPO3\CMS\Beuser\Controller\BackendUserController\indexAction(), TYPO3\CMS\Form\Controller\FormManagerController\initializeModuleTemplate(), TYPO3\CMS\Backend\Controller\PageLayoutController\makeButtons(), TYPO3\CMS\Beuser\Controller\BackendUserController\onlineAction(), TYPO3\CMS\Filelist\Controller\FileListController\registerAdditionalDocHeaderButtons(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\registerDocHeader(), TYPO3\CMS\Webhooks\Controller\ManagementController\registerDocHeaderButtons(), TYPO3\CMS\Recycler\Controller\RecyclerModuleController\registerDocHeaderButtons(), TYPO3\CMS\Reactions\Controller\ManagementController\registerDocHeaderButtons(), TYPO3\CMS\Redirects\Controller\ManagementController\registerDocHeaderButtons(), TYPO3\CMS\Beuser\Controller\PermissionController\registerDocHeaderButtons(), TYPO3\CMS\Lowlevel\Controller\DatabaseIntegrityController\setUpDocHeader(), and TYPO3\CMS\Beuser\Controller\BackendUserController\showAction().