ClearCacheToolbarItem.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Backend\Backend\ToolbarItems;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Backend\Event\ModifyClearCacheActionsEvent;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Toolbar\RequestAwareToolbarItemInterface;
use ‪TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;
use ‪TYPO3\CMS\Backend\View\BackendViewFactory;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
 
class ‪ClearCacheToolbarItem implements ‪ToolbarItemInterface, ‪RequestAwareToolbarItemInterface
{
    protected array ‪$cacheActions = [];
    protected array ‪$optionValues = [];
    private ServerRequestInterface ‪$request;
 
    public function ‪__construct(
        ‪UriBuilder $uriBuilder,
        EventDispatcherInterface $eventDispatcher,
        private readonly ‪BackendViewFactory $backendViewFactory,
    ) {
        $isAdmin = $this->‪getBackendUser()->isAdmin();
        $userTsConfig = $this->‪getBackendUser()->getTSConfig();
 
        // Clear all page-related caches
        if ($isAdmin || ($userTsConfig['options.']['clearCache.']['pages'] ?? false)) {
            $this->cacheActions[] = [
                'id' => 'pages',
                'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:flushPageCachesTitle',
                'description' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:flushPageCachesDescription',
                'href' => (string)$uriBuilder->‪buildUriFromRoute('tce_db', ['cacheCmd' => 'pages']),
                'severity' => 'success',
                'iconIdentifier' => 'actions-system-cache-clear-impact-low',
            ];
            $this->optionValues[] = 'pages';
        }
 
        // Clearing of all caches is only shown if explicitly enabled via TSConfig
        // or if BE-User is admin and the TSconfig explicitly disables the possibility for admins.
        // This is useful for big production systems where admins accidentally could slow down the system.
        if (($userTsConfig['options.']['clearCache.']['all'] ?? false)
            || ($isAdmin && (bool)($userTsConfig['options.']['clearCache.']['all'] ?? true))
        ) {
            $this->cacheActions[] = [
                'id' => 'all',
                'title' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:flushAllCachesTitle2',
                'description' => 'LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:flushAllCachesDescription2',
                'href' => (string)$uriBuilder->‪buildUriFromRoute('tce_db', ['cacheCmd' => 'all']),
                'severity' => 'danger',
                'iconIdentifier' => 'actions-system-cache-clear-impact-high',
            ];
            $this->optionValues[] = 'all';
        }
 
        $event = new ‪ModifyClearCacheActionsEvent($this->cacheActions, $this->optionValues);
        $event = $eventDispatcher->dispatch($event);
        $this->cacheActions = $event->getCacheActions();
        $this->optionValues = $event->getCacheActionIdentifiers();
    }
 
    public function ‪setRequest(ServerRequestInterface ‪$request): void
    {
        $this->request = ‪$request;
    }
 
    public function ‪checkAccess(): bool
    {
        $backendUser = $this->‪getBackendUser();
        if ($backendUser->isAdmin()) {
            return true;
        }
        foreach ($this->optionValues as $value) {
            if ($backendUser->getTSConfig()['options.']['clearCache.'][$value] ?? false) {
                return true;
            }
        }
        return false;
    }
 
    public function ‪getItem(): string
    {
        $view = $this->backendViewFactory->create($this->request);
        if ($this->‪hasDropDown()) {
            return $view->render('ToolbarItems/ClearCacheToolbarItem');
        }
        $cacheAction = end($this->cacheActions);
        $view->assignMultiple([
            'link'  => $cacheAction['href'],
            'title' => $cacheAction['title'],
            'iconIdentifier'  => $cacheAction['iconIdentifier'],
        ]);
        return $view->render('ToolbarItems/ClearCacheToolbarItemSingle');
    }
 
    public function ‪getDropDown(): string
    {
        $view = $this->backendViewFactory->create($this->request);
        $view->assign('cacheActions', $this->cacheActions);
        return $view->render('ToolbarItems/ClearCacheToolbarItemDropDown');
    }
 
    public function ‪getAdditionalAttributes(): array
    {
        return [];
    }
 
    public function ‪hasDropDown(): bool
    {
        return count($this->cacheActions) > 1;
    }
 
    public function ‪getIndex(): int
    {
        return 25;
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}