CalendarController::listAction() - Code Metrics - Inspection of "Add rendering" - lochmueller/calendarize - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 226640...8edbcf )

by Tim

created 2018-12-06 14:46 UTC

CalendarController::listAction() A

↳ Parent: CalendarController

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	31
rs	9.424
c	0
b	0
f	0
cc	3
nc	2
nop	8

How to fix Many Parameters

<?php

/**
 * Calendar.
 */
declare(strict_types=1);

namespace HDNET\Calendarize\Controller;

use HDNET\Calendarize\Domain\Model\Index;
use HDNET\Calendarize\Register;
use HDNET\Calendarize\Utility\DateTimeUtility;
use HDNET\Calendarize\Utility\EventUtility;
use HDNET\Calendarize\Utility\ExtensionConfigurationUtility;
use HDNET\Calendarize\Utility\TranslateUtility;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\ClassNamingUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Extbase\Persistence\QueryInterface;
use TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter;
use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;

/**
 * Calendar.
 */
class CalendarController extends AbstractController
{
    /**
     * Init all actions.
     */
    public function initializeAction()
    {
        parent::initializeAction();
        $this->indexRepository->setIndexTypes(GeneralUtility::trimExplode(',', $this->settings['configuration'], true));
        $additionalSlotArguments = [
            'contentRecord' => $this->configurationManager->getContentObject()->data,
            'settings' => $this->settings,
        ];
        $this->indexRepository->setAdditionalSlotArguments($additionalSlotArguments);

        if (isset($this->settings['sorting'])) {
            if (isset($this->settings['sortBy'])) {
                $this->indexRepository->setDefaultSortingDirection($this->settings['sorting'], $this->settings['sortBy']);
            } else {
                $this->indexRepository->setDefaultSortingDirection($this->settings['sorting']);
            }
        }

        if (isset($this->arguments['startDate'])) {
            $this->arguments['startDate']->getPropertyMappingConfiguration()
                ->setTypeConverterOption(
                    DateTimeConverter::class,
                    DateTimeConverter::CONFIGURATION_DATE_FORMAT,
                    $this->settings['dateFormat']
                );
        }
        if (isset($this->arguments['endDate'])) {
            $this->arguments['endDate']->getPropertyMappingConfiguration()
                ->setTypeConverterOption(
                    DateTimeConverter::class,
                    DateTimeConverter::CONFIGURATION_DATE_FORMAT,
                    $this->settings['dateFormat']
                );
        }
        if ($this->request->hasArgument('event') && 'detailAction' === $this->actionMethodName) {
            // default configuration
            $configurationName = $this->settings['configuration'];
            // configuration overwritten by argument?
            if ($this->request->hasArgument('extensionConfiguration')) {
                $configurationName = $this->request->getArgument('extensionConfiguration');
            }
            // get the configuration
            $configuration = ExtensionConfigurationUtility::get($configurationName);

            // get Event by Configuration and Uid
            $event = EventUtility::getOriginalRecordByConfiguration($configuration, (int) $this->request->getArgument('event'));
            $index = $this->indexRepository->findByEventTraversing($event, true, false, 1)->getFirst();

            // if there is a valid index in the event
            if ($index) {
                $this->redirect('detail', null, null, ['index' => $index]);
            }
        }
    }

