AdministrationController - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master'" - derhansen/sf_event_mgt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 582c54...9e2bdc )

by Torben

created 2019-07-19 05:23 UTC

AdministrationController B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	515
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	27

Test Coverage

Coverage

97.01%

Importance

Changes

Metric	Value
wmc	43
lcom	1
cbo	27
dl	0
loc	515
ccs	65
cts	67
cp	0.9701
rs	8.96
c	0
b	0
f	0

26 Methods

Rating	Name	Size	Complexity
A	injectCustomNotificationLogRepository()	5	1
A	injectExportService()	4	1
A	injectSettingsService()	4	1
A	injectBeUserSessionService()	4	1
A	injectIconFactory()	4	1
A	injectMaintenanceService()	4	1
B	initializeView()	26	6
B	registerDocHeaderButtons()	58	3
B	redirectToCreateNewRecord()	25	6
A	initializeAction()	4	1
A	initializeListAction()	20	3
A	listAction()	32	2
A	exportAction()	5	1
A	handleExpiredRegistrationsAction()	13	1
A	indexNotifyAction()	10	1
A	newEventAction()	4	1
A	newLocationAction()	4	1
A	newOrganisatorAction()	4	1
A	newSpeakerAction()	4	1
A	notifyAction()	16	1
A	settingsErrorAction()	3	1
A	getErrorFlashMessage()	4	1
A	getToken()	16	3
A	getLanguageService()	4	1
A	getOrderDirections()	7	1
A	getOrderByFields()	8	1

How to fix Complexity

<?php
namespace DERHANSEN\SfEventMgt\Controller;

/*
 * This file is part of the Extension "sf_event_mgt" for TYPO3 CMS.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

use DERHANSEN\SfEventMgt\Domain\Model\Dto\EventDemand;
use DERHANSEN\SfEventMgt\Domain\Model\Dto\SearchDemand;
use DERHANSEN\SfEventMgt\Domain\Model\Event;
use DERHANSEN\SfEventMgt\Service;
use DERHANSEN\SfEventMgt\Utility\MiscUtility;
use TYPO3\CMS\Backend\Template\Components\ButtonBar;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Backend\View\BackendTemplateView;
use TYPO3\CMS\Core\FormProtection\FormProtectionFactory;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Utility\HttpUtility;
use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
use TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder;
use TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter;
use TYPO3\CMS\Lang\LanguageService;

/**
 * AdministrationController
 *
 * Several parts are heavily inspired by ext:news from Georg Ringer
 *
 * @author Torben Hansen <[email protected]>
 */
class AdministrationController extends AbstractController
{
    const LANG_FILE = 'LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:';

    /**
     * Backend Template Container
     *
     * @var string
     */
    protected $defaultViewObjectName = \TYPO3\CMS\Backend\View\BackendTemplateView::class;

    /**
     * CustomNotificationLogRepository
     *
     * @var \DERHANSEN\SfEventMgt\Domain\Repository\CustomNotificationLogRepository
     */
    protected $customNotificationLogRepository = null;

    /**
     * ExportService
     *
     * @var \DERHANSEN\SfEventMgt\Service\ExportService
     */
    protected $exportService = null;

    /**
     * SettingsService
     *
     * @var \DERHANSEN\SfEventMgt\Service\SettingsService
     */
    protected $settingsService = null;

    /**
     * Backend User Session Service
     *
     * @var \DERHANSEN\SfEventMgt\Service\BeUserSessionService
     */
    protected $beUserSessionService = null;

    /**
     * @var \DERHANSEN\SfEventMgt\Service\MaintenanceService
     */
    protected $maintenanceService = null;

    /**
     * The current page uid
     *
     * @var int
     */
    protected $pid = 0;

    /**
     * BackendTemplateContainer
     *
     * @var BackendTemplateView
     */
    protected $view;

    /**
     * @var IconFactory
     */
    protected $iconFactory = null;

    /**
     * DI for $customNotificationLogRepository
     *
     * @param \DERHANSEN\SfEventMgt\Domain\Repository\CustomNotificationLogRepository $customNotificationLogRepository
     */
    public function injectCustomNotificationLogRepository(
        \DERHANSEN\SfEventMgt\Domain\Repository\CustomNotificationLogRepository $customNotificationLogRepository
    ) {
        $this->customNotificationLogRepository = $customNotificationLogRepository;
    }

    /**
     * DI for $exportService
     *
     * @param Service\ExportService $exportService
     */
    public function injectExportService(\DERHANSEN\SfEventMgt\Service\ExportService $exportService)
    {
        $this->exportService = $exportService;
    }

