AbstractProvider.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\ContextMenu\ItemProviders;
 
use ‪TYPO3\CMS\Backend\Clipboard\Clipboard;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪AbstractProvider implements ‪ProviderInterface
{
    protected ‪$languageService;
 
    protected ‪$backendUser;
 
    protected ‪$clipboard;
 
    protected ‪$itemsConfiguration = [];
 
    protected ‪$disabledItems = [];
 
    protected ‪$table = '';
 
    protected ‪$identifier = '';
 
    protected ‪$context = '';
 
    public function ‪__construct(string ‪$table, string ‪$identifier, string ‪$context = '')
    {
        $this->table = ‪$table;
        $this->identifier = ‪$identifier;
        $this->context = ‪$context;
        $this->languageService = ‪$GLOBALS['LANG'];
        $this->backendUser = ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪initialize()
    {
        $this->‪initClipboard();
        $this->‪initDisabledItems();
    }
 
    public function ‪getPriority(): int
    {
        return 100;
    }
 
    public function ‪canHandle(): bool
    {
        return false;
    }
 
    protected function ‪initClipboard()
    {
        ‪$clipboard = GeneralUtility::makeInstance(Clipboard::class);
        ‪$clipboard->‪initializeClipboard();
        // This locks the clipboard to the Normal for this request.
        ‪$clipboard->‪lockToNormal();
        // This removes all no longer existing elements
        ‪$clipboard->‪cleanCurrent();
        // This stores the changed clipboard data
        ‪$clipboard->‪endClipboard();
        $this->clipboard = ‪$clipboard;
    }
 
    protected function ‪initDisabledItems()
    {
        if ($this->context) {
            $tsConfigValue = $this->backendUser->getTSConfig()['options.']['contextMenu.']['table.'][$this->table . '.'][$this->context . '.']['disableItems'] ?? '';
        } else {
            $tsConfigValue = $this->backendUser->getTSConfig()['options.']['contextMenu.']['table.'][$this->table . '.']['disableItems'] ?? '';
        }
        $this->disabledItems = ‪GeneralUtility::trimExplode(',', $tsConfigValue, true);
    }
 
    public function ‪addItems(array $items): array
    {
        $this->‪initialize();
        $items += $this->‪prepareItems($this->itemsConfiguration);
        return $items;
    }
 
    protected function ‪prepareItems(array ‪$itemsConfiguration): array
    {
        $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
        $items = [];
        foreach (‪$itemsConfiguration as $name => $configuration) {
            $type = !empty($configuration['type']) ? $configuration['type'] : 'item';
            if ($this->‪canRender($name, $type)) {
                $items[$name] = [
                    'type' => $type,
                    'label' => !empty($configuration['label']) ? htmlspecialchars($this->languageService->sL($configuration['label'])) : '',
                    'icon' => !empty($configuration['iconIdentifier']) ? $iconFactory->getIcon($configuration['iconIdentifier'], ‪Icon::SIZE_SMALL)->render() : '',
                    'additionalAttributes' => $this->‪getAdditionalAttributes($name),
                    'callbackAction' => !empty($configuration['callbackAction']) ? $configuration['callbackAction'] : '',
                ];
                if ($type === 'submenu') {
                    $items[$name]['childItems'] = $this->‪prepareItems($configuration['childItems']);
                }
            }
        }
        return $items;
    }
 
    protected function ‪getAdditionalAttributes(string $itemName): array
    {
        return [];
    }
 
    protected function ‪canRender(string $itemName, string $type): bool
    {
        return true;
    }
 
    protected function ‪getIdentifier(): string
    {
        return '';
    }
}