BaseAdditionalFieldProvider::getDryRunField() - 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-23 12:34 UTC

BaseAdditionalFieldProvider::getDryRunField() A

↳ Parent: BaseAdditionalFieldProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	8
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	10
rs	10

<?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 Kitodo\Dlf\Common\Helper;
use TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository;
use TYPO3\CMS\Core\Database\Connection;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
use TYPO3\CMS\Scheduler\Task\AbstractTask;

/**
 * Base class for additional fields classes of scheduler tasks.
 *
 * @package TYPO3
 * @subpackage dlf
 *
 * @access public
 */
class BaseAdditionalFieldProvider implements AdditionalFieldProviderInterface
{
    /**
     * 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 \TYPO3\CMS\Scheduler\Task\AbstractTask $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)
    {
        return [];
    }

    /**
     * Validates the additional fields' values
     *
     * @param array $submittedData An array containing the data submitted by the add/edit task form
     * @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule Reference to the scheduler backend module
     * @return bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
     */
    public function validateAdditionalFields(array &$submittedData, SchedulerModuleController $schedulerModule)
    {
        $fieldsValid = true;

        Helper::getLanguageService()->includeLLFile('EXT:dlf/Resources/Private/Language/locallang_tasks.xlf');

        $messageTitle = Helper::getLanguageService()->getLL('additionalFields.error');
        $messageSeverity = FlashMessage::ERROR;

        if (isset($submittedData['doc']) && empty($submittedData['doc'])) {
            Helper::addMessage(
                Helper::getLanguageService()->getLL('additionalFields.doc') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
                $messageTitle,
                $messageSeverity,
                true,
                'core.template.flashMessages'
            );
            $fieldsValid = false;
        }

        if ((isset($submittedData['pid']) && (int) $submittedData['pid'] <= 0) || !isset($submittedData['pid'])) {
            Helper::addMessage(
                Helper::getLanguageService()->getLL('additionalFields.pid') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
                $messageTitle,
                $messageSeverity,
                true,
                'core.template.flashMessages'
            );
            $fieldsValid = false;
        }

        if (!$submittedData['uid']) {
            $messageTitle = Helper::getLanguageService()->getLL('additionalFields.warning');
            $messageSeverity = FlashMessage::WARNING;
        }

        if ((isset($submittedData['lib']) && (int) $submittedData['lib'] <= 0)) {
            Helper::addMessage(
                Helper::getLanguageService()->getLL('additionalFields.lib') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
                $messageTitle,
                $messageSeverity,
                true,
                'core.template.flashMessages'
            );
            $fieldsValid = false;
        }

        if ((isset($submittedData['solr']) && (int) $submittedData['solr'] <= 0) || !isset($submittedData['solr'])) {
            Helper::addMessage(
                Helper::getLanguageService()->getLL('additionalFields.solr') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
                $messageTitle,
                $messageSeverity,
                true,
                'core.template.flashMessages'
            );
            $fieldsValid = false;
        }

        if (((isset($submittedData['coll']) && isset($submittedData['all'])) || (!isset($submittedData['coll']) && !isset($submittedData['all'])))
            && !isset($submittedData['doc']) && !isset($submittedData['lib'])) {
            Helper::addMessage(
                Helper::getLanguageService()->getLL('additionalFields.collOrAll'),
                $messageTitle,
                $messageSeverity,
                true,
                'core.template.flashMessages'
            );
            $fieldsValid = false;
        }
        return $fieldsValid;
    }

    /**
     * Takes care of saving the additional fields' values in the task's object
     *
     * @param array $submittedData An array containing the data submitted by the add/edit task form
     * @param BaseTask $task Reference to the scheduler backend module
     * @return void
     */
    public function saveAdditionalFields(array $submittedData, AbstractTask $task)
    {
        /** @var BaseTask $task */
        $task->setDryRun(!empty($submittedData['dryRun']));
        if (isset($submittedData['doc'])) {
            $task->setDoc(htmlspecialchars($submittedData['doc']));
        }
        if (isset($submittedData['lib'])) {
            $task->setLib((int) $submittedData['lib']);
        }
        if (isset($submittedData['coll']) && is_array($submittedData['coll'])) {
            $task->setColl($submittedData['coll']);
        } else {
            $task->setColl([]);
        }
        if (isset($submittedData['pid'])) {
            $task->setPid((int) $submittedData['pid']);
        }
        if (isset($submittedData['solr'])) {
            $task->setSolr((int) $submittedData['solr']);
        }
        if (isset($submittedData['owner'])) {
            $task->setOwner(htmlspecialchars($submittedData['owner']));
        }
        $task->setAll(!empty($submittedData['all']));
        if (isset($submittedData['from'])) {
            $task->setFrom(htmlspecialchars($submittedData['from']));
        }
        if (isset($submittedData['until'])) {
            $task->setUntil(htmlspecialchars($submittedData['until']));
        }
        if (isset($submittedData['set'])) {
            $task->setSet(htmlspecialchars($submittedData['set']));
        }
    }