    /**
     * DI for $settingsService
     *
     * @param Service\SettingsService $settingsService
     */
    public function injectSettingsService(\DERHANSEN\SfEventMgt\Service\SettingsService $settingsService)
    {
        $this->settingsService = $settingsService;
    }

    /**
     * DI for $beUserSessionService
     *
     * @param Service\BeUserSessionService $beUserSessionService
     */
    public function injectBeUserSessionService(\DERHANSEN\SfEventMgt\Service\BeUserSessionService $beUserSessionService)
    {
        $this->beUserSessionService = $beUserSessionService;
    }

    /**
     * DI for $iconFactory
     *
     * @param IconFactory $iconFactory
     */
    public function injectIconFactory(IconFactory $iconFactory)
    {
        $this->iconFactory = $iconFactory;
    }

    /**
     * @param Service\MaintenanceService $maintenanceService
     */
    public function injectMaintenanceService(\DERHANSEN\SfEventMgt\Service\MaintenanceService $maintenanceService)
    {
        $this->maintenanceService = $maintenanceService;
    }

    /**
     * Set up the doc header properly here
     *
     * @param ViewInterface $view
     *
     * @return void
     */
    protected function initializeView(ViewInterface $view)
    {
        /** @var BackendTemplateView $view */
        parent::initializeView($view);
        if ($this->actionMethodName === 'listAction'
            || $this->actionMethodName === 'indexNotifyAction'
            || $this->actionMethodName === 'settingsErrorAction'
        ) {
            $this->registerDocHeaderButtons();

            $pageRenderer = $this->view->getModuleTemplate()->getPageRenderer();
            $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/DateTimePicker');

            $dateFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['USdateFormat'] ?
                ['MM-DD-YYYY', 'HH:mm MM-DD-YYYY'] :
                ['DD-MM-YYYY', 'HH:mm DD-MM-YYYY'];
            $pageRenderer->addInlineSetting('DateTimePicker', 'DateFormat', $dateFormat);

            $this->view->getModuleTemplate()->setFlashMessageQueue($this->controllerContext->getFlashMessageQueue());
            if ($view instanceof BackendTemplateView) {
                $view->getModuleTemplate()->getPageRenderer()->addCssFile(
                    'EXT:sf_event_mgt/Resources/Public/Css/administration.css'
                );
            }
        }
    }

    /**
     * Register docHeaderButtons
     *
     * @return void
     */
    protected function registerDocHeaderButtons()
    {
        $buttonBar = $this->view->getModuleTemplate()->getDocHeaderComponent()->getButtonBar();

        $uriBuilder = $this->objectManager->get(UriBuilder::class);
        $uriBuilder->setRequest($this->request);

        if ($this->request->getControllerActionName() === 'list') {
            $buttons = [
                [
                    'label' => 'administration.newEvent',
                    'action' => 'newEvent',
                    'icon' => 'ext-sfeventmgt-event',
                    'group' => 1
                ],
                [
                    'label' => 'administration.newLocation',
                    'action' => 'newLocation',
                    'icon' => 'ext-sfeventmgt-location',
                    'group' => 1
                ],
                [
                    'label' => 'administration.newOrganisator',
                    'action' => 'newOrganisator',
                    'icon' => 'ext-sfeventmgt-organisator',
                    'group' => 1
                ],
                [
                    'label' => 'administration.newSpeaker',
                    'action' => 'newSpeaker',
                    'icon' => 'ext-sfeventmgt-speaker',
                    'group' => 1
                ],
                [
                    'label' => 'administration.handleExpiredRegistrations',
                    'action' => 'handleExpiredRegistrations',
                    'icon' => 'ext-sfeventmgt-action-handle-expired',
                    'group' => 2
                ]
            ];
            foreach ($buttons as $key => $tableConfiguration) {
                $title = $this->getLanguageService()->sL(self::LANG_FILE . $tableConfiguration['label']);
                $link = $uriBuilder->reset()->setRequest($this->request)
                    ->uriFor($tableConfiguration['action'], [], 'Administration');
                $icon = $this->iconFactory->getIcon($tableConfiguration['icon'], Icon::SIZE_SMALL);
                $viewButton = $buttonBar->makeLinkButton()
                    ->setHref($link)
                    ->setDataAttributes([
                        'toggle' => 'tooltip',
                        'placement' => 'bottom',
                        'title' => $title
                        ])
                    ->setTitle($title)
                    ->setIcon($icon);
                $buttonBar->addButton($viewButton, ButtonBar::BUTTON_POSITION_LEFT, $tableConfiguration['group']);
            }
        }
    }

