9.5/_file_storage_extraction_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\Resource\Index\ExtractorInterface;

use ‪TYPO3\CMS\Core\Resource\Index\ExtractorRegistry;

use ‪TYPO3\CMS\Core\Resource\ResourceFactory;

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

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

use ‪TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;

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


class ‪FileStorageExtractionAdditionalFieldProvider implements ‪AdditionalFieldProviderInterface

{

    public function ‪getAdditionalFields(array &$taskInfo, $task, ‪SchedulerModuleController $parentObject)

    {

        if ($task !== null && !$task instanceof ‪FileStorageExtractionTask) {

            throw new \InvalidArgumentException('Task not of type FileStorageExtractionTask', 1384275695);

        }

        $additionalFields['scheduler_fileStorageIndexing_storage'] = $this->‪getAllStoragesField($task);

        $additionalFields['scheduler_fileStorageIndexing_fileCount'] = $this->‪getFileCountField($task);

        $additionalFields['scheduler_fileStorageIndexing_registeredExtractors'] = $this->‪getRegisteredExtractorsField($task);

        return $additionalFields;

    }


    protected function ‪getAllStoragesField(‪FileStorageExtractionTask $task = null)

    {

        $storages = GeneralUtility::makeInstance(\‪TYPO3\CMS\Core\Resource\StorageRepository::class)->findAll();

        $options = [];

        foreach ($storages as $storage) {

            if ($task !== null && $task->storageUid === $storage->getUid()) {

                $options[] = '<option value="' . $storage->getUid() . '" selected="selected">' . $storage->getName() . '</option>';

            } else {

                $options[] = '<option value="' . $storage->getUid() . '">' . $storage->getName() . '</option>';

            }

        }


        $fieldName = 'tx_scheduler[scheduler_fileStorageIndexing_storage]';

        $fieldId = 'scheduler_fileStorageIndexing_storage';

        $fieldHtml = '<select class="form-control" name="' . $fieldName . '" id="' . $fieldId . '">' . implode("\n", $options) . '</select>';


        $fieldConfiguration = [

            'code' => $fieldHtml,

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

            'cshKey' => '_MOD_system_txschedulerM1',

            'cshLabel' => $fieldId

        ];

        return $fieldConfiguration;

    }


    protected function ‪getFileCountField(‪FileStorageExtractionTask $task = null)

    {

        $fieldName = 'tx_scheduler[scheduler_fileStorageIndexing_fileCount]';

        $fieldId = 'scheduler_fileStorageIndexing_fileCount';

        $fieldValue = $task !== null ? (int)$task->maxFileCount : 100;

        $fieldHtml = '<input type="text" class="form-control" name="' . $fieldName . '" id="' . $fieldId . '" value="' . htmlspecialchars($fieldValue) . '">';


        $fieldConfiguration = [

            'code' => $fieldHtml,

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

            'cshKey' => '_MOD_system_txschedulerM1',

            'cshLabel' => $fieldId

        ];

        return $fieldConfiguration;

    }


    protected function ‪getRegisteredExtractorsField(‪FileStorageExtractionTask $task = null)

    {

        $extractors = ‪ExtractorRegistry::getInstance()->‪getExtractors();


        if (empty($extractors)) {

            $labelKey = 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.fileStorageExtraction.registeredExtractors.without_extractors';

            $content = '<span class="label label-warning">'

                . htmlspecialchars($this->‪getLanguageService()->sL($labelKey))

                . '</span>';

        } else {

            // Assemble the extractor bullet list first.

            $labelKey = 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.fileStorageExtraction.registeredExtractors.extractor';

            $bullets = [];

            foreach ($extractors as $extractor) {

                $bullets[] = sprintf(

                    '<li title="%s">%s</li>',

                    get_class($extractor),

                    sprintf($this->‪getLanguageService()->sL($labelKey), $this->‪formatExtractorClassName($extractor), $extractor->getPriority())

                );

            }


            // Finalize content assembling.

            $labelKey = 'LLL:EXT:scheduler/Resources/Private/Language/locallang.xlf:label.fileStorageExtraction.registeredExtractors.with_extractors';

            $title = $this->‪getLanguageService()->‪sL($labelKey);

            $content = '<p>' . htmlspecialchars($title) . '</p>';

            $content .= '<ul>' . implode(LF, $bullets) . '</ul>';

        }


        $fieldConfiguration = [

            'code' => $content,

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

            'cshKey' => '_MOD_system_txschedulerM1',

            'cshLabel' => 'scheduler_fileStorageIndexing_registeredExtractors'

        ];

        return $fieldConfiguration;

    }


    public function ‪validateAdditionalFields(array &$submittedData, ‪SchedulerModuleController $parentObject)

    {

        if (

            !‪MathUtility::canBeInterpretedAsInteger($submittedData['scheduler_fileStorageIndexing_storage'])

            || !‪MathUtility::canBeInterpretedAsInteger($submittedData['scheduler_fileStorageIndexing_fileCount'])

        ) {

            return false;

        }

        if (‪ResourceFactory::getInstance()->getStorageObject($submittedData['scheduler_fileStorageIndexing_storage']) === null) {

            return false;

        }

        if (!‪MathUtility::isIntegerInRange($submittedData['scheduler_fileStorageIndexing_fileCount'], 1, 9999)) {

            return false;

        }

        return true;

    }


    public function ‪saveAdditionalFields(array $submittedData, ‪AbstractTask $task)

    {

        if (!$task instanceof ‪FileStorageExtractionTask) {

            throw new \InvalidArgumentException('Task not of type FileStorageExtractionTask', 1384275698);

        }

        $task->storageUid = (int)$submittedData['scheduler_fileStorageIndexing_storage'];

        $task->maxFileCount = (int)$submittedData['scheduler_fileStorageIndexing_fileCount'];

    }


    protected function ‪formatExtractorClassName(‪ExtractorInterface $extractor)

    {

        $extractorParts = explode('\\', get_class($extractor));

        return array_pop($extractorParts);

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }

}