DataHandlerHooks::processDatamap_postProcessFieldArray() - Code Metrics - Inspection of "[TASK] Implement replacement for TCA "setToDefault..." - derhansen/sf_event_mgt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — typo3-10-compatibility ( 78ae4f...1a592b )

by Torben

created 2020-04-18 12:09 UTC

processDatamap_postProcessFieldArray() C

↳ Parent: DataHandlerHooks

Complexity

Conditions	10
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	69
rs	6.8096
c	0
b	0
f	0
cc	10
nc	8
nop	5

How to fix Long Method Complexity

<?php
namespace DERHANSEN\SfEventMgt\Hooks;

/*
 * 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\Service\EventCacheService;
use TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Hooks for DataHandler
 *
 * @author Torben Hansen <[email protected]>
 */
class DataHandlerHooks
{
    const EVENT_TABLE = 'tx_sfeventmgt_domain_model_event';

    /**
     * Flushes the cache if a event record was edited.
     * This happens on two levels: by UID and by PID.
     *
     * @param array $params
     */
    public function clearCachePostProc(array $params)
    {
        if (isset($params['table']) && $params['table'] === 'tx_sfeventmgt_domain_model_event') {
            $eventUid = $params['uid'] ?? 0;
            $pageUid = $params['uid_page'] ?? 0;
            if ($eventUid > 0 || $pageUid > 0) {
                $eventCacheService = GeneralUtility::makeInstance(EventCacheService::class);
                $eventCacheService->flushEventCache($eventUid, $pageUid);
            }
        }
    }

    /**
     * Checks if the fields defined in $checkFields are set in the data-array of pi_flexform.
     * If a field is present and contains an empty value, the field is unset.
     *
     * Structure of the checkFields array:
     *
     * array('sheet' => array('field1', 'field2'));
     *
     * @param string $status
     * @param string $table
     * @param string $id
     * @param array $fieldArray
     * @param \TYPO3\CMS\Core\DataHandling\DataHandler $reference
     *
     * @return void
     */
    public function processDatamap_postProcessFieldArray($status, $table, $id, &$fieldArray, &$reference)

    {
        if ($table === 'tt_content' && $status == 'update' && isset($fieldArray['pi_flexform'])) {
            $checkFields = [
                'notification' => [
                    'settings.notification.senderEmail',
                    'settings.notification.senderName',
                    'settings.notification.adminEmail',
                    'settings.notification.replyToEmail',
                    'settings.notification.registrationNew.userSubject',
                    'settings.notification.registrationWaitlistNew.userSubject',
                    'settings.notification.registrationNew.adminSubject',
                    'settings.notification.registrationWaitlistNew.adminSubject',
                    'settings.notification.registrationConfirmed.userSubject',
                    'settings.notification.registrationWaitlistConfirmed.userSubject',
                    'settings.notification.registrationConfirmed.adminSubject',
                    'settings.notification.registrationWaitlistConfirmed.adminSubject',
                    'settings.notification.registrationCancelled.userSubject',
                    'settings.notification.registrationCancelled.adminSubject',
                ],
                'sDEF' => [
                    'settings.displayMode',
                    'settings.orderField',
                    'settings.orderDirection',
                    'settings.topEventRestriction',
                    'settings.queryLimit',
                    'settings.category',
                    'settings.storagePage',
                    'settings.registration.requiredFields',
                    'settings.userRegistration.displayMode',
                    'settings.userRegistration.orderField',
                    'settings.userRegistration.orderDirection',
                    'settings.userRegistration.storagePage',
                    'settings.userRegistration.recursive'
                ],
                'additional' => [
                    'settings.detailPid',
                    'settings.listPid',
                    'settings.registrationPid',
                    'settings.paymentPid',
                    'settings.restrictForeignRecordsToStoragePage',
                    'settings.disableOverrideDemand'
                ],
                'template' => [
                    'settings.templateLayout'
                ]
            ];

            $flexformData = GeneralUtility::xml2array($fieldArray['pi_flexform']);
            foreach ($checkFields as $sheet => $fields) {
                foreach ($fields as $field) {
                    if (isset($flexformData['data'][$sheet]['lDEF'][$field]['vDEF']) &&
                        $flexformData['data'][$sheet]['lDEF'][$field]['vDEF'] === ''
                    ) {
                        unset($flexformData['data'][$sheet]['lDEF'][$field]);
                    }
                }

                // If remaining sheet does not contain fields, then remove the sheet
                if (isset($flexformData['data'][$sheet]['lDEF']) && $flexformData['data'][$sheet]['lDEF'] === []) {
                    unset($flexformData['data'][$sheet]);
                }
            }

            /** @var \TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools $flexFormTools */
            $flexFormTools = GeneralUtility::makeInstance(FlexFormTools::class);
            $fieldArray['pi_flexform'] = $flexFormTools->flexArray2Xml($flexformData, true);
        }
    }

