9.5/_clear_cache_toolbar_item_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\Backend\ToolbarItems;


/*

 * 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!

 */


use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Backend\Toolbar\ClearCacheActionsHookInterface;

use ‪TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Page\PageRenderer;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Fluid\View\StandaloneView;


class ‪ClearCacheToolbarItem implements ‪ToolbarItemInterface

{

    protected ‪$cacheActions = [];


    protected ‪$optionValues = [];


    public function ‪__construct()

    {

        $this->‪getPageRenderer()->‪loadRequireJsModule('TYPO3/CMS/Backend/Toolbar/ClearCacheMenu');

        $isAdmin = $this->‪getBackendUser()->‪isAdmin();

        $userTsConfig = $this->‪getBackendUser()->‪getTSConfig();

        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);


        // 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']),

                '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']),

                'iconIdentifier' => 'actions-system-cache-clear-impact-high'

            ];

            $this->optionValues[] = 'all';

        }


        // Hook for manipulating cacheActions

        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['additionalBackendItems']['cacheActions'] ?? [] as $cacheAction) {

            $hookObject = GeneralUtility::makeInstance($cacheAction);

            if (!$hookObject instanceof ‪ClearCacheActionsHookInterface) {

                throw new \UnexpectedValueException($cacheAction . ' must implement interface ' . ClearCacheActionsHookInterface::class, 1228262000);

            }

            $hookObject->manipulateCacheActions($this->cacheActions, $this->optionValues);

        }

    }


    public function ‪checkAccess()

    {

        $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()

    {

        if ($this->‪hasDropDown()) {

            return $this->‪getFluidTemplateObject('ClearCacheToolbarItem.html')->‪render();

        }

        $view = $this->‪getFluidTemplateObject('ClearCacheToolbarItemSingle.html');

        $cacheAction = end($this->cacheActions);

        $view->assignMultiple([

                'link'  => $cacheAction['href'],

                'title' => $cacheAction['title'],

                'iconIdentifier'  => $cacheAction['iconIdentifier'],

            ]);

        return $view->render();

    }


    public function ‪getDropDown()

    {

        $view = $this->‪getFluidTemplateObject('ClearCacheToolbarItemDropDown.html');

        $view->assign('cacheActions', $this->cacheActions);

        return $view->render();

    }


    public function ‪getAdditionalAttributes()

    {

        return [];

    }


    public function ‪hasDropDown()

    {

        return count($this->cacheActions) > 1;

    }


    public function ‪getIndex()

    {

        return 25;

    }


    protected function ‪getBackendUser()

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getPageRenderer()

    {

        return GeneralUtility::makeInstance(PageRenderer::class);

    }


    protected function ‪getFluidTemplateObject(string $filename): ‪StandaloneView

    {

        $view = GeneralUtility::makeInstance(StandaloneView::class);

        $view->setLayoutRootPaths(['EXT:backend/Resources/Private/Layouts']);

        $view->setPartialRootPaths(['EXT:backend/Resources/Private/Partials/ToolbarItems']);

        $view->setTemplateRootPaths(['EXT:backend/Resources/Private/Templates/ToolbarItems']);


        $view->setTemplate($filename);


        $view->getRequest()->setControllerExtensionName('Backend');

        return $view;

    }

}