ClearCacheToolbarItem.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Toolbar;

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\Utility\IconUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class ClearCacheToolbarItem implements ToolbarItemHookInterface {

    protected $cacheActions;

    protected $optionValues;

    protected $backendReference;

    public $backPath = '';

    public function __construct(\TYPO3\CMS\Backend\Controller\BackendController &$backendReference = NULL) {
        $this->backendReference = $backendReference;
        $this->cacheActions = array();
        $this->optionValues = array();
        $backendUser = $this->getBackendUser();

        // Clear all page-related caches
        if ($backendUser->isAdmin() || $backendUser->getTSConfigVal('options.clearCache.pages')) {
            $this->cacheActions[] = array(
                'id' => 'pages',
                'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:flushPageCachesTitle', TRUE),
                'description' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:flushPageCachesDescription', TRUE),
                'href' => $this->backPath . 'tce_db.php?vC=' . $backendUser->veriCode() . '&cacheCmd=pages&ajaxCall=1' . BackendUtility::getUrlToken('tceAction'),
                'icon' => IconUtility::getSpriteIcon('actions-system-cache-clear-impact-low')
            );
            $this->optionValues[] = 'pages';
        }

        // Clear cache for ALL tables!
        if ($backendUser->isAdmin() || $backendUser->getTSConfigVal('options.clearCache.all')) {
            $this->cacheActions[] = array(
                'id' => 'all',
                'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:flushGeneralCachesTitle', TRUE),
                'description' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:flushGeneralCachesDescription', TRUE),
                'href' => $this->backPath . 'tce_db.php?vC=' . $backendUser->veriCode() . '&cacheCmd=all&ajaxCall=1' . BackendUtility::getUrlToken('tceAction'),
                'icon' => IconUtility::getSpriteIcon('actions-system-cache-clear-impact-medium')
            );
            $this->optionValues[] = 'all';
        }

        // Clearing of system cache (core cache, class cache etc)
        // is only shown explicitly if activated for a BE-user (not activated for admins by default)
        // or if the system runs in development mode (only for admin)
        // or if $GLOBALS['TYPO3_CONF_VARS']['SYS']['clearCacheSystem'] is set (only for admins)
        if ($backendUser->getTSConfigVal('options.clearCache.system')
            || (GeneralUtility::getApplicationContext()->isDevelopment() && $backendUser->isAdmin())
            || ((bool) $GLOBALS['TYPO3_CONF_VARS']['SYS']['clearCacheSystem'] === TRUE && $backendUser->isAdmin())) {
            $this->cacheActions[] = array(
                'id' => 'system',
                'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:flushSystemCachesTitle', TRUE),
                'description' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:flushSystemCachesDescription', TRUE),
                'href' => $this->backPath . 'tce_db.php?vC=' . $backendUser->veriCode() . '&cacheCmd=system&ajaxCall=1' . BackendUtility::getUrlToken('tceAction'),
                'icon' => IconUtility::getSpriteIcon('actions-system-cache-clear-impact-high')
            );
            $this->optionValues[] = 'system';
        }
        // Hook for manipulating cacheActions
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['additionalBackendItems']['cacheActions'])) {
            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['additionalBackendItems']['cacheActions'] as $cacheAction) {
                $hookObject = GeneralUtility::getUserObj($cacheAction);
                if (!$hookObject instanceof \TYPO3\CMS\Backend\Toolbar\ClearCacheActionsHookInterface) {
                    throw new \UnexpectedValueException('$hookObject must implement interface TYPO3\\CMS\\Backend\\Toolbar\\ClearCacheActionsHookInterface', 1228262000);
                }
                $hookObject->manipulateCacheActions($this->cacheActions, $this->optionValues);
            }
        }
    }

    public function checkAccess() {
        $backendUser = $this->getBackendUser();
        if ($backendUser->isAdmin()) {
            return TRUE;
        }
        if (is_array($this->optionValues)) {
            foreach ($this->optionValues as $value) {
                if ($backendUser->getTSConfigVal('options.clearCache.' . $value)) {
                    return TRUE;
                }
            }
        }
        return FALSE;
    }

    public function render() {
        $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:rm.clearCache_clearCache', TRUE);
        $this->addJavascriptToBackend();
        $cacheMenu = array();
        $cacheMenu[] = '<a href="#" class="toolbar-item">' . IconUtility::getSpriteIcon('apps-toolbar-menu-cache', array('title' => $title)) . '</a>';
        $cacheMenu[] = '<ul class="toolbar-item-menu" style="display: none;">';
        foreach ($this->cacheActions as $actionKey => $cacheAction) {
            $cacheMenu[] = '<li><a href="' . htmlspecialchars($cacheAction['href'])
                . '" title="' . htmlspecialchars($cacheAction['description'] ?: $cacheAction['title']) . '">'
                . $cacheAction['icon'] . ' ' . htmlspecialchars($cacheAction['title']) . '</a></li>';
        }
        $cacheMenu[] = '</ul>';
        return implode(LF, $cacheMenu);
    }

    protected function addJavascriptToBackend() {
        $this->backendReference->addJavascriptFile('sysext/backend/Resources/Public/JavaScript/clearcachemenu.js');
    }

    public function getAdditionalAttributes() {
        return 'id="clear-cache-actions-menu"';
    }

    protected function getBackendUser() {
        return $GLOBALS['BE_USER'];
    }
}