    /**
     * Return HTML for dry run checkbox
     *
     * @access protected
     *
     * @param bool $dryRun
     *
     * @return array additional field dry run checkbox
     */
    protected function getDryRunField(bool $dryRun): array
    {
        $fieldName = 'dryRun';
        $fieldId = 'task_' . $fieldName;
        $fieldHtml = '<input type="checkbox" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="1"' . ($dryRun ? ' checked="checked"' : '') . '>';
        return [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.dryRun',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId
        ];
    }

    /**
     * Return HTML for solr dropdown
     *
     * @access protected
     *
     * @param int $solr UID of the selected Solr core
     * @param int $pid UID of the selected storage page
     *
     * @return array additional field solr dropdown
     */
    protected function getSolrField(int $solr, int $pid): array
    {
        $fieldName = 'solr';
        $fieldId = 'task_' . $fieldName;

        $allSolrCores = $this->getSolrCores($pid);
        $options = [];
        $options[] = '<option value="-1"></option>';
        foreach ($allSolrCores as $label => $uid) {
            $options[] = '<option value="' . $uid . '" ' . ($solr == $uid ? 'selected' : '') . ' >' . $label . '</option>';
        };
        $fieldHtml = '<select name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '">' . implode("\n", $options) . '</select>';
        return [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.solr',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId
        ];
    }

    /**
     * Return html for page dropdown
     *
     * @access protected
     *
     * @param int $pid UID of the selected storage page
     *
     * @return array additional field storage page dropdown
     */
    protected function getPidField(int $pid): array
    {
        $fieldName = 'pid';
        $fieldId = 'task_' . $fieldName;

        $pageRepository = GeneralUtility::makeInstance(PageTreeRepository::class);
        $pages = $pageRepository->getTree(0);

        $options = [];
        foreach ($pages['_children'] as $page) {
            if ($page['doktype'] == 254) {
                $options[] = '<option value="' . $page['uid'] . '" ' . ($pid == $page['uid'] ? 'selected' : '') . ' >' . $page['title'] . '</option>';
            }
        }

        $fieldHtml = '<select name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '">' . implode("\n", $options) . '</select>';
        return [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.pid',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId
        ];
    }

    /**
     * Return HTML for owner text field
     *
     * @access protected
     *
     * @param string $owner registered owner
     *
     * @return array additional field owner text field
     */
    protected function getOwnerField(string $owner): array
    {
        $fieldName = 'owner';
        $fieldId = 'task_' . $fieldName;
        $fieldHtml = '<input type="text" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="' . $owner . '" >';
        return [
            'code' => $fieldHtml,
            'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.owner',
            'cshKey' => '_MOD_system_txschedulerM1',
            'cshLabel' => $fieldId
        ];
    }

    /**
     * Fetches all Solr cores on given page.
     *
     * @access protected
     *
     * @param int $pid UID of storage page
     *
     * @return array Array of valid Solr cores
     */
    private function getSolrCores(int $pid): array
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tx_dlf_solrcores');

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

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

