TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem:

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

Protected Member Functions
BackendUserAuthentication	getBackendUser ()
PageRenderer	getPageRenderer ()
StandaloneView	getFluidTemplateObject (string $filename)

Protected Attributes
array	$cacheActions = array( )
array	$optionValues = array( )

Detailed Description

Render cache clearing toolbar item Adds a dropdown if there are more than one item to clear (usually for admins to render the flush all caches)

The dropdown items can be extended via a hook named "cacheActions".

Definition at line 31 of file ClearCacheToolbarItem.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::__construct

(

)

Exceptions

Definition at line 44 of file ClearCacheToolbarItem.php.

References $GLOBALS, TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getBackendUser(), TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getPageRenderer(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\isAdmin(), and TYPO3\CMS\Core\Page\PageRenderer\loadRequireJsModule().

Member Function Documentation

checkAccess()

bool TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::checkAccess

(

)

Checks whether the user has access to this toolbar item

Returns

‪bool TRUE if user has access, FALSE if not

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 94 of file ClearCacheToolbarItem.php.

References TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getBackendUser().

getAdditionalAttributes()

array TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getAdditionalAttributes

(

)

No additional attributes needed.

Returns

‪array

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 145 of file ClearCacheToolbarItem.php.

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getBackendUser ( )

protected

Returns the current BE user.

Returns

‪BackendUserAuthentication

Definition at line 175 of file ClearCacheToolbarItem.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\__construct(), and TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\checkAccess().

getDropDown()

string TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getDropDown

(

)

Render drop down

Returns

‪string Drop down HTML

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 133 of file ClearCacheToolbarItem.php.

References TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getFluidTemplateObject().

getFluidTemplateObject()

StandaloneView TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getFluidTemplateObject ( string  $filename )

protected

Returns a new standalone view, shorthand function

Parameters

string

$filename

‪Which templateFile should be used.

Returns

‪StandaloneView

Definition at line 194 of file ClearCacheToolbarItem.php.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getDropDown(), and TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getItem().

getIndex()

int TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getIndex

(

)

Position relative to others

Returns

‪int

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 165 of file ClearCacheToolbarItem.php.

getItem()

string TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getItem

(

)

Render clear cache icon, based on the option if there is more than one icon or just one.

Returns

‪string Icon HTML

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 113 of file ClearCacheToolbarItem.php.

References TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getFluidTemplateObject(), TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\hasDropDown(), and TYPO3\CMS\Extbase\Mvc\View\ViewInterface\render().

getPageRenderer()

PageRenderer TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::getPageRenderer ( )

protected

Returns

‪PageRenderer

Definition at line 183 of file ClearCacheToolbarItem.php.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\__construct().

hasDropDown()

bool TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::hasDropDown

(

)

This item has a drop down if there is more than one cache action available for the current Backend user.

Returns

‪bool

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 155 of file ClearCacheToolbarItem.php.

Referenced by TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getItem().

Member Data Documentation

$cacheActions

array TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::$cacheActions = array( )

protected

Definition at line 35 of file ClearCacheToolbarItem.php.

$optionValues

array TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem::$optionValues = array( )

protected

Definition at line 39 of file ClearCacheToolbarItem.php.