    /**
     * Latest action.
     *
     * @param \HDNET\Calendarize\Domain\Model\Index $index
     * @param \DateTime                             $startDate
     * @param \DateTime                             $endDate
     * @param array                                 $customSearch *
     * @param int                                   $year
     * @param int                                   $month
     * @param int                                   $week
     *
     * @ignorevalidation $startDate
     * @ignorevalidation $endDate
     * @ignorevalidation $customSearch
     *
     * @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
     */
    public function latestAction(
        Index $index = null,
        \DateTime $startDate = null,
        \DateTime $endDate = null,
        array $customSearch = [],
        $year = null,
        $month = null,
        $week = null
    ) {
        $this->checkStaticTemplateIsIncluded();
        if (($index instanceof Index) && \in_array('detail', $this->getAllowedActions(), true)) {
            $this->forward('detail');
        }

        $search = $this->determineSearch($startDate, $endDate, $customSearch, $year, $month, null, $week);

        $this->slotExtendedAssignMultiple([
            'indices' => $search['indices'],
            'searchMode' => $search['searchMode'],
            'searchParameter' => [
                'startDate' => $startDate,
                'endDate' => $endDate,
                'customSearch' => $customSearch,
                'year' => $year,
                'month' => $month,
                'week' => $week,
            ],
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Result action.
     *
     * @param \HDNET\Calendarize\Domain\Model\Index $index
     * @param \DateTime                             $startDate
     * @param \DateTime                             $endDate
     * @param array                                 $customSearch
     * @param int                                   $year
     * @param int                                   $month
     * @param int                                   $week
     *
     * @ignorevalidation $startDate
     * @ignorevalidation $endDate
     * @ignorevalidation $customSearch
     *
     * @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
     */
    public function resultAction(
        Index $index = null,
        \DateTime $startDate = null,
        \DateTime $endDate = null,
        array $customSearch = [],
        $year = null,
        $month = null,
        $week = null
    ) {
        $this->checkStaticTemplateIsIncluded();
        if (($index instanceof Index) && \in_array('detail', $this->getAllowedActions(), true)) {
            $this->forward('detail');
        }

        $search = $this->determineSearch($startDate, $endDate, $customSearch, $year, $month, null, $week);

        $this->slotExtendedAssignMultiple([
            'indices' => $search['indices'],
            'searchMode' => $search['searchMode'],
            'searchParameter' => [
                'startDate' => $startDate,
                'endDate' => $endDate,
                'customSearch' => $customSearch,
                'year' => $year,
                'month' => $month,
                'week' => $week,
            ],
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * List action.
     *
     * @param \HDNET\Calendarize\Domain\Model\Index $index
     * @param \DateTime                             $startDate
     * @param \DateTime                             $endDate
     * @param array                                 $customSearch *
     * @param int                                   $year
     * @param int                                   $month
     * @param int                                   $day
     * @param int                                   $week
     *
     * @ignorevalidation $startDate
     * @ignorevalidation $endDate
     * @ignorevalidation $customSearch
     *
     * @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
     */
    public function listAction(
        Index $index = null,
        \DateTime $startDate = null,
        \DateTime $endDate = null,
        array $customSearch = [],
        $year = null,
        $month = null,
        $day = null,
        $week = null
    ) {
        $this->checkStaticTemplateIsIncluded();
        if (($index instanceof Index) && \in_array('detail', $this->getAllowedActions(), true)) {
            $this->forward('detail');
        }

        $search = $this->determineSearch($startDate, $endDate, $customSearch, $year, $month, $day, $week);

        $this->slotExtendedAssignMultiple([
            'indices' => $search['indices'],
            'searchMode' => $search['searchMode'],
            'searchParameter' => [
                'startDate' => $startDate,
                'endDate' => $endDate,
                'customSearch' => $customSearch,
                'year' => $year,
                'month' => $month,
                'day' => $day,
                'week' => $week,
            ],
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Shortcut.
     */
    public function shortcutAction()
    {
        list($table, $uid) = explode(':', $GLOBALS['TSFE']->currentRecord);
        $register = Register::getRegister();

        $event = null;
        foreach ($register as $key => $value) {
            if ($value['tableName'] === $table) {
                $repositoryName = ClassNamingUtility::translateModelNameToRepositoryName($value['modelName']);
                if (class_exists($repositoryName)) {
                    $objectManager = new ObjectManager();
                    $repository = $objectManager->get($repositoryName);
                    $event = $repository->findByUid($uid);
                }
            }
        }

        if (!($event instanceof DomainObjectInterface)) {
            return 'Invalid object';
        }

        $fetchEvent = $this->indexRepository->findByEventTraversing($event, true, false, 1);
        if (count($fetchEvent) <= 0) {
            $fetchEvent = $this->indexRepository->findByEventTraversing($event, false, true, 1, QueryInterface::ORDER_DESCENDING);
        }


        $this->view->assignMultiple([
            'indices' => $fetchEvent,
        ]);
    }

    /**
     * Past action.
     *
     * @param int    $limit
     * @param string $sort
     *
     * @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
     */
    public function pastAction(
        $limit = 100,

        $sort = 'ASC'

    ) {
        $limit = (int) ($this->settings['limit']);
        $sort = $this->settings['sorting'];
        $this->checkStaticTemplateIsIncluded();
        $this->slotExtendedAssignMultiple([
           'indices' => $this->indexRepository->findByPast($limit, $sort),
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Year action.
     *
     * @param int $year
     */
    public function yearAction($year = null)
    {
        $date = DateTimeUtility::normalizeDateTime(1, 1, $year);

        $this->slotExtendedAssignMultiple([
            'indices' => $this->indexRepository->findYear((int) $date->format('Y')),
            'date' => $date,
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Month action.
     *
     * @param int $year
     * @param int $month
     * @param int $day
     */
    public function monthAction($year = null, $month = null, $day = null)
    {
        $date = DateTimeUtility::normalizeDateTime($day, $month, $year);

        $this->slotExtendedAssignMultiple([
            'date' => $date,
            'indices' => $this->indexRepository->findMonth((int) $date->format('Y'), (int) $date->format('n')),
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Week action.
     *
     * @param int $year
     * @param int $week
     */
    public function weekAction($year = null, $week = null)
    {
        $now = DateTimeUtility::getNow();
        if (null === $year) {
            $year = $now->format('o'); // 'o' instead of 'Y': http://php.net/manual/en/function.date.php#106974
        }
        if (null === $week) {
            $week = $now->format('W');
        }
        $weekStart = (int) $this->settings['weekStart'];
        $firstDay = DateTimeUtility::convertWeekYear2DayMonthYear((int) $week, $year, $weekStart);
        $timezone = DateTimeUtility::getTimeZone();
        $firstDay->setTimezone($timezone);
        $firstDay->setTime(0, 0, 0);

        $weekConfiguration = [
            '+0 day' => 2,
            '+1 days' => 2,
            '+2 days' => 2,
            '+3 days' => 2,
            '+4 days' => 2,
            '+5 days' => 1,
            '+6 days' => 1,
        ];

        $this->slotExtendedAssignMultiple([
            'firstDay' => $firstDay,
            'indices' => $this->indexRepository->findWeek($year, $week, $this->settings['weekStart']),
            'weekConfiguration' => $weekConfiguration,
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Day action.
     *
     * @param int $year
     * @param int $month
     * @param int $day
     */
    public function dayAction($year = null, $month = null, $day = null)
    {
        $date = DateTimeUtility::normalizeDateTime($day, $month, $year);
        $date->modify('+12 hours');

        $previous = clone $date;
        $previous->modify('-1 day');

        $next = clone $date;
        $next->modify('+1 day');

        $this->slotExtendedAssignMultiple([
            'indices' => $this->indexRepository->findDay((int) $date->format('Y'), (int) $date->format('n'), (int) $date->format('j')),
            'today' => $date,
            'previous' => $previous,
            'next' => $next,
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Detail action.
     *
     * @param \HDNET\Calendarize\Domain\Model\Index $index
     *
     * @return string
     */
    public function detailAction(Index $index = null)
    {
        if (null === $index) {
            // handle fallback for "strange language settings"
            if ($this->request->hasArgument('index')) {
                $indexId = (int) $this->request->getArgument('index');
                if ($indexId > 0) {
                    $index = $this->indexRepository->findByUid($indexId);
                }
            }

            if (null === $index) {
                if (!MathUtility::canBeInterpretedAsInteger($this->settings['listPid'])) {
                    return (string) TranslateUtility::get('noEventDetailView');
                }
                $this->slottedRedirect(__CLASS__, __FUNCTION__ . 'noEvent');
            }
        }

        $this->slotExtendedAssignMultiple([
            'index' => $index,
            'domain' => GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY'),
        ], __CLASS__, __FUNCTION__);

        return $this->view->render();
    }

    /**
     * Render the search view.
     *
     * @param \DateTime $startDate
     * @param \DateTime $endDate
     * @param array     $customSearch
     *
     * @ignorevalidation $startDate
     * @ignorevalidation $endDate
     * @ignorevalidation $customSearch
     */
    public function searchAction(\DateTime $startDate = null, \DateTime $endDate = null, array $customSearch = [])
    {
        $baseDate = DateTimeUtility::getNow();
        if (!($startDate instanceof \DateTimeInterface)) {
            $startDate = clone $baseDate;
        }
        if (!($endDate instanceof \DateTimeInterface)) {
            $baseDate->modify($this->settings['searchEndModifier']);
            $endDate = $baseDate;
        }

        $this->slotExtendedAssignMultiple([
            'startDate' => $startDate,
            'endDate' => $endDate,
            'customSearch' => $customSearch,
            'configurations' => $this->getCurrentConfigurations(),
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Render single items.
     */
    public function singleAction()
    {
        $indicies = [];

        // prepare selection
        $selections = [];
        $configurations = $this->getCurrentConfigurations();
        foreach (GeneralUtility::trimExplode(',', $this->settings['singleItems']) as $item) {
            list($table, $uid) = BackendUtility::splitTable_Uid($item);
            foreach ($configurations as $configuration) {
                if ($configuration['tableName'] === $table) {
                    $selections[] = [
                        'configuration' => $configuration,
                        'uid' => $uid,
                    ];
                    break;
                }
            }
        }

        // fetch index
        foreach ($selections as $selection) {
            $this->indexRepository->setIndexTypes([$selection['configuration']['uniqueRegisterKey']]);
            $dummyIndex = new Index();
            $dummyIndex->setForeignTable($selection['configuration']['tableName']);
            $dummyIndex->setForeignUid($selection['uid']);

            $result = $this->indexRepository->findByTraversing($dummyIndex);
            $index = $result->getQuery()->setLimit(1)->execute()->getFirst();
            if (\is_object($index)) {
                $indicies[] = $index;
            }
        }

        $this->slotExtendedAssignMultiple([
            'indicies' => $indicies,
            'configurations' => $configurations,
        ], __CLASS__, __FUNCTION__);
    }

    /**
     * Build the search structure.
     *
     * @param \DateTime|null $startDate
     * @param \DateTime|null $endDate
     * @param array          $customSearch
     * @param int            $year
     * @param int            $month
     * @param int            $day
     * @param int            $week
     *
     * @return array
     */
    protected function determineSearch(
        \DateTime $startDate = null,
        \DateTime $endDate = null,
        array $customSearch = [],
        $year = null,
        $month = null,
        $day = null,
        $week = null
    ) {
        $searchMode = false;
        if ($startDate || $endDate || !empty($customSearch)) {
            $searchMode = true;
            $indices = $this->indexRepository->findBySearch($startDate, $endDate, $customSearch);
        } elseif (MathUtility::canBeInterpretedAsInteger($year) && MathUtility::canBeInterpretedAsInteger($month) && MathUtility::canBeInterpretedAsInteger($day)) {
            $indices = $this->indexRepository->findDay((int) $year, (int) $month, (int) $day);
        } elseif (MathUtility::canBeInterpretedAsInteger($year) && MathUtility::canBeInterpretedAsInteger($month)) {
            $indices = $this->indexRepository->findMonth((int) $year, (int) $month);
        } elseif (MathUtility::canBeInterpretedAsInteger($year) && MathUtility::canBeInterpretedAsInteger($week)) {
            $indices = $this->indexRepository->findWeek($year, $week, $this->settings['weekStart']);
        } elseif (MathUtility::canBeInterpretedAsInteger($year)) {
            $indices = $this->indexRepository->findYear((int) $year);
        } else {
            $overrideStartDate = (int) $this->settings['overrideStartdate'];
            $overrideEndDate = (int) $this->settings['overrideEnddate'];
            $indices = $this->indexRepository->findList(
                (int) $this->settings['limit'],
                $this->settings['listStartTime'],
                (int) $this->settings['listStartTimeOffsetHours'],
                $overrideStartDate,
                $overrideEndDate
            );
        }

        // use this variable in your extension to add more custom variables
        $variables = [
            'extended' => [
                'indices' => $indices,
                'searchMode' => $searchMode,
                'parameters' => [
                    'startDate' => $startDate,
                    'endDate' => $endDate,
                    'customSearch' => $customSearch,
                    'year' => $year,
                    'month' => $month,
                    'day' => $day,
                    'week' => $week,
                ],
            ],
        ];
        $variables['settings'] = $this->settings;

        $dispatcher = $this->objectManager->get(Dispatcher::class);
        $variables = $dispatcher->dispatch(__CLASS__, __FUNCTION__, $variables);

        return $variables['extended'];
    }

    /**
     * Get the allowed actions.
     *
     * @return array
     */
    protected function getAllowedActions(): array
    {
        $configuration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
        $allowedActions = [];
        foreach ($configuration['controllerConfiguration'] as $controllerName => $controllerActions) {
            $allowedActions[$controllerName] = $controllerActions['actions'];
        }

        return \is_array($allowedActions['Calendar']) ? $allowedActions['Calendar'] : [];
    }

    /**
     * Get the current configurations.
     *
     * @return array
     */
    protected function getCurrentConfigurations()
    {
        $configurations = GeneralUtility::trimExplode(',', $this->settings['configuration'], true);
        $return = [];
        foreach (Register::getRegister() as $key => $configuration) {
            if (\in_array($key, $configurations, true)) {
                $return[] = $configuration;
            }
        }

        return $return;
    }

    /**
     * A redirect that have a slot included.
     *
     * @param string $signalClassName name of the signal class: __CLASS__
     * @param string $signalName      name of the signal: __FUNCTION__
     * @param array  $variables       optional: if not set use the defaults
     */
    protected function slottedRedirect($signalClassName, $signalName, $variables = null)
    {
        // set default variables for the redirect
        if (null === $variables) {
            $variables['extended'] = [
                'actionName' => 'list',
                'controllerName' => null,
                'extensionName' => null,
                'arguments' => [],
                'pageUid' => $this->settings['listPid'],
                'delay' => 0,
                'statusCode' => 301,
            ];
            $variables['extended']['pluginHmac'] = $this->calculatePluginHmac();
            $variables['settings'] = $this->settings;
        }

        $dispatcher = $this->objectManager->get(Dispatcher::class);
        $variables = $dispatcher->dispatch($signalClassName, $signalName, $variables);

        $this->redirect(
            $variables['extended']['actionName'],
            $variables['extended']['controllerName'],
            $variables['extended']['extensionName'],
            $variables['extended']['arguments'],
            $variables['extended']['pageUid'],
            $variables['extended']['delay'],
            $variables['extended']['statusCode']
        );
    }
}


1			<?php
2
3			/**
4			* Calendar.
5			*/
6			declare(strict_types=1);
7
8			namespace HDNET\Calendarize\Controller;
9
10			use HDNET\Calendarize\Domain\Model\Index;
11			use HDNET\Calendarize\Register;
12			use HDNET\Calendarize\Utility\DateTimeUtility;
13			use HDNET\Calendarize\Utility\EventUtility;
14			use HDNET\Calendarize\Utility\ExtensionConfigurationUtility;
15			use HDNET\Calendarize\Utility\TranslateUtility;
16			use TYPO3\CMS\Backend\Utility\BackendUtility;
17			use TYPO3\CMS\Core\Utility\ClassNamingUtility;
18			use TYPO3\CMS\Core\Utility\GeneralUtility;
19			use TYPO3\CMS\Core\Utility\MathUtility;
20			use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
21			use TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface;
22			use TYPO3\CMS\Extbase\Object\ObjectManager;
23			use TYPO3\CMS\Extbase\Persistence\QueryInterface;
24			use TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter;
25			use TYPO3\CMS\Extbase\SignalSlot\Dispatcher;
26
27			/**
28			* Calendar.
29			*/
30			class CalendarController extends AbstractController
31			{
32			/**
33			* Init all actions.
34			*/
35			public function initializeAction()
36			{
37			parent::initializeAction();
38			$this->indexRepository->setIndexTypes(GeneralUtility::trimExplode(',', $this->settings['configuration'], true));
39			$additionalSlotArguments = [
40			'contentRecord' => $this->configurationManager->getContentObject()->data,
41			'settings' => $this->settings,
42			];
43			$this->indexRepository->setAdditionalSlotArguments($additionalSlotArguments);
44
45			if (isset($this->settings['sorting'])) {
46			if (isset($this->settings['sortBy'])) {
47			$this->indexRepository->setDefaultSortingDirection($this->settings['sorting'], $this->settings['sortBy']);
48			} else {
49			$this->indexRepository->setDefaultSortingDirection($this->settings['sorting']);
50			}
51			}
52
53			if (isset($this->arguments['startDate'])) {
54			$this->arguments['startDate']->getPropertyMappingConfiguration()
55			->setTypeConverterOption(
56			DateTimeConverter::class,
57			DateTimeConverter::CONFIGURATION_DATE_FORMAT,
58			$this->settings['dateFormat']
59			);
60			}
61			if (isset($this->arguments['endDate'])) {
62			$this->arguments['endDate']->getPropertyMappingConfiguration()
63			->setTypeConverterOption(
64			DateTimeConverter::class,
65			DateTimeConverter::CONFIGURATION_DATE_FORMAT,
66			$this->settings['dateFormat']
67			);
68			}
69			if ($this->request->hasArgument('event') && 'detailAction' === $this->actionMethodName) {
70			// default configuration
71			$configurationName = $this->settings['configuration'];
72			// configuration overwritten by argument?
73			if ($this->request->hasArgument('extensionConfiguration')) {
74			$configurationName = $this->request->getArgument('extensionConfiguration');
75			}
76			// get the configuration
77			$configuration = ExtensionConfigurationUtility::get($configurationName);
78
79			// get Event by Configuration and Uid
80			$event = EventUtility::getOriginalRecordByConfiguration($configuration, (int) $this->request->getArgument('event'));
81			$index = $this->indexRepository->findByEventTraversing($event, true, false, 1)->getFirst();
82
83			// if there is a valid index in the event
84			if ($index) {
85			$this->redirect('detail', null, null, ['index' => $index]);
86			}
87			}
88			}
89
90			/**
91			* Latest action.
92			*
93			* @param \HDNET\Calendarize\Domain\Model\Index $index
94			* @param \DateTime $startDate
95			* @param \DateTime $endDate
96			* @param array $customSearch *
97			* @param int $year
98			* @param int $month
99			* @param int $week
100			*
101			* @ignorevalidation $startDate
102			* @ignorevalidation $endDate
103			* @ignorevalidation $customSearch
104			*
105			* @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
106			*/
107			public function latestAction(
108			Index $index = null,
109			\DateTime $startDate = null,
110			\DateTime $endDate = null,
111			array $customSearch = [],
112			$year = null,
113			$month = null,
114			$week = null
115			) {
116			$this->checkStaticTemplateIsIncluded();
117			if (($index instanceof Index) && \in_array('detail', $this->getAllowedActions(), true)) {
118			$this->forward('detail');
119			}
120
121			$search = $this->determineSearch($startDate, $endDate, $customSearch, $year, $month, null, $week);
122
123			$this->slotExtendedAssignMultiple([
124			'indices' => $search['indices'],
125			'searchMode' => $search['searchMode'],
126			'searchParameter' => [
127			'startDate' => $startDate,
128			'endDate' => $endDate,
129			'customSearch' => $customSearch,
130			'year' => $year,
131			'month' => $month,
132			'week' => $week,
133			],
134			], __CLASS__, __FUNCTION__);
135			}
136
137			/**
138			* Result action.
139			*
140			* @param \HDNET\Calendarize\Domain\Model\Index $index
141			* @param \DateTime $startDate
142			* @param \DateTime $endDate
143			* @param array $customSearch
144			* @param int $year
145			* @param int $month
146			* @param int $week
147			*
148			* @ignorevalidation $startDate
149			* @ignorevalidation $endDate
150			* @ignorevalidation $customSearch
151			*
152			* @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
153			*/
154			public function resultAction(
155			Index $index = null,
156			\DateTime $startDate = null,
157			\DateTime $endDate = null,
158			array $customSearch = [],
159			$year = null,
160			$month = null,
161			$week = null
162			) {
163			$this->checkStaticTemplateIsIncluded();
164			if (($index instanceof Index) && \in_array('detail', $this->getAllowedActions(), true)) {
165			$this->forward('detail');
166			}
167
168			$search = $this->determineSearch($startDate, $endDate, $customSearch, $year, $month, null, $week);
169
170			$this->slotExtendedAssignMultiple([
171			'indices' => $search['indices'],
172			'searchMode' => $search['searchMode'],
173			'searchParameter' => [
174			'startDate' => $startDate,
175			'endDate' => $endDate,
176			'customSearch' => $customSearch,
177			'year' => $year,
178			'month' => $month,
179			'week' => $week,
180			],
181			], __CLASS__, __FUNCTION__);
182			}
183
184			/**
185			* List action.
186			*
187			* @param \HDNET\Calendarize\Domain\Model\Index $index
188			* @param \DateTime $startDate
189			* @param \DateTime $endDate
190			* @param array $customSearch *
191			* @param int $year
192			* @param int $month
193			* @param int $day
194			* @param int $week
195			*
196			* @ignorevalidation $startDate
197			* @ignorevalidation $endDate
198			* @ignorevalidation $customSearch
199			*
200			* @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
201			*/
202			public function listAction(
203			Index $index = null,
204			\DateTime $startDate = null,
205			\DateTime $endDate = null,
206			array $customSearch = [],
207			$year = null,
208			$month = null,
209			$day = null,
210			$week = null
211			) {
212			$this->checkStaticTemplateIsIncluded();
213			if (($index instanceof Index) && \in_array('detail', $this->getAllowedActions(), true)) {
214			$this->forward('detail');
215			}
216
217			$search = $this->determineSearch($startDate, $endDate, $customSearch, $year, $month, $day, $week);
218
219			$this->slotExtendedAssignMultiple([
220			'indices' => $search['indices'],
221			'searchMode' => $search['searchMode'],
222			'searchParameter' => [
223			'startDate' => $startDate,
224			'endDate' => $endDate,
225			'customSearch' => $customSearch,
226			'year' => $year,
227			'month' => $month,
228			'day' => $day,
229			'week' => $week,
230			],
231			], __CLASS__, __FUNCTION__);
232			}
233
234			/**
235			* Shortcut.
236			*/
237			public function shortcutAction()
238			{
239			list($table, $uid) = explode(':', $GLOBALS['TSFE']->currentRecord);
240			$register = Register::getRegister();
241
242			$event = null;
243			foreach ($register as $key => $value) {
244			if ($value['tableName'] === $table) {
245			$repositoryName = ClassNamingUtility::translateModelNameToRepositoryName($value['modelName']);
246			if (class_exists($repositoryName)) {
247			$objectManager = new ObjectManager();
248			$repository = $objectManager->get($repositoryName);
249			$event = $repository->findByUid($uid);
250			}
251			}
252			}
253
254			if (!($event instanceof DomainObjectInterface)) {
255			return 'Invalid object';
256			}
257
258			$fetchEvent = $this->indexRepository->findByEventTraversing($event, true, false, 1);
259			if (count($fetchEvent) <= 0) {
260			$fetchEvent = $this->indexRepository->findByEventTraversing($event, false, true, 1, QueryInterface::ORDER_DESCENDING);
261			}
262
263
264			$this->view->assignMultiple([
265			'indices' => $fetchEvent,
266			]);
267			}
268
269			/**
270			* Past action.
271			*
272			* @param int $limit
273			* @param string $sort
274			*
275			* @throws \TYPO3\CMS\Extbase\Mvc\Exception\StopActionException
276			*/
277			public function pastAction(
278			$limit = 100,
			0 ignored issues – show Unused Code introduced 2018-06-08 20:43 UTC by Report Bug Copy Issue Report The parameter `$limit` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
279			$sort = 'ASC'
			0 ignored issues – show Unused Code introduced 2018-06-08 20:43 UTC by Report Bug Copy Issue Report The parameter `$sort` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
280			) {
281			$limit = (int) ($this->settings['limit']);
282			$sort = $this->settings['sorting'];
283			$this->checkStaticTemplateIsIncluded();
284			$this->slotExtendedAssignMultiple([
285			'indices' => $this->indexRepository->findByPast($limit, $sort),
286			], __CLASS__, __FUNCTION__);
287			}
288
289			/**
290			* Year action.
291			*
292			* @param int $year
293			*/
294			public function yearAction($year = null)
295			{
296			$date = DateTimeUtility::normalizeDateTime(1, 1, $year);
297
298			$this->slotExtendedAssignMultiple([
299			'indices' => $this->indexRepository->findYear((int) $date->format('Y')),
300			'date' => $date,
301			], __CLASS__, __FUNCTION__);
302			}
303
304			/**
305			* Month action.
306			*
307			* @param int $year
308			* @param int $month
309			* @param int $day
310			*/
311			public function monthAction($year = null, $month = null, $day = null)
312			{
313			$date = DateTimeUtility::normalizeDateTime($day, $month, $year);
314
315			$this->slotExtendedAssignMultiple([
316			'date' => $date,
317			'indices' => $this->indexRepository->findMonth((int) $date->format('Y'), (int) $date->format('n')),
318			], __CLASS__, __FUNCTION__);
319			}
320
321			/**
322			* Week action.
323			*
324			* @param int $year
325			* @param int $week
326			*/
327			public function weekAction($year = null, $week = null)
328			{
329			$now = DateTimeUtility::getNow();
330			if (null === $year) {
331			$year = $now->format('o'); // 'o' instead of 'Y': http://php.net/manual/en/function.date.php#106974
332			}
333			if (null === $week) {
334			$week = $now->format('W');
335			}
336			$weekStart = (int) $this->settings['weekStart'];
337			$firstDay = DateTimeUtility::convertWeekYear2DayMonthYear((int) $week, $year, $weekStart);
338			$timezone = DateTimeUtility::getTimeZone();
339			$firstDay->setTimezone($timezone);
340			$firstDay->setTime(0, 0, 0);
341
342			$weekConfiguration = [
343			'+0 day' => 2,
344			'+1 days' => 2,
345			'+2 days' => 2,
346			'+3 days' => 2,
347			'+4 days' => 2,
348			'+5 days' => 1,
349			'+6 days' => 1,
350			];
351
352			$this->slotExtendedAssignMultiple([
353			'firstDay' => $firstDay,
354			'indices' => $this->indexRepository->findWeek($year, $week, $this->settings['weekStart']),
355			'weekConfiguration' => $weekConfiguration,
356			], __CLASS__, __FUNCTION__);
357			}
358
359			/**
360			* Day action.
361			*
362			* @param int $year
363			* @param int $month
364			* @param int $day
365			*/
366			public function dayAction($year = null, $month = null, $day = null)
367			{
368			$date = DateTimeUtility::normalizeDateTime($day, $month, $year);
369			$date->modify('+12 hours');
370
371			$previous = clone $date;
372			$previous->modify('-1 day');
373
374			$next = clone $date;
375			$next->modify('+1 day');
376
377			$this->slotExtendedAssignMultiple([
378			'indices' => $this->indexRepository->findDay((int) $date->format('Y'), (int) $date->format('n'), (int) $date->format('j')),
379			'today' => $date,
380			'previous' => $previous,
381			'next' => $next,
382			], __CLASS__, __FUNCTION__);
383			}
384
385			/**
386			* Detail action.
387			*
388			* @param \HDNET\Calendarize\Domain\Model\Index $index
389			*
390			* @return string
391			*/
392			public function detailAction(Index $index = null)
393			{
394			if (null === $index) {
395			// handle fallback for "strange language settings"
396			if ($this->request->hasArgument('index')) {
397			$indexId = (int) $this->request->getArgument('index');
398			if ($indexId > 0) {
399			$index = $this->indexRepository->findByUid($indexId);
400			}
401			}
402
403			if (null === $index) {
404			if (!MathUtility::canBeInterpretedAsInteger($this->settings['listPid'])) {
405			return (string) TranslateUtility::get('noEventDetailView');
406			}
407			$this->slottedRedirect(__CLASS__, __FUNCTION__ . 'noEvent');
408			}
409			}
410
411			$this->slotExtendedAssignMultiple([
412			'index' => $index,
413			'domain' => GeneralUtility::getIndpEnv('TYPO3_HOST_ONLY'),
414			], __CLASS__, __FUNCTION__);
415
416			return $this->view->render();
417			}
418
419			/**
420			* Render the search view.
421			*
422			* @param \DateTime $startDate
423			* @param \DateTime $endDate
424			* @param array $customSearch
425			*
426			* @ignorevalidation $startDate
427			* @ignorevalidation $endDate
428			* @ignorevalidation $customSearch
429			*/
430			public function searchAction(\DateTime $startDate = null, \DateTime $endDate = null, array $customSearch = [])
431			{
432			$baseDate = DateTimeUtility::getNow();
433			if (!($startDate instanceof \DateTimeInterface)) {
434			$startDate = clone $baseDate;
435			}
436			if (!($endDate instanceof \DateTimeInterface)) {
437			$baseDate->modify($this->settings['searchEndModifier']);
438			$endDate = $baseDate;
439			}
440
441			$this->slotExtendedAssignMultiple([
442			'startDate' => $startDate,
443			'endDate' => $endDate,
444			'customSearch' => $customSearch,
445			'configurations' => $this->getCurrentConfigurations(),
446			], __CLASS__, __FUNCTION__);
447			}
448
449			/**
450			* Render single items.
451			*/
452			public function singleAction()
453			{
454			$indicies = [];
455
456			// prepare selection
457			$selections = [];
458			$configurations = $this->getCurrentConfigurations();
459			foreach (GeneralUtility::trimExplode(',', $this->settings['singleItems']) as $item) {
460			list($table, $uid) = BackendUtility::splitTable_Uid($item);
461			foreach ($configurations as $configuration) {
462			if ($configuration['tableName'] === $table) {
463			$selections[] = [
464			'configuration' => $configuration,
465			'uid' => $uid,
466			];
467			break;
468			}
469			}
470			}
471
472			// fetch index
473			foreach ($selections as $selection) {
474			$this->indexRepository->setIndexTypes([$selection['configuration']['uniqueRegisterKey']]);
475			$dummyIndex = new Index();
476			$dummyIndex->setForeignTable($selection['configuration']['tableName']);
477			$dummyIndex->setForeignUid($selection['uid']);
478
479			$result = $this->indexRepository->findByTraversing($dummyIndex);
480			$index = $result->getQuery()->setLimit(1)->execute()->getFirst();
481			if (\is_object($index)) {
482			$indicies[] = $index;
483			}
484			}
485
486			$this->slotExtendedAssignMultiple([
487			'indicies' => $indicies,
488			'configurations' => $configurations,
489			], __CLASS__, __FUNCTION__);
490			}
491
492			/**
493			* Build the search structure.
494			*
495			* @param \DateTime\|null $startDate
496			* @param \DateTime\|null $endDate
497			* @param array $customSearch
498			* @param int $year
499			* @param int $month
500			* @param int $day
501			* @param int $week
502			*
503			* @return array
504			*/
505			protected function determineSearch(
506			\DateTime $startDate = null,
507			\DateTime $endDate = null,
508			array $customSearch = [],
509			$year = null,
510			$month = null,
511			$day = null,
512			$week = null
513			) {
514			$searchMode = false;
515			if ($startDate \|\| $endDate \|\| !empty($customSearch)) {
516			$searchMode = true;
517			$indices = $this->indexRepository->findBySearch($startDate, $endDate, $customSearch);
518			} elseif (MathUtility::canBeInterpretedAsInteger($year) && MathUtility::canBeInterpretedAsInteger($month) && MathUtility::canBeInterpretedAsInteger($day)) {
519			$indices = $this->indexRepository->findDay((int) $year, (int) $month, (int) $day);
520			} elseif (MathUtility::canBeInterpretedAsInteger($year) && MathUtility::canBeInterpretedAsInteger($month)) {
521			$indices = $this->indexRepository->findMonth((int) $year, (int) $month);
522			} elseif (MathUtility::canBeInterpretedAsInteger($year) && MathUtility::canBeInterpretedAsInteger($week)) {
523			$indices = $this->indexRepository->findWeek($year, $week, $this->settings['weekStart']);
524			} elseif (MathUtility::canBeInterpretedAsInteger($year)) {
525			$indices = $this->indexRepository->findYear((int) $year);
526			} else {
527			$overrideStartDate = (int) $this->settings['overrideStartdate'];
528			$overrideEndDate = (int) $this->settings['overrideEnddate'];
529			$indices = $this->indexRepository->findList(
530			(int) $this->settings['limit'],
531			$this->settings['listStartTime'],
532			(int) $this->settings['listStartTimeOffsetHours'],
533			$overrideStartDate,
534			$overrideEndDate
535			);
536			}
537
538			// use this variable in your extension to add more custom variables
539			$variables = [
540			'extended' => [
541			'indices' => $indices,
542			'searchMode' => $searchMode,
543			'parameters' => [
544			'startDate' => $startDate,
545			'endDate' => $endDate,
546			'customSearch' => $customSearch,
547			'year' => $year,
548			'month' => $month,
549			'day' => $day,
550			'week' => $week,
551			],
552			],
553			];
554			$variables['settings'] = $this->settings;
555
556			$dispatcher = $this->objectManager->get(Dispatcher::class);
557			$variables = $dispatcher->dispatch(__CLASS__, __FUNCTION__, $variables);
558
559			return $variables['extended'];
560			}
561
562			/**
563			* Get the allowed actions.
564			*
565			* @return array
566			*/
567			protected function getAllowedActions(): array
568			{
569			$configuration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
570			$allowedActions = [];
571			foreach ($configuration['controllerConfiguration'] as $controllerName => $controllerActions) {
572			$allowedActions[$controllerName] = $controllerActions['actions'];
573			}
574
575			return \is_array($allowedActions['Calendar']) ? $allowedActions['Calendar'] : [];
576			}
577
578			/**
579			* Get the current configurations.
580			*
581			* @return array
582			*/
583			protected function getCurrentConfigurations()
584			{
585			$configurations = GeneralUtility::trimExplode(',', $this->settings['configuration'], true);
586			$return = [];
587			foreach (Register::getRegister() as $key => $configuration) {
588			if (\in_array($key, $configurations, true)) {
589			$return[] = $configuration;
590			}
591			}
592
593			return $return;
594			}
595
596			/**
597			* A redirect that have a slot included.
598			*
599			* @param string $signalClassName name of the signal class: __CLASS__
600			* @param string $signalName name of the signal: __FUNCTION__
601			* @param array $variables optional: if not set use the defaults
602			*/
603			protected function slottedRedirect($signalClassName, $signalName, $variables = null)
604			{
605			// set default variables for the redirect
606			if (null === $variables) {
607			$variables['extended'] = [
608			'actionName' => 'list',
609			'controllerName' => null,
610			'extensionName' => null,
611			'arguments' => [],
612			'pageUid' => $this->settings['listPid'],
613			'delay' => 0,
614			'statusCode' => 301,
615			];
616			$variables['extended']['pluginHmac'] = $this->calculatePluginHmac();
617			$variables['settings'] = $this->settings;
618			}
619
620			$dispatcher = $this->objectManager->get(Dispatcher::class);
621			$variables = $dispatcher->dispatch($signalClassName, $signalName, $variables);
622
623			$this->redirect(
624			$variables['extended']['actionName'],
625			$variables['extended']['controllerName'],
626			$variables['extended']['extensionName'],
627			$variables['extended']['arguments'],
628			$variables['extended']['pageUid'],
629			$variables['extended']['delay'],
630			$variables['extended']['statusCode']
631			);
632			}
633			}
634

lochmueller / calendarize

Push — master ( 226640...8edbcf )

CalendarController::listAction() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like