        return $solrCores;
    }
}


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 Kitodo\Dlf\Common\Helper;
15			use TYPO3\CMS\Backend\Tree\Repository\PageTreeRepository;
16			use TYPO3\CMS\Core\Database\Connection;
17			use TYPO3\CMS\Core\Database\ConnectionPool;
18			use TYPO3\CMS\Core\Messaging\FlashMessage;
19			use TYPO3\CMS\Core\Utility\GeneralUtility;
20			use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
21			use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
22			use TYPO3\CMS\Scheduler\Task\AbstractTask;
23
24			/**
25			* Base class for additional fields classes of scheduler tasks.
26			*
27			* @package TYPO3
28			* @subpackage dlf
29			*
30			* @access public
31			*/
32			class BaseAdditionalFieldProvider implements AdditionalFieldProviderInterface
33			{
34			/**
35			* Gets additional fields to render in the form to add/edit a task
36			*
37			* @param array $taskInfo Values of the fields from the add/edit task form
38			* @param \TYPO3\CMS\Scheduler\Task\AbstractTask $task The task object being edited. Null when adding a task!
39			* @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule Reference to the scheduler backend module
40			* @return array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
41			*/
42			public function getAdditionalFields(array &$taskInfo, $task, SchedulerModuleController $schedulerModule)
43			{
44			return [];
45			}
46
47			/**
48			* Validates the additional fields' values
49			*
50			* @param array $submittedData An array containing the data submitted by the add/edit task form
51			* @param \TYPO3\CMS\Scheduler\Controller\SchedulerModuleController $schedulerModule Reference to the scheduler backend module
52			* @return bool TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
53			*/
54			public function validateAdditionalFields(array &$submittedData, SchedulerModuleController $schedulerModule)
55			{
56			$fieldsValid = true;
57
58			Helper::getLanguageService()->includeLLFile('EXT:dlf/Resources/Private/Language/locallang_tasks.xlf');
59
60			$messageTitle = Helper::getLanguageService()->getLL('additionalFields.error');
61			$messageSeverity = FlashMessage::ERROR;
62
63			if (isset($submittedData['doc']) && empty($submittedData['doc'])) {
64			Helper::addMessage(
65			Helper::getLanguageService()->getLL('additionalFields.doc') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
66			$messageTitle,
67			$messageSeverity,
68			true,
69			'core.template.flashMessages'
70			);
71			$fieldsValid = false;
72			}
73
74			if ((isset($submittedData['pid']) && (int) $submittedData['pid'] <= 0) \|\| !isset($submittedData['pid'])) {
75			Helper::addMessage(
76			Helper::getLanguageService()->getLL('additionalFields.pid') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
77			$messageTitle,
78			$messageSeverity,
79			true,
80			'core.template.flashMessages'
81			);
82			$fieldsValid = false;
83			}
84
85			if (!$submittedData['uid']) {
86			$messageTitle = Helper::getLanguageService()->getLL('additionalFields.warning');
87			$messageSeverity = FlashMessage::WARNING;
88			}
89
90			if ((isset($submittedData['lib']) && (int) $submittedData['lib'] <= 0)) {
91			Helper::addMessage(
92			Helper::getLanguageService()->getLL('additionalFields.lib') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
93			$messageTitle,
94			$messageSeverity,
95			true,
96			'core.template.flashMessages'
97			);
98			$fieldsValid = false;
99			}
100
101			if ((isset($submittedData['solr']) && (int) $submittedData['solr'] <= 0) \|\| !isset($submittedData['solr'])) {
102			Helper::addMessage(
103			Helper::getLanguageService()->getLL('additionalFields.solr') . ' ' . Helper::getLanguageService()->getLL('additionalFields.valid'),
104			$messageTitle,
105			$messageSeverity,
106			true,
107			'core.template.flashMessages'
108			);
109			$fieldsValid = false;
110			}
111
112			if (((isset($submittedData['coll']) && isset($submittedData['all'])) \|\| (!isset($submittedData['coll']) && !isset($submittedData['all'])))
113			&& !isset($submittedData['doc']) && !isset($submittedData['lib'])) {
114			Helper::addMessage(
115			Helper::getLanguageService()->getLL('additionalFields.collOrAll'),
116			$messageTitle,
117			$messageSeverity,
118			true,
119			'core.template.flashMessages'
120			);
121			$fieldsValid = false;
122			}
123			return $fieldsValid;
124			}
125
126			/**
127			* Takes care of saving the additional fields' values in the task's object
128			*
129			* @param array $submittedData An array containing the data submitted by the add/edit task form
130			* @param BaseTask $task Reference to the scheduler backend module
131			* @return void
132			*/
133			public function saveAdditionalFields(array $submittedData, AbstractTask $task)
134			{
135			/** @var BaseTask $task */
136			$task->setDryRun(!empty($submittedData['dryRun']));
137			if (isset($submittedData['doc'])) {
138			$task->setDoc(htmlspecialchars($submittedData['doc']));
139			}
140			if (isset($submittedData['lib'])) {
141			$task->setLib((int) $submittedData['lib']);
142			}
143			if (isset($submittedData['coll']) && is_array($submittedData['coll'])) {
144			$task->setColl($submittedData['coll']);
145			} else {
146			$task->setColl([]);
147			}
148			if (isset($submittedData['pid'])) {
149			$task->setPid((int) $submittedData['pid']);
150			}
151			if (isset($submittedData['solr'])) {
152			$task->setSolr((int) $submittedData['solr']);
153			}
154			if (isset($submittedData['owner'])) {
155			$task->setOwner(htmlspecialchars($submittedData['owner']));
156			}
157			$task->setAll(!empty($submittedData['all']));
158			if (isset($submittedData['from'])) {
159			$task->setFrom(htmlspecialchars($submittedData['from']));
160			}
161			if (isset($submittedData['until'])) {
162			$task->setUntil(htmlspecialchars($submittedData['until']));
163			}
164			if (isset($submittedData['set'])) {
165			$task->setSet(htmlspecialchars($submittedData['set']));
166			}
167			}
168
169			/**
170			* Return HTML for dry run checkbox
171			*
172			* @access protected
173			*
174			* @param bool $dryRun
175			*
176			* @return array additional field dry run checkbox
177			*/
178			protected function getDryRunField(bool $dryRun): array
179			{
180			$fieldName = 'dryRun';
181			$fieldId = 'task_' . $fieldName;
182			$fieldHtml = '<input type="checkbox" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="1"' . ($dryRun ? ' checked="checked"' : '') . '>';
183			return [
184			'code' => $fieldHtml,
185			'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.dryRun',
186			'cshKey' => '_MOD_system_txschedulerM1',
187			'cshLabel' => $fieldId
188			];
189			}
190
191			/**
192			* Return HTML for solr dropdown
193			*
194			* @access protected
195			*
196			* @param int $solr UID of the selected Solr core
197			* @param int $pid UID of the selected storage page
198			*
199			* @return array additional field solr dropdown
200			*/
201			protected function getSolrField(int $solr, int $pid): array
202			{
203			$fieldName = 'solr';
204			$fieldId = 'task_' . $fieldName;
205
206			$allSolrCores = $this->getSolrCores($pid);
207			$options = [];
208			$options[] = '<option value="-1"></option>';
209			foreach ($allSolrCores as $label => $uid) {
210			$options[] = '<option value="' . $uid . '" ' . ($solr == $uid ? 'selected' : '') . ' >' . $label . '</option>';
211			};
212			$fieldHtml = '<select name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '">' . implode("\n", $options) . '</select>';
213			return [
214			'code' => $fieldHtml,
215			'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.solr',
216			'cshKey' => '_MOD_system_txschedulerM1',
217			'cshLabel' => $fieldId
218			];
219			}
220
221			/**
222			* Return html for page dropdown
223			*
224			* @access protected
225			*
226			* @param int $pid UID of the selected storage page
227			*
228			* @return array additional field storage page dropdown
229			*/
230			protected function getPidField(int $pid): array
231			{
232			$fieldName = 'pid';
233			$fieldId = 'task_' . $fieldName;
234
235			$pageRepository = GeneralUtility::makeInstance(PageTreeRepository::class);
236			$pages = $pageRepository->getTree(0);
237
238			$options = [];
239			foreach ($pages['_children'] as $page) {
240			if ($page['doktype'] == 254) {
241			$options[] = '<option value="' . $page['uid'] . '" ' . ($pid == $page['uid'] ? 'selected' : '') . ' >' . $page['title'] . '</option>';
242			}
243			}
244
245			$fieldHtml = '<select name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '">' . implode("\n", $options) . '</select>';
246			return [
247			'code' => $fieldHtml,
248			'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.pid',
249			'cshKey' => '_MOD_system_txschedulerM1',
250			'cshLabel' => $fieldId
251			];
252			}
253
254			/**
255			* Return HTML for owner text field
256			*
257			* @access protected
258			*
259			* @param string $owner registered owner
260			*
261			* @return array additional field owner text field
262			*/
263			protected function getOwnerField(string $owner): array
264			{
265			$fieldName = 'owner';
266			$fieldId = 'task_' . $fieldName;
267			$fieldHtml = '<input type="text" name="tx_scheduler[' . $fieldName . ']" id="' . $fieldId . '" value="' . $owner . '" >';
268			return [
269			'code' => $fieldHtml,
270			'label' => 'LLL:EXT:dlf/Resources/Private/Language/locallang_tasks.xlf:additionalFields.owner',
271			'cshKey' => '_MOD_system_txschedulerM1',
272			'cshLabel' => $fieldId
273			];
274			}
275
276			/**
277			* Fetches all Solr cores on given page.
278			*
279			* @access protected
280			*
281			* @param int $pid UID of storage page
282			*
283			* @return array Array of valid Solr cores
284			*/
285			private function getSolrCores(int $pid): array
286			{
287			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tx_dlf_solrcores');
288
289			$solrCores = [];
290			$result = $queryBuilder->select('uid', 'label')
291			->from('tx_dlf_solrcores')
292			->where(
293			$queryBuilder->expr()
294			->eq('pid', $queryBuilder->createNamedParameter((int) $pid, Connection::PARAM_INT))
295			)
296			->execute();
297
298			while ($record = $result->fetchAssociative()) {
299			$solrCores[$record['label']] = $record['uid'];
300			}
301
302			return $solrCores;
303			}
304			}
305

Erikmitk / kitodo-presentation

Pull Request — master (#123)

BaseAdditionalFieldProvider::getDryRunField() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like