    /**
     * Redirect to tceform creating a new record
     *
     * @param string $table table name
     * @return void
     */
    private function redirectToCreateNewRecord($table)
    {
        $pid = $this->pid;
        $tsConfig = BackendUtility::getPagesTSconfig(0);
        if ($pid === 0 && isset($tsConfig['defaultPid.'])
            && is_array($tsConfig['defaultPid.'])
            && isset($tsConfig['defaultPid.'][$table])
        ) {
            $pid = (int)$tsConfig['defaultPid.'][$table];
        }

        if (MiscUtility::isV9Lts()) {
            $returnUrl = 'index.php?route=/web/SfEventMgtTxSfeventmgtM1/';
        } else {
            $returnUrl = 'index.php?M=web_SfEventMgtTxSfeventmgtM1';
        }

        $returnUrl .= '&id=' . $this->pid . $this->getToken();
        $url = BackendUtility::getModuleUrl('record_edit', [

            'edit[' . $table . '][' . $pid . ']' => 'new',
            'returnUrl' => $returnUrl
        ]);

        HttpUtility::redirect($url);
    }

    /**
     * Initialize action
     *
     * @return void
     */
    public function initializeAction()
    {
        $this->pid = (int)\TYPO3\CMS\Core\Utility\GeneralUtility::_GET('id');
    }

    /**
     * Set date format for fields startDate and endDate
     *
     * @return void
     */
    public function initializeListAction()
    {
        if ($this->settings === null || empty($this->settings)) {
            $this->redirect('settingsError');
        }
        $this->arguments->getArgument('searchDemand')
            ->getPropertyMappingConfiguration()->forProperty('startDate')
            ->setTypeConverterOption(
                DateTimeConverter::class,
                DateTimeConverter::CONFIGURATION_DATE_FORMAT,
                $this->settings['search']['dateFormat']
            );
        $this->arguments->getArgument('searchDemand')
            ->getPropertyMappingConfiguration()->forProperty('endDate')
            ->setTypeConverterOption(
                DateTimeConverter::class,
                DateTimeConverter::CONFIGURATION_DATE_FORMAT,
                $this->settings['search']['dateFormat']
            );
    }

    /**
     * List action for backend module
     *
     * @param \DERHANSEN\SfEventMgt\Domain\Model\Dto\SearchDemand $searchDemand SearchDemand
     * @param array $overwriteDemand OverwriteDemand
     *
     * @return void
     */
    public function listAction(SearchDemand $searchDemand = null, array $overwriteDemand = [])
    {
        /** @var EventDemand $eventDemand */
        $eventDemand = $this->objectManager->get(EventDemand::class);
        $eventDemand = $this->overwriteEventDemandObject($eventDemand, $overwriteDemand);
        $eventDemand->setOrderFieldAllowed($this->settings['orderFieldAllowed']);

        if ($searchDemand !== null) {
            $searchDemand->setFields($this->settings['search']['fields']);

            $sessionData = [];
            $sessionData['searchDemand'] = $searchDemand;
            $sessionData['overwriteDemand'] = $overwriteDemand;
            $this->beUserSessionService->saveSessionData($sessionData);
        } else {
            // Try to restore search demand from Session
            $searchDemand = $this->beUserSessionService->getSessionDataByKey('searchDemand');
            $overwriteDemand = $this->beUserSessionService->getSessionDataByKey('overwriteDemand');
        }

        $eventDemand->setSearchDemand($searchDemand);
        $eventDemand->setStoragePage($this->pid);

        $this->view->assignMultiple([
            'pid' => $this->pid,
            'events' => $this->eventRepository->findDemanded($eventDemand),
            'searchDemand' => $searchDemand,
            'orderByFields' => $this->getOrderByFields(),
            'orderDirections' => $this->getOrderDirections(),
            'overwriteDemand' => $overwriteDemand,
        ]);
    }

    /**
     * Export registrations for a given event
     *
     * @param int $eventUid Event UID
     *
     * @return void
     */
    public function exportAction($eventUid)
    {
        $this->exportService->downloadRegistrationsCsv($eventUid, $this->settings['csvExport']);
        exit();
    }

