ApacheSolrForTypo3\Solr\Task\ReIndexTaskAdditionalFieldProvider

Complexity

Total Complexity

14

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize()	0	13	2
B	getAdditionalFields()	0	27	1
A	getIndexingConfigurationSelector()	0	18	2
A	validateAdditionalFields()	0	14	2
A	saveAdditionalFields()	0	14	2
A	getPageRenderer()	0	7	2
A	isTaskInstanceofReIndexTask()	0	9	3

<?php
namespace ApacheSolrForTypo3\Solr\Task;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2011-2015 Christoph Moeller <support@network-publishing.de>
 *  (c) 2012-2015 Ingo Renner <ingo@typo3.org>
 *
 *  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 2 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 ApacheSolrForTypo3\Solr\Backend\IndexingConfigurationSelectorField;
use ApacheSolrForTypo3\Solr\Site;
use TYPO3\CMS\Core\Page\PageRenderer;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use TYPO3\CMS\Scheduler\Task\AbstractTask;

/**
 * Adds an additional field to specify the Solr server to initialize the index queue for
 *
 * @author Christoph Moeller <support@network-publishing.de>
 */
class ReIndexTaskAdditionalFieldProvider implements AdditionalFieldProviderInterface
{

    /**
     * Task information
     *
     * @var array
     */
    protected $taskInformation;

    /**
     * Scheduler task
     *
     * @var AbstractTask|ReIndexTask|NULL
     */
    protected $task = null;

    /**
     * Scheduler Module
     *
     * @var SchedulerModuleController
     */
    protected $schedulerModule;

    /**
     * Selected site
     *
     * @var Site
     */
    protected $site = null;

    /**
     * @var PageRenderer
     */
    protected $pageRenderer = null;

    /**
     *
     * @param array $taskInfo
     * @param \TYPO3\CMS\Scheduler\Task\AbstractTask|NULL $task
     * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule
     */
    protected function initialize(
        array $taskInfo,
        AbstractTask $task = null,
        SchedulerModuleController $schedulerModule
    ) {
        $this->taskInformation = $taskInfo;
        $this->task = $task;
        $this->schedulerModule = $schedulerModule;

        if ($schedulerModule->CMD == 'edit') {
            $this->site = $task->getSite();

It seems like you code against a specific sub-type and not the parent class TYPO3\CMS\Scheduler\Task\AbstractTask as the method getSite() does only exist in the following sub-classes of TYPO3\CMS\Scheduler\Task\AbstractTask: ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask, ApacheSolrForTypo3\Solr\Task\ReIndexTask. Maybe you want to instanceof check for one of these explicitly?

        }
    }

    /**
     * Used to define fields to provide the Solr server address when adding
     * or editing a task.
     *
     * @param array $taskInfo reference to the array containing the info used in the add/edit form
     * @param AbstractTask $task when editing, reference to the current task object. Null when adding.
     * @param SchedulerModuleController $schedulerModule reference to the calling object (Scheduler's BE module)
     * @return array Array containing all the information pertaining to the additional fields
     *                        The array is multidimensional, keyed to the task class name and each field's id
     *                        For each field it provides an associative sub-array with the following:
     */
    public function getAdditionalFields(
        array &$taskInfo,
        $task,
        SchedulerModuleController $schedulerModule
    ) {
        $this->isTaskInstanceofReIndexTask($task);

        $this->initialize($taskInfo, $task, $schedulerModule);
        $additionalFields = [];

        $additionalFields['site'] = [
            'code' => Site::getAvailableSitesSelector('tx_scheduler[site]',
                $this->site),
            'label' => 'LLL:EXT:solr/Resources/Private/Language/locallang.xlf:field_site',
            'cshKey' => '',
            'cshLabel' => ''
        ];

        $additionalFields['indexingConfigurations'] = [
            'code' => $this->getIndexingConfigurationSelector(),
            'label' => 'Index Queue configurations to re-index',
            'cshKey' => '',
            'cshLabel' => ''
        ];

        return $additionalFields;
    }