    /**
     * Sets the TCA type of the fields 'registration' and 'registration_waitlist' to 'none' for copy and localize,
     * so field values will not be duplicated in the copy of the object.
     *
     * @param string $command
     * @param string $table
     * @param int $id
     * @param mixed $value
     * @param \TYPO3\CMS\Core\DataHandling\DataHandler $pObj
     * @param bool $pasteUpdate
     */
    public function processCmdmap_preProcess($command, $table, $id, $value, $pObj, $pasteUpdate)

    {
        if (in_array($command, ['copy', 'localize']) && $table === self::EVENT_TABLE) {
            $GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration']['config']['type'] = 'none';
            $GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration_waitlist']['config']['type'] = 'none';
        }
    }

    /**
     * Sets the TCA type of certain fields back to their original state after a copy or move command
     *
     * @param string $command
     * @param string $table
     * @param int $id
     * @param string $value
     * @param \TYPO3\CMS\Core\DataHandling\DataHandler $pObj
     * @param bool $pasteUpdate
     * @param array $pasteDatamap
     */
    public function processCmdmap_postProcess($command, $table, $id, $value, $pObj, $pasteUpdate, $pasteDatamap)

    {
        if (in_array($command, ['copy', 'localize']) && $table === self::EVENT_TABLE) {
            $GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration']['config']['type'] = 'inline';
            $GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration_waitlist']['config']['type'] = 'inline';
        }
    }
}


