TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface:

Public Member Functions
bool	checkAccess ()
string	getItem ()
bool	hasDropDown ()
string	getDropDown ()
array	getAdditionalAttributes ()
int	getIndex ()

Detailed Description

Interface for classes which extend the backend by adding items to the top toolbar

@TODO: This interface is FIRST DRAFT and still WILL CHANGE

See also

‪https://forge.typo3.org/issues/62928

Definition at line 24 of file ToolbarItemInterface.php.

Member Function Documentation

checkAccess()

bool TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface::checkAccess

(

)

Checks whether the user has access to this toolbar item @TODO: Split into two methods a permission method and a "hasContent" or similar

Returns

‪bool TRUE if user has access, FALSE if not

Implemented in TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem, TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem, and TYPO3\CMS\Backend\Backend\ToolbarItems\UserToolbarItem.

getAdditionalAttributes()

array TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface::getAdditionalAttributes

(

)

Returns an array with additional attributes added to containing tag of the item.

Typical usages are additional css classes and data-* attributes, classes may be merged with other classes needed by the framework. Do NOT set an id attribute here.

array( 'class' => 'my-class', 'data-foo' => '42', )

Returns

‪array List item HTML attributes

Implemented in TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\UserToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem, TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem, and TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem.

getDropDown()

string TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface::getDropDown

(

)

Render "drop down" part of this toolbar

Returns

‪string Drop down HTML

Implemented in TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem, TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem, and TYPO3\CMS\Backend\Backend\ToolbarItems\UserToolbarItem.

getIndex()

int TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface::getIndex

(

)

Returns an integer between 0 and 100 to determine the position of this item relative to others

By default, extensions should return 50 to be sorted between main core items and other items that should be on the very right.

Returns

‪int 0 .. 100

Implemented in TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\UserToolbarItem, TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem, and TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem.

getItem()

string TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface::getItem

(

)

Render "item" part of this toolbar

Returns

‪string Toolbar item HTML

Implemented in TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem, TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem, and TYPO3\CMS\Backend\Backend\ToolbarItems\UserToolbarItem.

hasDropDown()

bool TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface::hasDropDown

(

)

TRUE if this toolbar item has a collapsible drop down

Returns

‪bool

Implemented in TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\UserToolbarItem, TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem, TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem, and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem.