AOE\Crawler\Task\CrawlerQueueTaskAdditionalFieldProvider

Complexity

Total Complexity

25

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getSelectedState()	0	10	3
A	getCrawlerConfigurationRecords()	0	15	2
F	getAdditionalFields()	0	83	14
A	saveAdditionalFields()	0	5	1
B	validateAdditionalFields()	0	22	5

<?php
namespace AOE\Crawler\Task;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2016 AOE GmbH <dev@aoe.com>
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use TYPO3\CMS\Backend\Utility\BackendUtility;

The type TYPO3\CMS\Backend\Utility\BackendUtility was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Core\Messaging\FlashMessage;

The type TYPO3\CMS\Core\Messaging\FlashMessage was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Core\Utility\MathUtility;

The type TYPO3\CMS\Core\Utility\MathUtility was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;

The type TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;

The type TYPO3\CMS\Scheduler\Controller\SchedulerModuleController was not found. Maybe you did not declare it correctly or list all dependencies?

use TYPO3\CMS\Scheduler\Task\AbstractTask;

The type TYPO3\CMS\Scheduler\Task\AbstractTask was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Class CrawlerQueueTaskAdditionalFieldProvider
 *
 * @package AOE\Crawler\Task
 * @codeCoverageIgnore
 */
class CrawlerQueueTaskAdditionalFieldProvider implements AdditionalFieldProviderInterface
{
    /**
     * Gets additional fields to render in the form to add/edit a task
     *
     * @param array $taskInfo
     * @param AbstractTask $task
     * @param SchedulerModuleController $schedulerModule
     *
     * @return array
     */
    public function getAdditionalFields(array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
    {
        $additionalFields = [];

        if (empty($taskInfo['configuration'])) {
            if ($schedulerModule->CMD == 'add') {
                $taskInfo['configuration'] = [];
            } elseif ($schedulerModule->CMD == 'edit') {
                $taskInfo['configuration'] = $task->configuration;
            } else {
                $taskInfo['configuration'] = $task->configuration;
            }
        }

        if (empty($taskInfo['startPage'])) {
            if ($schedulerModule->CMD == 'add') {
                $taskInfo['startPage'] = 0;
                if ($task instanceof \TYPO3\CMS\Scheduler\Task\AbstractTask) {
                    $task->startPage = 0;
                }
            } elseif ($schedulerModule->CMD == 'edit') {
                $taskInfo['startPage'] = $task->startPage;
            } else {
                $taskInfo['startPage'] = $task->startPage;
            }
        }

        if (empty($taskInfo['depth'])) {
            if ($schedulerModule->CMD == 'add') {
                $taskInfo['depth'] = [];
            } elseif ($schedulerModule->CMD == 'edit') {
                $taskInfo['depth'] = $task->depth;
            } else {
                $taskInfo['depth'] = $task->depth;
            }
        }

        // input for startPage
        $fieldId = 'task_startPage';
        $fieldCode = '<input name="tx_scheduler[startPage]" type="text" id="' . $fieldId . '" value="' . $task->startPage . '" class="form-control" />';
        $additionalFields[$fieldId] = [
            'code' => $fieldCode,
            'label' => 'LLL:EXT:crawler/Resources/Private/Language/Backend.xlf:crawler_im.startPage'
        ];

        // input for depth
        $fieldId = 'task_depth';
        $fieldValueArray = [
            '0' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.depth_0'),
            '1' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.depth_1'),
            '2' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.depth_2'),
            '3' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.depth_3'),
            '4' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.depth_4'),
            '99' => $GLOBALS['LANG']->sL('LLL:EXT:lang/Resources/Private/Language/locallang_core.xlf:labels.depth_infi'),
        ];
        $fieldCode = '<select name="tx_scheduler[depth]" id="' . $fieldId . '" class="form-control">';

        foreach ($fieldValueArray as $key => $label) {
            $fieldCode .= "\t" . '<option value="' . $key . '"' . (($key == $task->depth) ? ' selected="selected"' : '') . '>' . $label . '</option>';
        }

        $fieldCode .= '</select>';
        $additionalFields[$fieldId] = [
            'code' => $fieldCode,
            'label' => 'LLL:EXT:crawler/Resources/Private/Language/Backend.xlf:crawler_im.depth'
        ];

        // combobox for configuration records
        $recordsArray = $this->getCrawlerConfigurationRecords();
        $fieldId = 'task_configuration';
        $fieldCode = '<select name="tx_scheduler[configuration][]" multiple="multiple" id="' . $fieldId . '" class="form-control">';
        $fieldCode .= "\t" . '<option value=""></option>';
        for ($i = 0; $i < count($recordsArray); $i++) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

            $fieldCode .= "\t" . '<option ' . $this->getSelectedState($task->configuration, $recordsArray[$i]['name']) . 'value="' . $recordsArray[$i]['name'] . '">' . $recordsArray[$i]['name'] . '</option>';
        }
        $fieldCode .= '</select>';

        $additionalFields[$fieldId] = [
            'code' => $fieldCode,
            'label' => 'LLL:EXT:crawler/Resources/Private/Language/Backend.xlf:crawler_im.conf'
        ];

        return $additionalFields;
    }

    /**
     * Mark current value as selected by returning the "selected" attribute
     *
     * @param $configurationArray
     * @param $currentValue
     *
     * @return string
     */
    protected function getSelectedState($configurationArray, $currentValue)
    {
        $selected = '';
        for ($i = 0; $i < count($configurationArray); $i++) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

            if (strcmp($configurationArray[$i], $currentValue) === 0) {
                $selected = 'selected="selected" ';
            }
        }

        return $selected;
    }

    /**
     * Get all available configuration records.
     *
     * @return array which contains the available configuration records.
     */
    protected function getCrawlerConfigurationRecords()
    {
        $records = [];
        $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
            '*',
            'tx_crawler_configuration',
            '1=1' . BackendUtility::deleteClause('tx_crawler_configuration')
        );

        while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
            $records[] = $row;
        }
        $GLOBALS['TYPO3_DB']->sql_free_result($result);

        return $records;
    }

    /**
     * Validates the additional fields' values
     *
     * @param array $submittedData
     * @param SchedulerModuleController $schedulerModule
     * @return bool
     */
    public function validateAdditionalFields(array &$submittedData, SchedulerModuleController $schedulerModule)
    {
        $isValid = false;

        //!TODO add validation to validate the $submittedData['configuration'] which is normally a comma separated string
        if (is_array($submittedData['configuration'])) {
            $isValid = true;
        } else {
            $schedulerModule->addMessage($GLOBALS['LANG']->sL('LLL:EXT:crawler/Resources/Private/Language/Backend.xlf:crawler_im.invalidConfiguration'), FlashMessage::ERROR);
        }

        if ($submittedData['depth'] < 0) {
            $isValid = false;
            $schedulerModule->addMessage($GLOBALS['LANG']->sL('LLL:EXT:crawler/Resources/Private/Language/Backend.xlf:crawler_im.invalidDepth'), FlashMessage::ERROR);
        }

        if (!MathUtility::canBeInterpretedAsInteger($submittedData['startPage']) || $submittedData['startPage'] < 0) {
            $isValid = false;
            $schedulerModule->addMessage($GLOBALS['LANG']->sL('LLL:EXT:crawler/Resources/Private/Language/Backend.xlf:crawler_im.invalidStartPage'), FlashMessage::ERROR);
        }

        return $isValid;
    }

    /**
     * Takes care of saving the additional fields' values in the task's object
     *
     * @param array $submittedData
     * @param AbstractTask $task
     * @return void
     */
    public function saveAdditionalFields(array $submittedData, AbstractTask $task)
    {
        $task->depth = intval($submittedData['depth']);
        $task->configuration = $submittedData['configuration'];
        $task->startPage = intval($submittedData['startPage']);
    }
}