CachingFrameworkGarbageCollectionAdditionalFieldProvider.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Scheduler\Task;
 
use ‪TYPO3\CMS\Core\Cache\Backend\Typo3DatabaseBackend;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider;
use ‪TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use ‪TYPO3\CMS\Scheduler\SchedulerManagementAction;
 
class ‪CachingFrameworkGarbageCollectionAdditionalFieldProvider extends ‪AbstractAdditionalFieldProvider
{
    public function ‪getAdditionalFields(array &$taskInfo, $task, ‪SchedulerModuleController $schedulerModule)
    {
        $currentSchedulerModuleAction = $schedulerModule->‪getCurrentAction();
 
        // Initialize selected fields
        if (empty($taskInfo['scheduler_cachingFrameworkGarbageCollection_selectedBackends'])) {
            $taskInfo['scheduler_cachingFrameworkGarbageCollection_selectedBackends'] = [];
            if ($currentSchedulerModuleAction === SchedulerManagementAction::ADD) {
                // In case of new task, set to dbBackend if it's available
                if (in_array(Typo3DatabaseBackend::class, $this->‪getRegisteredBackends())) {
                    $taskInfo['scheduler_cachingFrameworkGarbageCollection_selectedBackends'][] = Typo3DatabaseBackend::class;
                }
            } elseif ($currentSchedulerModuleAction === SchedulerManagementAction::EDIT) {
                // In case of editing the task, set to currently selected value
                $taskInfo['scheduler_cachingFrameworkGarbageCollection_selectedBackends'] = $task->selectedBackends;
            }
        }
        $fieldName = 'tx_scheduler[scheduler_cachingFrameworkGarbageCollection_selectedBackends][]';
        $fieldId = 'task_cachingFrameworkGarbageCollection_selectedBackends';
        $fieldOptions = $this->‪getCacheBackendOptions($taskInfo['scheduler_cachingFrameworkGarbageCollection_selectedBackends']);
        $fieldHtml = '<select class="form-select" name="' . $fieldName . '" id="' . $fieldId . '" size="10" multiple="multiple">'
            . $fieldOptions . '</select>';
        $additionalFields = [];
        $additionalFields[$fieldId] = [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.cachingFrameworkGarbageCollection.selectBackends',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId,
            'type' => 'select',
        ];
        return $additionalFields;
    }
 
    public function ‪validateAdditionalFields(array &$submittedData, ‪SchedulerModuleController $schedulerModule)
    {
        $validData = true;
        $availableBackends = $this->‪getRegisteredBackends();
        if (is_array($submittedData['scheduler_cachingFrameworkGarbageCollection_selectedBackends'])) {
            $invalidBackends = array_diff($submittedData['scheduler_cachingFrameworkGarbageCollection_selectedBackends'], $availableBackends);
            if (!empty($invalidBackends)) {
                $this->‪addMessage($this->‪getLanguageService()->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:msg.selectionOfNonExistingCacheBackends'), ContextualFeedbackSeverity::ERROR);
                $validData = false;
            }
        } else {
            $this->‪addMessage($this->‪getLanguageService()->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:msg.noCacheBackendSelected'), ContextualFeedbackSeverity::ERROR);
            $validData = false;
        }
        return $validData;
    }
 
    public function ‪saveAdditionalFields(array $submittedData, ‪AbstractTask $task)
    {
        $task->selectedBackends = $submittedData['scheduler_cachingFrameworkGarbageCollection_selectedBackends'];
    }
 
    protected function ‪getCacheBackendOptions(array $selectedBackends)
    {
        $options = [];
        $availableBackends = $this->‪getRegisteredBackends();
        foreach ($availableBackends as $backendName) {
            if (in_array($backendName, $selectedBackends)) {
                $selected = ' selected="selected"';
            } else {
                $selected = '';
            }
            $options[] = '<option value="' . $backendName . '"' . $selected . '>' . $backendName . '</option>';
        }
        return implode('', $options);
    }
 
    protected function ‪getRegisteredBackends()
    {
        $backends = [];
        $cacheConfigurations = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['caching']['cacheConfigurations'];
        if (is_array($cacheConfigurations)) {
            foreach ($cacheConfigurations as $cacheConfiguration) {
                $backend = (string)($cacheConfiguration['backend'] ?? Typo3DatabaseBackend::class);
                if (!in_array($backend, $backends, true)) {
                    $backends[] = $backend;
                }
            }
        }
        return $backends;
    }
 
    protected function ‪getLanguageService(): ?‪LanguageService
    {
        return ‪$GLOBALS['LANG'] ?? null;
    }
}