TYPO3\CMS\Backend\Toolbar\ToolbarItemHookInterface Interface Reference

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

Public Member Functions
	__construct (\TYPO3\CMS\Backend\Controller\BackendController &$backendReference=NULL)
	checkAccess ()
	render ()
	getAdditionalAttributes ()

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Interface for classes which extend the backend by adding items to the top toolbar

Author

Ingo Renner ingo@.nosp@m.typo.nosp@m.3.org

Definition at line 21 of file ToolbarItemHookInterface.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Toolbar\ToolbarItemHookInterface::__construct

(

\TYPO3\CMS\Backend\Controller\BackendController &

$backendReference = NULL

)

Constructor that receives a back reference to the backend

Parameters

\TYPO3\CMS\Backend\Controller\BackendController

$backendReference

TYPO3 backend object reference

Implemented in TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem, TYPO3\CMS\Backend\Toolbar\ClearCacheToolbarItem, TYPO3\CMS\Workspaces\ExtDirect\WorkspaceSelectorToolbarItem, TYPO3\CMS\Opendocs\Controller\OpendocsController, TYPO3\CMS\SysAction\ActionToolbarMenu, and TYPO3\CMS\Backend\Toolbar\LiveSearchToolbarItem.

Member Function Documentation

checkAccess()

TYPO3\CMS\Backend\Toolbar\ToolbarItemHookInterface::checkAccess

(

)

Checks whether the user has access to this toolbar item

Returns

boolean TRUE if user has access, FALSE if not

Implemented in TYPO3\CMS\SysAction\ActionToolbarMenu, TYPO3\CMS\Backend\Toolbar\ClearCacheToolbarItem, TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem, TYPO3\CMS\Opendocs\Controller\OpendocsController, and TYPO3\CMS\Backend\Toolbar\LiveSearchToolbarItem.

getAdditionalAttributes()

TYPO3\CMS\Backend\Toolbar\ToolbarItemHookInterface::getAdditionalAttributes

(

)

Returns additional attributes for the list item in the toolbar

Returns

string List item HTML attibutes

Implemented in TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem, TYPO3\CMS\Opendocs\Controller\OpendocsController, TYPO3\CMS\Backend\Toolbar\ClearCacheToolbarItem, TYPO3\CMS\Workspaces\ExtDirect\WorkspaceSelectorToolbarItem, TYPO3\CMS\SysAction\ActionToolbarMenu, and TYPO3\CMS\Backend\Toolbar\LiveSearchToolbarItem.

render()

TYPO3\CMS\Backend\Toolbar\ToolbarItemHookInterface::render

(

)

Renders the toolbar item

Returns

string The toolbar item rendered as HTML string

Implemented in TYPO3\CMS\Backend\Toolbar\ClearCacheToolbarItem, TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem, TYPO3\CMS\Opendocs\Controller\OpendocsController, TYPO3\CMS\Backend\Toolbar\LiveSearchToolbarItem, and TYPO3\CMS\SysAction\ActionToolbarMenu.