ReindexAdditionalFieldProvider::getAdditionalFields() - Code Metrics - Inspection of "[pull] master from kitodo:master" - Erikmitk/kitodo-presentation - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#123)

unknown

created 2024-07-29 12:57 UTC

getAdditionalFields() A

↳ Parent: ReindexAdditionalFieldProvider

Complexity

Conditions	3
Paths	4

Size

Total Lines	61
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
eloc	39
c	1
b	0
f	0
nc	4
nop	3
dl	0
loc	61
rs	9.296

How to fix Long Method

<?php

/**
 * (c) Kitodo. Key to digital objects e.V. <[email protected]>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */
namespace Kitodo\Dlf\Task;

use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use TYPO3\CMS\Scheduler\Task\Enumeration\Action;

/**
 * Additional fields for reindex documents task.
 *
 * @package TYPO3
 * @subpackage dlf
 *
 * @access public
 */
class ReindexAdditionalFieldProvider extends BaseAdditionalFieldProvider
{
    /**
     * Gets additional fields to render in the form to add/edit a task
     *
     * @param array $taskInfo Values of the fields from the add/edit task form
     * @param BaseTask $task The task object being edited. Null when adding a task!
     * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule Reference to the scheduler backend module
     * @return array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
     */
    public function getAdditionalFields(array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
    {
        $currentSchedulerModuleAction = $schedulerModule->getCurrentAction();

        /** @var BaseTask $task */
        if ($currentSchedulerModuleAction->equals(Action::EDIT)) {
            $taskInfo['dryRun'] = $task->isDryRun();
            $taskInfo['coll'] = $task->getColl();
            $taskInfo['pid'] = $task->getPid();
            $taskInfo['solr'] = $task->getSolr();
            $taskInfo['owner'] = $task->getOwner();
            $taskInfo['all'] = $task->isAll();
        } else {
            $taskInfo['dryRun'] = false;
            $taskInfo['coll'] = [];
            $taskInfo['pid'] = - 1;
            $taskInfo['solr'] = - 1;
            $taskInfo['owner'] = '';
            $taskInfo['all'] = false;
        }

        $additionalFields = [];

        // Checkbox for dry-run
        $additionalFields['dryRun'] = $this->getDryRunField($taskInfo['dryRun']);

        // Select for collection(s)
        $fieldName = 'coll';
        $fieldId = 'task_' . $fieldName;
        $options = $this->getCollOptions($taskInfo['coll'], $taskInfo['pid']);
        ;
        $fieldHtml = '<select name="tx_scheduler[' . $fieldName . '][]" id="' . $fieldId . '" size="10" multiple="multiple">' . implode("\n", $options) . '</select>';
        $additionalFields[$fieldId] = [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.coll',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId
        ];

        // DropDown for storage page
        $additionalFields['pid'] = $this->getPidField($taskInfo['pid']);

        // DropDown for Solr core
        $additionalFields['solr'] = $this->getSolrField($taskInfo['solr'], $taskInfo['pid']);

        // Text field for owner
        $additionalFields['owner'] = $this->getOwnerField($taskInfo['owner']);

        // Checkbox for all
        $fieldName = 'all';
        $fieldId = 'task_' . $fieldName;
        $fieldHtml = '<input type="checkbox" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="1"' .
            ($taskInfo['all'] ? ' checked="checked"' : '') . '>';
        $additionalFields[$fieldId] = [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.all',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId
        ];

        return $additionalFields;
    }

    /**
     * Generates HTML options for collections
     *
     * @param array $coll Selected collections
     * @param int $pid UID of storage page
     *
     * @return array HTML of selectbox options
     */
    private function getCollOptions(array $coll, int $pid): array
    {
        $options = [];
        $collections = $this->getCollections($pid);
        foreach ($collections as $label => $uid) {
            $options[] = '<option value="' . $uid . '" ' . (in_array($uid, $coll) ? 'selected' : '') . ' >' . $label . '</option>';
        }
        return $options;
    }

    /**
     * Fetches all collections on given storage page.
     *
     * @access protected
     *
     * @param int $pid The UID of the storage page
     *
     * @return array Array of collections
     */
    private function getCollections(int $pid): array
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tx_dlf_collections');

        $collections = [];
        $result = $queryBuilder->select('uid', 'label')
            ->from('tx_dlf_collections')
            ->where(
                $queryBuilder->expr()
                    ->eq('pid', $queryBuilder->createNamedParameter((int) $pid, Connection::PARAM_INT))
            )
            ->execute();

        while ($record = $result->fetchAssociative()) {
            $collections[$record['label']] = $record['uid'];
        }

        return $collections;
    }
}