    /**
     * Handles expired registrations
     *
     * @return void
     */
    public function handleExpiredRegistrationsAction()
    {
        $delete = (bool)$this->settings['registration']['deleteExpiredRegistrations'];
        $this->maintenanceService->handleExpiredRegistrations($delete);

        $this->addFlashMessage(
            $this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-1.content'),
            $this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-1.title'),
            FlashMessage::OK
        );

        $this->redirect('list');
    }

    /**
     * The index notify action
     *
     * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event Event
     *
     * @return void
     */
    public function indexNotifyAction(Event $event)
    {
        $customNotifications = $this->settingsService->getCustomNotifications($this->settings);
        $logEntries = $this->customNotificationLogRepository->findByEvent($event);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->view->assignMultiple([
            'event' => $event,
            'customNotifications' => $customNotifications,
            'logEntries' => $logEntries,
        ]);
    }

    /**
     * Create new event action
     */
    public function newEventAction()
    {
        $this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_event');
    }

    /**
     * Create new location action
     */
    public function newLocationAction()
    {
        $this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_location');
    }

    /**
     * Create new organisator action
     */
    public function newOrganisatorAction()
    {
        $this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_organisator');
    }

    /**
     * Create new speaker action
     */
    public function newSpeakerAction()
    {
        $this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_speaker');
    }

    /**
     * Notify action
     *
     * @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event Event
     * @param string $customNotification CustomNotification
     *
     * @return void
     */
    public function notifyAction(Event $event, $customNotification)
    {
        $customNotifications = $this->settingsService->getCustomNotifications($this->settings);
        $result = $this->notificationService->sendCustomNotification($event, $customNotification, $this->settings);
        $this->notificationService->createCustomNotificationLogentry(
            $event,
            $customNotifications[$customNotification],
            $result
        );
        $this->addFlashMessage(
            $this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-2.content'),
            $this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-2.title'),
            FlashMessage::OK
        );
        $this->redirect('list');
    }

    /**
     * Shows the settings error view
     *
     * @return void
     */
    public function settingsErrorAction()
    {
    }

