CleanerFieldProvider.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\Recycler\Task;
 
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;
use ‪TYPO3\CMS\Scheduler\Task\AbstractTask;
 
class ‪CleanerFieldProvider extends ‪AbstractAdditionalFieldProvider
{
    public function ‪getAdditionalFields(array &$taskInfo, $task, ‪SchedulerModuleController $schedulerModule)
    {
        $currentSchedulerModuleAction = $schedulerModule->‪getCurrentAction();
 
        if ($currentSchedulerModuleAction === SchedulerManagementAction::EDIT) {
            $taskInfo['RecyclerCleanerTCA'] = $task->getTcaTables();
            $taskInfo['RecyclerCleanerPeriod'] = $task->getPeriod();
        }
 
        $additionalFields = [];
        $fieldCode = '<input type="number" class="form-control" name="tx_scheduler[RecyclerCleanerPeriod]" value="' . ($taskInfo['RecyclerCleanerPeriod'] ?? 0) . '" min="1">';
        $additionalFields['period'] = [
            'code' => $fieldCode,
            'label' => 'LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskPeriod',
            'cshKey' => '',
            'cshLabel' => 'task_recyclerCleaner_selectedPeriod',
            'type' => 'input',
        ];
 
        $additionalFields['tca'] = [
            'code' => $this->‪getTcaSelectHtml($taskInfo['RecyclerCleanerTCA'] ?? []),
            'label' => 'LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskTCA',
            'cshKey' => '',
            'cshLabel' => 'task_recyclerCleaner_selectedTables',
            'type' => 'select',
        ];
 
        return $additionalFields;
    }
 
    protected function ‪getTcaSelectHtml($selectedTables = [])
    {
        if (!is_array($selectedTables)) {
            $selectedTables = [];
        }
        $tcaSelectHtml = '<select name="tx_scheduler[RecyclerCleanerTCA][]" multiple="multiple" class="form-select" size="10">';
 
        $options = [];
        foreach (‪$GLOBALS['TCA'] as $table => $tableConf) {
            if (!empty($tableConf['ctrl']['delete'])) {
                $selected = in_array($table, $selectedTables, true) ? ' selected="selected"' : '';
                $tableTitle = !empty($tableConf['ctrl']['title']) ? $this->‪getLanguageService()->sL($tableConf['ctrl']['title']) : '';
                $options[$tableTitle . ' ' . $table] = '<option' . $selected . ' value="' . $table . '">' . htmlspecialchars($tableTitle . ' (' . $table . ')') . '</option>';
            }
        }
        ksort($options);
 
        $tcaSelectHtml .= implode('', $options);
        $tcaSelectHtml .= '</select>';
 
        return $tcaSelectHtml;
    }
 
    public function ‪validateAdditionalFields(array &$submittedData, ‪SchedulerModuleController $schedulerModule)
    {
        $validPeriod = $this->‪validateAdditionalFieldPeriod($submittedData['RecyclerCleanerPeriod']);
        $validTca = $this->‪validateAdditionalFieldTca($submittedData['RecyclerCleanerTCA'] ?? []);
 
        return $validPeriod && $validTca;
    }
 
    protected function ‪validateAdditionalFieldTca(‪$tca)
    {
        return $this->‪checkTcaIsNotEmpty(‪$tca) && $this->‪checkTcaIsValid(‪$tca);
    }
 
    protected function ‪checkTcaIsNotEmpty(‪$tca)
    {
        if (is_array(‪$tca) && !empty(‪$tca)) {
            $validTca = true;
        } else {
            $this->‪addMessage(
                $this->‪getLanguageService()->sL('LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskErrorTCAempty'),
                ContextualFeedbackSeverity::ERROR
            );
            $validTca = false;
        }
 
        return $validTca;
    }
 
    protected function ‪checkTcaIsValid(array ‪$tca)
    {
        $checkTca = false;
        foreach (‪$tca as $tcaTable) {
            if (!isset(‪$GLOBALS['TCA'][$tcaTable])) {
                $checkTca = false;
                $this->‪addMessage(
                    sprintf($this->‪getLanguageService()->sL('LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskErrorTCANotSet'), $tcaTable),
                    ContextualFeedbackSeverity::ERROR
                );
                break;
            }
            $checkTca = true;
        }
 
        return $checkTca;
    }
 
    protected function ‪validateAdditionalFieldPeriod($period)
    {
        if (filter_var($period, FILTER_VALIDATE_INT) !== false && $period > 0) {
            $validPeriod = true;
        } else {
            $this->‪addMessage(
                $this->‪getLanguageService()->sL('LLL:EXT:recycler/Resources/Private/Language/locallang_tasks.xlf:cleanerTaskErrorPeriod'),
                ContextualFeedbackSeverity::ERROR
            );
            $validPeriod = false;
        }
 
        return $validPeriod;
    }
 
    public function ‪saveAdditionalFields(array $submittedData, ‪AbstractTask $task)
    {
        if (!$task instanceof ‪CleanerTask) {
            throw new \InvalidArgumentException(
                'Expected a task of type ' . CleanerTask::class . ', but got ' . get_class($task),
                1329219449
            );
        }
 
        $task->setTcaTables($submittedData['RecyclerCleanerTCA']);
        $task->setPeriod($submittedData['RecyclerCleanerPeriod']);
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
}