1			<?php
2
3			/**
4			* (c) Kitodo. Key to digital objects e.V. <[email protected]>
5			*
6			* This file is part of the Kitodo and TYPO3 projects.
7			*
8			* @license GNU General Public License version 3 or later.
9			* For the full copyright and license information, please read the
10			* LICENSE.txt file that was distributed with this source code.
11			*/
12			namespace Kitodo\Dlf\Task;
13
14			use TYPO3\CMS\Core\Database\Connection;
15			use TYPO3\CMS\Core\Database\ConnectionPool;
16			use TYPO3\CMS\Core\Utility\GeneralUtility;
17			use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
18			use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
19
20			/**
21			* Additional fields for reindex documents task.
22			*
23			* @package TYPO3
24			* @subpackage dlf
25			*
26			* @access public
27			*/
28			class ReindexAdditionalFieldProvider extends BaseAdditionalFieldProvider
29			{
30			/**
31			* Gets additional fields to render in the form to add/edit a task
32			*
33			* @param array $taskInfo Values of the fields from the add/edit task form
34			* @param BaseTask $task The task object being edited. Null when adding a task!
35			* @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule Reference to the scheduler backend module
36			* @return array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
37			*/
38			public function getAdditionalFields(array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
39			{
40			$currentSchedulerModuleAction = $schedulerModule->getCurrentAction();
41
42			/** @var BaseTask $task */
43			if ($currentSchedulerModuleAction->equals(Action::EDIT)) {
44			$taskInfo['dryRun'] = $task->isDryRun();
45			$taskInfo['coll'] = $task->getColl();
46			$taskInfo['pid'] = $task->getPid();
47			$taskInfo['solr'] = $task->getSolr();
48			$taskInfo['owner'] = $task->getOwner();
49			$taskInfo['all'] = $task->isAll();
50			} else {
51			$taskInfo['dryRun'] = false;
52			$taskInfo['coll'] = [];
53			$taskInfo['pid'] = - 1;
54			$taskInfo['solr'] = - 1;
55			$taskInfo['owner'] = '';
56			$taskInfo['all'] = false;
57			}
58
59			$additionalFields = [];
60
61			// Checkbox for dry-run
62			$additionalFields['dryRun'] = $this->getDryRunField($taskInfo['dryRun']);
63
64			// Select for collection(s)
65			$fieldName = 'coll';
66			$fieldId = 'task_' . $fieldName;
67			$options = $this->getCollOptions($taskInfo['coll'], $taskInfo['pid']);
68			;
69			$fieldHtml = '<select name="tx_scheduler[' . $fieldName . '][]" id="' . $fieldId . '" size="10" multiple="multiple">' . implode("\n", $options) . '</select>';
70			$additionalFields[$fieldId] = [
71			'code' => $fieldHtml,
72			'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.coll',
73			'cshKey' => '_MOD_system_txschedulerM1',
74			'cshLabel' => $fieldId
75			];
76
77			// DropDown for storage page
78			$additionalFields['pid'] = $this->getPidField($taskInfo['pid']);
79
80			// DropDown for Solr core
81			$additionalFields['solr'] = $this->getSolrField($taskInfo['solr'], $taskInfo['pid']);
82
83			// Text field for owner
84			$additionalFields['owner'] = $this->getOwnerField($taskInfo['owner']);
85
86			// Checkbox for all
87			$fieldName = 'all';
88			$fieldId = 'task_' . $fieldName;
89			$fieldHtml = '<input type="checkbox" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="1"' .
90			($taskInfo['all'] ? ' checked="checked"' : '') . '>';
91			$additionalFields[$fieldId] = [
92			'code' => $fieldHtml,
93			'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.all',
94			'cshKey' => '_MOD_system_txschedulerM1',
95			'cshLabel' => $fieldId
96			];
97
98			return $additionalFields;
99			}
100
101			/**
102			* Generates HTML options for collections
103			*
104			* @param array $coll Selected collections
105			* @param int $pid UID of storage page
106			*
107			* @return array HTML of selectbox options
108			*/
109			private function getCollOptions(array $coll, int $pid): array
110			{
111			$options = [];
112			$collections = $this->getCollections($pid);
113			foreach ($collections as $label => $uid) {
114			$options[] = '<option value="' . $uid . '" ' . (in_array($uid, $coll) ? 'selected' : '') . ' >' . $label . '</option>';
115			}
116			return $options;
117			}
118
119			/**
120			* Fetches all collections on given storage page.
121			*
122			* @access protected
123			*
124			* @param int $pid The UID of the storage page
125			*
126			* @return array Array of collections
127			*/
128			private function getCollections(int $pid): array
129			{
130			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tx_dlf_collections');
131
132			$collections = [];
133			$result = $queryBuilder->select('uid', 'label')
134			->from('tx_dlf_collections')
135			->where(
136			$queryBuilder->expr()
137			->eq('pid', $queryBuilder->createNamedParameter((int) $pid, Connection::PARAM_INT))
138			)
139			->execute();
140
141			while ($record = $result->fetchAssociative()) {
142			$collections[$record['label']] = $record['uid'];
143			}
144
145			return $collections;
146			}
147			}
148

Erikmitk / kitodo-presentation

Pull Request — master (#123)

getAdditionalFields() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like