    /**
     * Suppress default validation messages
     *
     * @return bool
     */
    protected function getErrorFlashMessage()
    {
        return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Get a CSRF token
     *
     * @param bool $tokenOnly Set it to TRUE to get only the token, otherwise including the &moduleToken= as prefix
     * @return string
     */
    protected function getToken(bool $tokenOnly = false): string
    {
        if (MiscUtility::isV9Lts()) {
            $tokenParameterName = 'token';
            $token = FormProtectionFactory::get('backend')->generateToken('route', 'web_SfEventMgtTxSfeventmgtM1');
        } else {
            $tokenParameterName = 'moduleToken';
            $token = FormProtectionFactory::get()->generateToken('moduleCall', 'web_SfEventMgtTxSfeventmgtM1');
        }

        if ($tokenOnly) {
            return $token;
        }

        return '&' . $tokenParameterName . '=' . $token;
    }

    /**
     * Returns the LanguageService
     *
     * @return LanguageService
     */
    protected function getLanguageService(): LanguageService
    {
        return $GLOBALS['LANG'];
    }

    /**
     * Returns an array with possible order directions
     *
     * @return array
     */
    public function getOrderDirections()
    {
        return [
            'asc' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.sortOrder.asc'),
            'desc' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.sortOrder.desc')
        ];
    }

    /**
     * Returns an array with possible orderBy fields
     *
     * @return array
     */
    public function getOrderByFields()
    {
        return [
            'title' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.orderBy.title'),
            'startdate' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.orderBy.startdate'),
            'enddate' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.orderBy.enddate')
        ];
    }
}


1		<?php
2		namespace DERHANSEN\SfEventMgt\Controller;
3
4		/*
5		* This file is part of the Extension "sf_event_mgt" for TYPO3 CMS.
6		*
7		* For the full copyright and license information, please read the
8		* LICENSE.txt file that was distributed with this source code.
9		*/
10
11		use DERHANSEN\SfEventMgt\Domain\Model\Dto\EventDemand;
12		use DERHANSEN\SfEventMgt\Domain\Model\Dto\SearchDemand;
13		use DERHANSEN\SfEventMgt\Domain\Model\Event;
14		use DERHANSEN\SfEventMgt\Service;
15		use DERHANSEN\SfEventMgt\Utility\MiscUtility;
16		use TYPO3\CMS\Backend\Template\Components\ButtonBar;
17		use TYPO3\CMS\Backend\Utility\BackendUtility;
18		use TYPO3\CMS\Backend\View\BackendTemplateView;
19		use TYPO3\CMS\Core\FormProtection\FormProtectionFactory;
20		use TYPO3\CMS\Core\Imaging\Icon;
21		use TYPO3\CMS\Core\Imaging\IconFactory;
22		use TYPO3\CMS\Core\Messaging\FlashMessage;
23		use TYPO3\CMS\Core\Utility\HttpUtility;
24		use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
25		use TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder;
26		use TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter;
27		use TYPO3\CMS\Lang\LanguageService;
28
29		/**
30		* AdministrationController
31		*
32		* Several parts are heavily inspired by ext:news from Georg Ringer
33		*
34		* @author Torben Hansen <[email protected]>
35		*/
36		class AdministrationController extends AbstractController
37		{
38		const LANG_FILE = 'LLL:EXT:sf_event_mgt/Resources/Private/Language/locallang_be.xlf:';
39
40		/**
41		* Backend Template Container
42		*
43		* @var string
44		*/
45		protected $defaultViewObjectName = \TYPO3\CMS\Backend\View\BackendTemplateView::class;
46
47		/**
48		* CustomNotificationLogRepository
49		*
50		* @var \DERHANSEN\SfEventMgt\Domain\Repository\CustomNotificationLogRepository
51		*/
52		protected $customNotificationLogRepository = null;
53
54		/**
55		* ExportService
56		*
57		* @var \DERHANSEN\SfEventMgt\Service\ExportService
58		*/
59		protected $exportService = null;
60
61		/**
62		* SettingsService
63		*
64		* @var \DERHANSEN\SfEventMgt\Service\SettingsService
65		*/
66		protected $settingsService = null;
67
68		/**
69		* Backend User Session Service
70		*
71		* @var \DERHANSEN\SfEventMgt\Service\BeUserSessionService
72		*/
73		protected $beUserSessionService = null;
74
75		/**
76		* @var \DERHANSEN\SfEventMgt\Service\MaintenanceService
77		*/
78		protected $maintenanceService = null;
79
80		/**
81		* The current page uid
82		*
83		* @var int
84		*/
85		protected $pid = 0;
86
87		/**
88		* BackendTemplateContainer
89		*
90		* @var BackendTemplateView
91	2	*/
92		protected $view;
93	2
94	2	/**
95		* @var IconFactory
96		*/
97		protected $iconFactory = null;
98
99		/**
100		* DI for $customNotificationLogRepository
101	4	*
102		* @param \DERHANSEN\SfEventMgt\Domain\Repository\CustomNotificationLogRepository $customNotificationLogRepository
103	4	*/
104	2	public function injectCustomNotificationLogRepository(
105	2	\DERHANSEN\SfEventMgt\Domain\Repository\CustomNotificationLogRepository $customNotificationLogRepository
106	4	) {
107	4	$this->customNotificationLogRepository = $customNotificationLogRepository;
108	4	}
109	4
110	4	/**
111	4	* DI for $exportService
112	4	*
113	4	* @param Service\ExportService $exportService
114	4	*/
115	4	public function injectExportService(\DERHANSEN\SfEventMgt\Service\ExportService $exportService)
116	4	{
117	4	$this->exportService = $exportService;
118	4	}
119	4
120	4	/**
121		* DI for $settingsService
122		*
123		* @param Service\SettingsService $settingsService
124		*/
125		public function injectSettingsService(\DERHANSEN\SfEventMgt\Service\SettingsService $settingsService)
126		{
127		$this->settingsService = $settingsService;
128		}
129
130	8	/**
131		* DI for $beUserSessionService
132		*
133	8	* @param Service\BeUserSessionService $beUserSessionService
134		*/
135	8	public function injectBeUserSessionService(\DERHANSEN\SfEventMgt\Service\BeUserSessionService $beUserSessionService)
136	6	{
137	6	$this->beUserSessionService = $beUserSessionService;
138	8	}
139
140	8	/**
141	4	* DI for $iconFactory
142	4	*
143		* @param IconFactory $iconFactory
144	8	*/
145	2	public function injectIconFactory(IconFactory $iconFactory)
146	2	{
147	2	$this->iconFactory = $iconFactory;
148	2	}
149
150	8	/**
151	8	* @param Service\MaintenanceService $maintenanceService
152	8	*/
153	8	public function injectMaintenanceService(\DERHANSEN\SfEventMgt\Service\MaintenanceService $maintenanceService)
154		{
155		$this->maintenanceService = $maintenanceService;
156		}
157
158		/**
159		* Set up the doc header properly here
160		*
161		* @param ViewInterface $view
162	2	*
163		* @return void
164	2	*/
165	2	protected function initializeView(ViewInterface $view)
166		{
167		/** @var BackendTemplateView $view */
168		parent::initializeView($view);
169		if ($this->actionMethodName === 'listAction'
170		\|\| $this->actionMethodName === 'indexNotifyAction'
171		\|\| $this->actionMethodName === 'settingsErrorAction'
172		) {
173	2	$this->registerDocHeaderButtons();
174
175	2	$pageRenderer = $this->view->getModuleTemplate()->getPageRenderer();
176	2	$pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/DateTimePicker');
177	2
178		$dateFormat = $GLOBALS['TYPO3_CONF_VARS']['SYS']['USdateFormat'] ?
179		['MM-DD-YYYY', 'HH:mm MM-DD-YYYY'] :
180		['DD-MM-YYYY', 'HH:mm DD-MM-YYYY'];
181		$pageRenderer->addInlineSetting('DateTimePicker', 'DateFormat', $dateFormat);
182
183		$this->view->getModuleTemplate()->setFlashMessageQueue($this->controllerContext->getFlashMessageQueue());
184		if ($view instanceof BackendTemplateView) {
185		$view->getModuleTemplate()->getPageRenderer()->addCssFile(
186	2	'EXT:sf_event_mgt/Resources/Public/Css/administration.css'
187		);
188	2	}
189	2	}
190	2	}
191	2
192	2	/**
193	2	* Register docHeaderButtons
194	2	*
195	2	* @return void
196		*/
197		protected function registerDocHeaderButtons()
198		{
199		$buttonBar = $this->view->getModuleTemplate()->getDocHeaderComponent()->getButtonBar();
200
201		$uriBuilder = $this->objectManager->get(UriBuilder::class);
202		$uriBuilder->setRequest($this->request);
203
204		if ($this->request->getControllerActionName() === 'list') {
205	2	$buttons = [
206		[
207	2	'label' => 'administration.newEvent',
208	2	'action' => 'newEvent',
209	2	'icon' => 'ext-sfeventmgt-event',
210	2	'group' => 1
211	2	],
212		[
213	2	'label' => 'administration.newLocation',
214	2	'action' => 'newLocation',
215	2	'icon' => 'ext-sfeventmgt-location',
216		'group' => 1
217		],
218		[
219		'label' => 'administration.newOrganisator',
220		'action' => 'newOrganisator',
221		'icon' => 'ext-sfeventmgt-organisator',
222		'group' => 1
223		],
224		[
225		'label' => 'administration.newSpeaker',
226		'action' => 'newSpeaker',
227		'icon' => 'ext-sfeventmgt-speaker',
228		'group' => 1
229		],
230		[
231		'label' => 'administration.handleExpiredRegistrations',
232		'action' => 'handleExpiredRegistrations',
233		'icon' => 'ext-sfeventmgt-action-handle-expired',
234		'group' => 2
235		]
236		];
237		foreach ($buttons as $key => $tableConfiguration) {
238		$title = $this->getLanguageService()->sL(self::LANG_FILE . $tableConfiguration['label']);
239		$link = $uriBuilder->reset()->setRequest($this->request)
240		->uriFor($tableConfiguration['action'], [], 'Administration');
241		$icon = $this->iconFactory->getIcon($tableConfiguration['icon'], Icon::SIZE_SMALL);
242		$viewButton = $buttonBar->makeLinkButton()
243		->setHref($link)
244		->setDataAttributes([
245		'toggle' => 'tooltip',
246		'placement' => 'bottom',
247		'title' => $title
248		])
249		->setTitle($title)
250		->setIcon($icon);
251		$buttonBar->addButton($viewButton, ButtonBar::BUTTON_POSITION_LEFT, $tableConfiguration['group']);
252		}
253		}
254		}
255
256		/**
257		* Redirect to tceform creating a new record
258		*
259		* @param string $table table name
260		* @return void
261		*/
262		private function redirectToCreateNewRecord($table)
263		{
264		$pid = $this->pid;
265		$tsConfig = BackendUtility::getPagesTSconfig(0);
266		if ($pid === 0 && isset($tsConfig['defaultPid.'])
267		&& is_array($tsConfig['defaultPid.'])
268		&& isset($tsConfig['defaultPid.'][$table])
269		) {
270		$pid = (int)$tsConfig['defaultPid.'][$table];
271		}
272
273		if (MiscUtility::isV9Lts()) {
274		$returnUrl = 'index.php?route=/web/SfEventMgtTxSfeventmgtM1/';
275		} else {
276		$returnUrl = 'index.php?M=web_SfEventMgtTxSfeventmgtM1';
277		}
278
279		$returnUrl .= '&id=' . $this->pid . $this->getToken();
280		$url = BackendUtility::getModuleUrl('record_edit', [
		0 ignored issues – show Deprecated Code introduced 2019-02-09 13:04 UTC by Report Bug Copy Issue Report The method `TYPO3\CMS\Backend\Utilit...Utility::getModuleUrl()` has been deprecated with message: since TYPO3 v9, will be removed in TYPO3 v10.0. Use UriBuilder instead. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
281		'edit[' . $table . '][' . $pid . ']' => 'new',
282		'returnUrl' => $returnUrl
283		]);
284
285		HttpUtility::redirect($url);
286		}
287
288		/**
289		* Initialize action
290		*
291		* @return void
292		*/
293		public function initializeAction()
294		{
295		$this->pid = (int)\TYPO3\CMS\Core\Utility\GeneralUtility::_GET('id');
296		}
297
298		/**
299		* Set date format for fields startDate and endDate
300		*
301		* @return void
302		*/
303		public function initializeListAction()
304		{
305		if ($this->settings === null \|\| empty($this->settings)) {
306		$this->redirect('settingsError');
307		}
308		$this->arguments->getArgument('searchDemand')
309		->getPropertyMappingConfiguration()->forProperty('startDate')
310		->setTypeConverterOption(
311		DateTimeConverter::class,
312		DateTimeConverter::CONFIGURATION_DATE_FORMAT,
313		$this->settings['search']['dateFormat']
314		);
315		$this->arguments->getArgument('searchDemand')
316		->getPropertyMappingConfiguration()->forProperty('endDate')
317		->setTypeConverterOption(
318		DateTimeConverter::class,
319		DateTimeConverter::CONFIGURATION_DATE_FORMAT,
320		$this->settings['search']['dateFormat']
321		);
322		}
323
324		/**
325		* List action for backend module
326		*
327		* @param \DERHANSEN\SfEventMgt\Domain\Model\Dto\SearchDemand $searchDemand SearchDemand
328		* @param array $overwriteDemand OverwriteDemand
329		*
330		* @return void
331		*/
332		public function listAction(SearchDemand $searchDemand = null, array $overwriteDemand = [])
333		{
334		/** @var EventDemand $eventDemand */
335		$eventDemand = $this->objectManager->get(EventDemand::class);
336		$eventDemand = $this->overwriteEventDemandObject($eventDemand, $overwriteDemand);
337		$eventDemand->setOrderFieldAllowed($this->settings['orderFieldAllowed']);
338
339		if ($searchDemand !== null) {
340		$searchDemand->setFields($this->settings['search']['fields']);
341
342		$sessionData = [];
343		$sessionData['searchDemand'] = $searchDemand;
344		$sessionData['overwriteDemand'] = $overwriteDemand;
345		$this->beUserSessionService->saveSessionData($sessionData);
346		} else {
347		// Try to restore search demand from Session
348		$searchDemand = $this->beUserSessionService->getSessionDataByKey('searchDemand');
349		$overwriteDemand = $this->beUserSessionService->getSessionDataByKey('overwriteDemand');
350		}
351
352		$eventDemand->setSearchDemand($searchDemand);
353		$eventDemand->setStoragePage($this->pid);
354
355		$this->view->assignMultiple([
356		'pid' => $this->pid,
357		'events' => $this->eventRepository->findDemanded($eventDemand),
358		'searchDemand' => $searchDemand,
359		'orderByFields' => $this->getOrderByFields(),
360		'orderDirections' => $this->getOrderDirections(),
361		'overwriteDemand' => $overwriteDemand,
362		]);
363		}
364
365		/**
366		* Export registrations for a given event
367		*
368		* @param int $eventUid Event UID
369		*
370		* @return void
371		*/
372		public function exportAction($eventUid)
373		{
374		$this->exportService->downloadRegistrationsCsv($eventUid, $this->settings['csvExport']);
375		exit();
376		}
377
378		/**
379		* Handles expired registrations
380		*
381		* @return void
382		*/
383		public function handleExpiredRegistrationsAction()
384		{
385		$delete = (bool)$this->settings['registration']['deleteExpiredRegistrations'];
386		$this->maintenanceService->handleExpiredRegistrations($delete);
387
388		$this->addFlashMessage(
389		$this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-1.content'),
390		$this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-1.title'),
391		FlashMessage::OK
392		);
393
394		$this->redirect('list');
395		}
396
397		/**
398		* The index notify action
399		*
400		* @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event Event
401		*
402		* @return void
403		*/
404		public function indexNotifyAction(Event $event)
405		{
406		$customNotifications = $this->settingsService->getCustomNotifications($this->settings);
407		$logEntries = $this->customNotificationLogRepository->findByEvent($event);
		0 ignored issues – show Documentation Bug introduced 2017-07-02 05:21 UTC by Report Bug Copy Issue Report The method `findByEvent` does not exist on `object<DERHANSEN\SfEvent...ificationLogRepository>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
408		$this->view->assignMultiple([
409		'event' => $event,
410		'customNotifications' => $customNotifications,
411		'logEntries' => $logEntries,
412		]);
413		}
414
415		/**
416		* Create new event action
417		*/
418		public function newEventAction()
419		{
420		$this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_event');
421		}
422
423		/**
424		* Create new location action
425		*/
426		public function newLocationAction()
427		{
428		$this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_location');
429		}
430
431		/**
432		* Create new organisator action
433		*/
434		public function newOrganisatorAction()
435		{
436		$this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_organisator');
437		}
438
439		/**
440		* Create new speaker action
441		*/
442		public function newSpeakerAction()
443		{
444		$this->redirectToCreateNewRecord('tx_sfeventmgt_domain_model_speaker');
445		}
446
447		/**
448		* Notify action
449		*
450		* @param \DERHANSEN\SfEventMgt\Domain\Model\Event $event Event
451		* @param string $customNotification CustomNotification
452		*
453		* @return void
454		*/
455		public function notifyAction(Event $event, $customNotification)
456		{
457		$customNotifications = $this->settingsService->getCustomNotifications($this->settings);
458		$result = $this->notificationService->sendCustomNotification($event, $customNotification, $this->settings);
459		$this->notificationService->createCustomNotificationLogentry(
460		$event,
461		$customNotifications[$customNotification],
462		$result
463		);
464		$this->addFlashMessage(
465		$this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-2.content'),
466		$this->getLanguageService()->sL(self::LANG_FILE . 'administration.message-2.title'),
467		FlashMessage::OK
468		);
469		$this->redirect('list');
470		}
471
472		/**
473		* Shows the settings error view
474		*
475		* @return void
476		*/
477		public function settingsErrorAction()
478		{
479		}
480
481		/**
482		* Suppress default validation messages
483		*
484		* @return bool
485		*/
486		protected function getErrorFlashMessage()
487		{
488		return false;
		0 ignored issues – show Bug Best Practice introduced 2018-02-26 18:17 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `TYPO3\CMS\Extbase\Mvc\Co...r::getErrorFlashMessage` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
489		}
490
491		/**
492		* Get a CSRF token
493		*
494		* @param bool $tokenOnly Set it to TRUE to get only the token, otherwise including the &moduleToken= as prefix
495		* @return string
496		*/
497		protected function getToken(bool $tokenOnly = false): string
498		{
499		if (MiscUtility::isV9Lts()) {
500		$tokenParameterName = 'token';
501		$token = FormProtectionFactory::get('backend')->generateToken('route', 'web_SfEventMgtTxSfeventmgtM1');
502		} else {
503		$tokenParameterName = 'moduleToken';
504		$token = FormProtectionFactory::get()->generateToken('moduleCall', 'web_SfEventMgtTxSfeventmgtM1');
505		}
506
507		if ($tokenOnly) {
508		return $token;
509		}
510
511		return '&' . $tokenParameterName . '=' . $token;
512		}
513
514		/**
515		* Returns the LanguageService
516		*
517		* @return LanguageService
518		*/
519		protected function getLanguageService(): LanguageService
520		{
521		return $GLOBALS['LANG'];
522		}
523
524		/**
525		* Returns an array with possible order directions
526		*
527		* @return array
528		*/
529		public function getOrderDirections()
530		{
531		return [
532		'asc' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.sortOrder.asc'),
533		'desc' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.sortOrder.desc')
534		];
535		}
536
537		/**
538		* Returns an array with possible orderBy fields
539		*
540		* @return array
541		*/
542		public function getOrderByFields()
543		{
544		return [
545		'title' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.orderBy.title'),
546		'startdate' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.orderBy.startdate'),
547		'enddate' => $this->getLanguageService()->sL(self::LANG_FILE . 'administration.orderBy.enddate')
548		];
549		}
550		}
551

derhansen / sf_event_mgt

Push — master ( 582c54...9e2bdc )

AdministrationController B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

26 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like