9.5/_caching_framework_garbage_collection_additional_field_provider_8php_source.html

<?php

namespace ‪TYPO3\CMS\Scheduler\Task;


/*

 * 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\Core\Cache\Backend\Typo3DatabaseBackend;

use ‪TYPO3\CMS\Core\Messaging\FlashMessage;

use ‪TYPO3\CMS\Scheduler\AbstractAdditionalFieldProvider;

use ‪TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;

use ‪TYPO3\CMS\Scheduler\Task\Enumeration\Action;


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->equals(‪Action::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->equals(‪Action::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-control" name="' . $fieldName . '" id="' . $fieldId . '" class="from-control" size="10" multiple="multiple">' . $fieldOptions . '</select>';

        $additionalFields[$fieldId] = [

            'code' => $fieldHtml,

            'label' => 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.cachingFrameworkGarbageCollection.selectBackends',

            'cshKey' => '_MOD_system_txschedulerM1',

            'cshLabel' => $fieldId

        ];

        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(‪$GLOBALS['LANG']->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:msg.selectionOfNonExistingCacheBackends'), ‪FlashMessage::ERROR);

                $validData = false;

            }

        } else {

            $this->‪addMessage(‪$GLOBALS['LANG']->sL('LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:msg.noCacheBackendSelected'), ‪FlashMessage::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 = $cacheConfiguration['backend'];

                if (!in_array($backend, $backends)) {

                    $backends[] = $backend;

                }

            }

        }

        return $backends;

    }

}