    protected function getIndexingConfigurationSelector()
    {
        $selectorMarkup = 'Please select a site first.';
        $this->getPageRenderer()->addCssFile('../typo3conf/ext/solr/Resources/Css/Backend/indexingconfigurationselectorfield.css');

        if (is_null($this->site)) {
            return $selectorMarkup;
        }

        $selectorField = GeneralUtility::makeInstance(IndexingConfigurationSelectorField::class, $this->site);

        $selectorField->setFormElementName('tx_scheduler[indexingConfigurations]');
        $selectorField->setSelectedValues($this->task->getIndexingConfigurationsToReIndex());

The method getIndexingConfigurationsToReIndex does only exist in ApacheSolrForTypo3\Solr\Task\ReIndexTask, but not in TYPO3\CMS\Scheduler\Task\AbstractTask.

        $selectorMarkup = $selectorField->render();

        return $selectorMarkup;
    }

    /**
     * Checks any additional data that is relevant to this task. If the task
     * class is not relevant, the method is expected to return TRUE
     *
     * @param array $submittedData reference to the array containing the data submitted by the user
     * @param SchedulerModuleController $schedulerModule reference to the calling object (Scheduler's BE module)
     * @return bool True if validation was ok (or selected class is not relevant), FALSE otherwise
     */
    public function validateAdditionalFields(
        array &$submittedData,
        SchedulerModuleController $schedulerModule
    ) {
        $result = false;

        // validate site
        $sites = Site::getAvailableSites();
        if (array_key_exists($submittedData['site'], $sites)) {
            $result = true;
        }

        return $result;
    }

    /**
     * Saves any additional input into the current task object if the task
     * class matches.
     *
     * @param array $submittedData array containing the data submitted by the user
     * @param AbstractTask $task reference to the current task object
     */
    public function saveAdditionalFields(
        array $submittedData,
        AbstractTask $task
    ) {
        $this->isTaskInstanceofReIndexTask($task);

        $task->setSite(GeneralUtility::makeInstance(Site::class, $submittedData['site']));

It seems like you code against a specific sub-type and not the parent class TYPO3\CMS\Scheduler\Task\AbstractTask as the method setSite() does only exist in the following sub-classes of TYPO3\CMS\Scheduler\Task\AbstractTask: ApacheSolrForTypo3\Solr\Task\IndexQueueWorkerTask, ApacheSolrForTypo3\Solr\Task\ReIndexTask. Maybe you want to instanceof check for one of these explicitly?

        $indexingConfigurations = [];
        if (!empty($submittedData['indexingConfigurations'])) {
            $indexingConfigurations = $submittedData['indexingConfigurations'];
        }
        $task->setIndexingConfigurationsToReIndex($indexingConfigurations);

It seems like you code against a specific sub-type and not the parent class TYPO3\CMS\Scheduler\Task\AbstractTask as the method setIndexingConfigurationsToReIndex() does only exist in the following sub-classes of TYPO3\CMS\Scheduler\Task\AbstractTask: ApacheSolrForTypo3\Solr\Task\ReIndexTask. Maybe you want to instanceof check for one of these explicitly?

    }

    /**
     * @return PageRenderer
     */
    protected function getPageRenderer()
    {
        if (!isset($this->pageRenderer)) {
            $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
        }
        return $this->pageRenderer;
    }

    /**
     * Check that a task is an instance of ReIndexTask
     *
     * @param $task
     * @throws \LogicException
     */
    protected function isTaskInstanceofReIndexTask($task)
    {
        if ((!is_null($task)) && (!($task instanceof ReIndexTask))) {
            throw new \LogicException(
                '$task must be an instance of ReIndexTask, '
                . 'other instances are not supported.', 1487500366
            );
        }
    }
}