1			<?php
2			namespace DERHANSEN\SfEventMgt\Hooks;
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\Service\EventCacheService;
12			use TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools;
13			use TYPO3\CMS\Core\Utility\GeneralUtility;
14
15			/**
16			* Hooks for DataHandler
17			*
18			* @author Torben Hansen <[email protected]>
19			*/
20			class DataHandlerHooks
21			{
22			const EVENT_TABLE = 'tx_sfeventmgt_domain_model_event';
23
24			/**
25			* Flushes the cache if a event record was edited.
26			* This happens on two levels: by UID and by PID.
27			*
28			* @param array $params
29			*/
30			public function clearCachePostProc(array $params)
31			{
32			if (isset($params['table']) && $params['table'] === 'tx_sfeventmgt_domain_model_event') {
33			$eventUid = $params['uid'] ?? 0;
34			$pageUid = $params['uid_page'] ?? 0;
35			if ($eventUid > 0 \|\| $pageUid > 0) {
36			$eventCacheService = GeneralUtility::makeInstance(EventCacheService::class);
37			$eventCacheService->flushEventCache($eventUid, $pageUid);
38			}
39			}
40			}
41
42			/**
43			* Checks if the fields defined in $checkFields are set in the data-array of pi_flexform.
44			* If a field is present and contains an empty value, the field is unset.
45			*
46			* Structure of the checkFields array:
47			*
48			* array('sheet' => array('field1', 'field2'));
49			*
50			* @param string $status
51			* @param string $table
52			* @param string $id
53			* @param array $fieldArray
54			* @param \TYPO3\CMS\Core\DataHandling\DataHandler $reference
55			*
56			* @return void
57			*/
58			public function processDatamap_postProcessFieldArray($status, $table, $id, &$fieldArray, &$reference)
			0 ignored issues – show Unused Code introduced 2017-12-01 19:00 UTC by Report Bug Copy Issue Report The parameter `$id` 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... Unused Code introduced 2017-12-01 19:00 UTC by Report Bug Copy Issue Report The parameter `$reference` 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...
59			{
60			if ($table === 'tt_content' && $status == 'update' && isset($fieldArray['pi_flexform'])) {
61			$checkFields = [
62			'notification' => [
63			'settings.notification.senderEmail',
64			'settings.notification.senderName',
65			'settings.notification.adminEmail',
66			'settings.notification.replyToEmail',
67			'settings.notification.registrationNew.userSubject',
68			'settings.notification.registrationWaitlistNew.userSubject',
69			'settings.notification.registrationNew.adminSubject',
70			'settings.notification.registrationWaitlistNew.adminSubject',
71			'settings.notification.registrationConfirmed.userSubject',
72			'settings.notification.registrationWaitlistConfirmed.userSubject',
73			'settings.notification.registrationConfirmed.adminSubject',
74			'settings.notification.registrationWaitlistConfirmed.adminSubject',
75			'settings.notification.registrationCancelled.userSubject',
76			'settings.notification.registrationCancelled.adminSubject',
77			],
78			'sDEF' => [
79			'settings.displayMode',
80			'settings.orderField',
81			'settings.orderDirection',
82			'settings.topEventRestriction',
83			'settings.queryLimit',
84			'settings.category',
85			'settings.storagePage',
86			'settings.registration.requiredFields',
87			'settings.userRegistration.displayMode',
88			'settings.userRegistration.orderField',
89			'settings.userRegistration.orderDirection',
90			'settings.userRegistration.storagePage',
91			'settings.userRegistration.recursive'
92			],
93			'additional' => [
94			'settings.detailPid',
95			'settings.listPid',
96			'settings.registrationPid',
97			'settings.paymentPid',
98			'settings.restrictForeignRecordsToStoragePage',
99			'settings.disableOverrideDemand'
100			],
101			'template' => [
102			'settings.templateLayout'
103			]
104			];
105
106			$flexformData = GeneralUtility::xml2array($fieldArray['pi_flexform']);
107			foreach ($checkFields as $sheet => $fields) {
108			foreach ($fields as $field) {
109			if (isset($flexformData['data'][$sheet]['lDEF'][$field]['vDEF']) &&
110			$flexformData['data'][$sheet]['lDEF'][$field]['vDEF'] === ''
111			) {
112			unset($flexformData['data'][$sheet]['lDEF'][$field]);
113			}
114			}
115
116			// If remaining sheet does not contain fields, then remove the sheet
117			if (isset($flexformData['data'][$sheet]['lDEF']) && $flexformData['data'][$sheet]['lDEF'] === []) {
118			unset($flexformData['data'][$sheet]);
119			}
120			}
121
122			/** @var \TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools $flexFormTools */
123			$flexFormTools = GeneralUtility::makeInstance(FlexFormTools::class);
124			$fieldArray['pi_flexform'] = $flexFormTools->flexArray2Xml($flexformData, true);
125			}
126			}
127
128			/**
129			* Sets the TCA type of the fields 'registration' and 'registration_waitlist' to 'none' for copy and localize,
130			* so field values will not be duplicated in the copy of the object.
131			*
132			* @param string $command
133			* @param string $table
134			* @param int $id
135			* @param mixed $value
136			* @param \TYPO3\CMS\Core\DataHandling\DataHandler $pObj
137			* @param bool $pasteUpdate
138			*/
139			public function processCmdmap_preProcess($command, $table, $id, $value, $pObj, $pasteUpdate)
			0 ignored issues – show Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$id` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$value` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$pObj` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$pasteUpdate` 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...
140			{
141			if (in_array($command, ['copy', 'localize']) && $table === self::EVENT_TABLE) {
142			$GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration']['config']['type'] = 'none';
143			$GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration_waitlist']['config']['type'] = 'none';
144			}
145			}
146
147			/**
148			* Sets the TCA type of certain fields back to their original state after a copy or move command
149			*
150			* @param string $command
151			* @param string $table
152			* @param int $id
153			* @param string $value
154			* @param \TYPO3\CMS\Core\DataHandling\DataHandler $pObj
155			* @param bool $pasteUpdate
156			* @param array $pasteDatamap
157			*/
158			public function processCmdmap_postProcess($command, $table, $id, $value, $pObj, $pasteUpdate, $pasteDatamap)
			0 ignored issues – show Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$id` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$value` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$pObj` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$pasteUpdate` 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... Unused Code introduced 2020-04-18 12:12 UTC by Report Bug Copy Issue Report The parameter `$pasteDatamap` 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...
159			{
160			if (in_array($command, ['copy', 'localize']) && $table === self::EVENT_TABLE) {
161			$GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration']['config']['type'] = 'inline';
162			$GLOBALS['TCA'][self::EVENT_TABLE]['columns']['registration_waitlist']['config']['type'] = 'inline';
163			}
164			}
165			}
166

derhansen / sf_event_mgt

Push — typo3-10-compatibility ( 78ae4f...1a592b )

processDatamap_postProcessFieldArray() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like