EntityTcaWriter::addCommonColumns() - Code Metrics - CuyZ/NotiZ - Measure and Improve Code Quality continuously with Scrutinizer

EntityTcaWriter::addCommonColumns() A
last analyzed 2024-02-23 10:19 UTC

↳ Parent: EntityTcaWriter

Complexity

Conditions	1
Paths	1

Size

Total Lines	86
Code Lines	54

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	54
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	86
rs	9.0036

How to fix Long Method

<?php
declare(strict_types=1);

/*
 * Copyright (C)
 * Nathan Boiron <[email protected]>
 * Romain Canon <[email protected]>
 *
 * This file is part of the TYPO3 NotiZ project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace CuyZ\Notiz\Core\Notification\TCA;

use CuyZ\Notiz\Backend\FormEngine\DataProvider\DefaultEventFromGet;
use CuyZ\Notiz\Core\Notification\Service\NotificationTcaService;
use CuyZ\Notiz\Core\Notification\TCA\Processor\EventConfigurationProcessor;
use CuyZ\Notiz\Service\Traits\SelfInstantiateTrait;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

abstract class EntityTcaWriter implements SingletonInterface
{
    use SelfInstantiateTrait;

    const NOTIFICATION_ENTITY = 'notificationEntity';

    const LLL = 'LLL:EXT:notiz/Resources/Private/Language/Notification/Entity/Entity.xlf';

    /**
     * Contains the name of the TCA table.
     *
     * @var string
     */
    protected $tableName;

    /**
     * @var NotificationTcaService
     */
    protected $service;

    /**
     * @var array
     */
    private $data = [];

    /**
     * Manual injection for the TCA service depending on the entity type.
     */
    public function __construct()
    {
        $this->service = GeneralUtility::makeInstance($this->getNotificationTcaServiceClass());
    }

    /**
     * This method must create the basic TCA configuration. It must fill at
     * least the `ctrl` and `columns` sections.
     *
     * Default TYPO3 columns are added automatically, so no need to add them.
     * Common notifications columns are also added automatically.
     *
     * @return array
     */
    abstract protected function buildTcaArray(): array;

    /**
     * This method builds a TCA array and returns it to be used in a
     * configuration file.
     *
     * @param string $tableName
     * @return array
     */
    final public function getTcaArray(string $tableName): array
    {
        $this->tableName = $tableName;

        // Each sub-class starts to fill the array.
        $this->data = $this->buildTcaArray();

        // Some columns are common for all notification types
        $this->addCommonColumns();

        // The default columns are always the same.
        $this->addDefaultTypo3Columns();

        return $this->data;
    }

    /**
     * This method returns the TCA service class for the current entity type.
     * You can override it to return a class extending `NotificationTcaService`.
     *
     * @return string
     */
    abstract protected function getNotificationTcaServiceClass(): string;

    /**
     * Returns the title of the entity, can be a LLL reference.
     *
     * @return string
     */
    abstract protected function getEntityTitle(): string;

    /**
     * This method returns the LLL string to use for the `channel` column.
     *
     * @return string
     */
    protected function getChannelLabel(): string
    {
        return self::LLL . ':field.channel';
    }

    /**
     * @return array
     */
    protected function getDefaultCtrl(): array
    {
        return [
            'title' => $this->getEntityTitle(),

            'label' => 'title',
            'descriptionColumn' => 'description',
            'tstamp' => 'tstamp',
            'crdate' => 'crdate',
            'cruser_id' => 'cruser_id',
            'dividers2tabs' => true,

            'rootLevel' => -1,
            'security' => [
                'ignoreWebMountRestriction' => true,
                'ignoreRootLevelRestriction' => true,
            ],

            'languageField' => 'sys_language_uid',
            'transOrigPointerField' => 'l10n_parent',
            'transOrigDiffSourceField' => 'l10n_diffsource',
            'delete' => 'deleted',
            'enablecolumns' => [
                'disabled' => 'hidden',
                'starttime' => 'starttime',
                'endtime' => 'endtime',
            ],
            'searchFields' => 'title,event',
            'iconfile' => $this->service->getNotificationIconPath(),

            self::NOTIFICATION_ENTITY => [
                'processor' => [
                    EventConfigurationProcessor::class,
                ],
                'dataProvider' => [
                    DefaultEventFromGet::ENABLE_DEFAULT_VALUE => true,
                ]
            ],
        ];
    }

    /**
     * Returns the default TYPO3 columns to include in the final TCA array.
     */
    private function addDefaultTypo3Columns()
    {
        $defaultColumns = [
            'sys_language_uid' => [
                'exclude' => 1,
                'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.language',
                'config' => [
                    'type' => 'select',
                    'renderType' => 'selectSingle',
                    'foreign_table' => 'sys_language',
                    'foreign_table_where' => 'ORDER BY sys_language.title',
                    'default' => 0,
                    'items' => [
                        ['LLL:EXT:lang/locallang_general.xlf:LGL.allLanguages', -1],
                        ['LLL:EXT:lang/locallang_general.xlf:LGL.default_value', 0],
                    ],
                ],
            ],
            'l10n_parent' => [
                'displayCond' => 'FIELD:sys_language_uid:>:0',
                'exclude' => 1,
                'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.l18n_parent',
                'l10n_display' => 'defaultAsReadonly',
                'config' => [
                    'type' => 'select',
                    'renderType' => 'selectSingle',
                    'foreign_table' => $this->tableName,
                    'foreign_table_where' => "AND {$this->tableName}.pid=###CURRENT_PID### AND {$this->tableName}.sys_language_uid IN (-1,0)",
                    'items' => [
                        ['', 0],
                    ],
                ],
            ],
            'l10n_diffsource' => [
                'config' => [
                    'type' => 'passthrough',
                ],
            ],
            't3ver_label' => [
                'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.versionLabel',
                'config' => [
                    'type' => 'input',
                    'size' => 30,
                    'max' => 255,
                ],
            ],
            'hidden' => [
                'exclude' => 1,
                'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.hidden',
                'config' => [
                    'type' => 'check',
                ],
            ],
            'starttime' => [
                'exclude' => 1,
                'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.starttime',
                'config' => [
                    'type' => 'input',
                    'renderType' => 'inputDateTime',
                    'eval' => 'datetime',
                    'default' => 0,
                    'behaviour' => [
                        'allowLanguageSynchronization' => true,
                    ]
                ]
            ],
            'endtime' => [
                'exclude' => 1,
                'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.endtime',
                'config' => [
                    'type' => 'input',
                    'renderType' => 'inputDateTime',
                    'eval' => 'datetime',
                    'default' => 0,
                    'behaviour' => [
                        'allowLanguageSynchronization' => true,
                    ]
                ]
            ],
        ];

        ArrayUtility::mergeRecursiveWithOverrule(
            $this->data['columns'],
            $defaultColumns
        );
    }

    /**
     * This method adds the common columns used by all Entity Notifications.
     */
    private function addCommonColumns()
    {
        $commonColumns = [
            'title' => [
                'exclude' => 1,
                'label' => self::LLL . ":field.title",
                'config' => [
                    'type' => 'input',
                    'size' => 30,
                    'eval' => 'trim,required',
                ],
            ],

            'description' => [
                'exclude' => 1,
                'label' => self::LLL . ":field.description",
                'config' => [
                    'type' => 'text',
                    'cols' => 40,
                    'rows' => 5,
                ],
            ],

            // Event configuration

            'event' => [
                'exclude' => 1,
                'label' => self::LLL . ":field.event",
                'l10n_mode' => 'exclude',
                'onChange' => 'reload',
                'config' => [
                    'type' => 'select',
                    'renderType' => 'selectSingle',
                    'size' => 8,
                    'itemsProcFunc' => $this->getNotificationTcaServiceClass() . '->getEventsList',
                    'eval' => 'required',
                ],
            ],

            /**
             * This FlexForm field is fully configured in:
             * @see \CuyZ\Notiz\Core\Notification\TCA\Processor\EventConfigurationProcessor
             */
            'event_configuration_flex' => [
                'label' => self::LLL . ':field.event_configuration',
                'config' => [
                    'type' => 'flex',
                    'default' => '',
                    'ds_pointerField' => 'event',
                    'behaviour' => [
                        'allowLanguageSynchronization' => true,
                    ],
                ],
            ],

            // Channel configuration

            'channel' => [
                'exclude' => 1,
                'label' => $this->getChannelLabel(),
                'l10n_mode' => 'exclude',
                'l10n_display' => 'defaultAsReadonly',
                'config' => [
                    'type' => 'select',
                    'renderType' => 'selectSingle',
                    'itemsProcFunc' => $this->getNotificationTcaServiceClass() . '->getChannelsList',
                    'eval' => 'required',
                ],
            ],

            // Markers configuration

            'markers' => [
                'exclude' => 1,
                'label' => self::LLL . ":field.markers",
                'l10n_display' => 'defaultAsReadonly',
                'config' => [
                    'type' => 'user',
                    'userFunc' => $this->getNotificationTcaServiceClass() . '->getMarkersLabel',
                ],
            ],
        ];

        ArrayUtility::mergeRecursiveWithOverrule(
            $this->data['columns'],
            $commonColumns
        );
    }
}


1			<?php
2			declare(strict_types=1);
3
4			/*
5			* Copyright (C)
6			* Nathan Boiron <[email protected]>
7			* Romain Canon <[email protected]>
8			*
9			* This file is part of the TYPO3 NotiZ project.
10			* It is free software; you can redistribute it and/or modify it
11			* under the terms of the GNU General Public License, either
12			* version 3 of the License, or any later version.
13			*
14			* For the full copyright and license information, see:
15			* http://www.gnu.org/licenses/gpl-3.0.html
16			*/
17
18			namespace CuyZ\Notiz\Core\Notification\TCA;
19
20			use CuyZ\Notiz\Backend\FormEngine\DataProvider\DefaultEventFromGet;
21			use CuyZ\Notiz\Core\Notification\Service\NotificationTcaService;
22			use CuyZ\Notiz\Core\Notification\TCA\Processor\EventConfigurationProcessor;
23			use CuyZ\Notiz\Service\Traits\SelfInstantiateTrait;
24			use TYPO3\CMS\Core\SingletonInterface;
25			use TYPO3\CMS\Core\Utility\ArrayUtility;
26			use TYPO3\CMS\Core\Utility\GeneralUtility;
27
28			abstract class EntityTcaWriter implements SingletonInterface
29			{
30			use SelfInstantiateTrait;
31
32			const NOTIFICATION_ENTITY = 'notificationEntity';
33
34			const LLL = 'LLL:EXT:notiz/Resources/Private/Language/Notification/Entity/Entity.xlf';
35
36			/**
37			* Contains the name of the TCA table.
38			*
39			* @var string
40			*/
41			protected $tableName;
42
43			/**
44			* @var NotificationTcaService
45			*/
46			protected $service;
47
48			/**
49			* @var array
50			*/
51			private $data = [];
52
53			/**
54			* Manual injection for the TCA service depending on the entity type.
55			*/
56			public function __construct()
57			{
58			$this->service = GeneralUtility::makeInstance($this->getNotificationTcaServiceClass());
59			}
60
61			/**
62			* This method must create the basic TCA configuration. It must fill at
63			* least the `ctrl` and `columns` sections.
64			*
65			* Default TYPO3 columns are added automatically, so no need to add them.
66			* Common notifications columns are also added automatically.
67			*
68			* @return array
69			*/
70			abstract protected function buildTcaArray(): array;
71
72			/**
73			* This method builds a TCA array and returns it to be used in a
74			* configuration file.
75			*
76			* @param string $tableName
77			* @return array
78			*/
79			final public function getTcaArray(string $tableName): array
80			{
81			$this->tableName = $tableName;
82
83			// Each sub-class starts to fill the array.
84			$this->data = $this->buildTcaArray();
85
86			// Some columns are common for all notification types
87			$this->addCommonColumns();
88
89			// The default columns are always the same.
90			$this->addDefaultTypo3Columns();
91
92			return $this->data;
93			}
94
95			/**
96			* This method returns the TCA service class for the current entity type.
97			* You can override it to return a class extending `NotificationTcaService`.
98			*
99			* @return string
100			*/
101			abstract protected function getNotificationTcaServiceClass(): string;
102
103			/**
104			* Returns the title of the entity, can be a LLL reference.
105			*
106			* @return string
107			*/
108			abstract protected function getEntityTitle(): string;
109
110			/**
111			* This method returns the LLL string to use for the `channel` column.
112			*
113			* @return string
114			*/
115			protected function getChannelLabel(): string
116			{
117			return self::LLL . ':field.channel';
118			}
119
120			/**
121			* @return array
122			*/
123			protected function getDefaultCtrl(): array
124			{
125			return [
126			'title' => $this->getEntityTitle(),
127
128			'label' => 'title',
129			'descriptionColumn' => 'description',
130			'tstamp' => 'tstamp',
131			'crdate' => 'crdate',
132			'cruser_id' => 'cruser_id',
133			'dividers2tabs' => true,
134
135			'rootLevel' => -1,
136			'security' => [
137			'ignoreWebMountRestriction' => true,
138			'ignoreRootLevelRestriction' => true,
139			],
140
141			'languageField' => 'sys_language_uid',
142			'transOrigPointerField' => 'l10n_parent',
143			'transOrigDiffSourceField' => 'l10n_diffsource',
144			'delete' => 'deleted',
145			'enablecolumns' => [
146			'disabled' => 'hidden',
147			'starttime' => 'starttime',
148			'endtime' => 'endtime',
149			],
150			'searchFields' => 'title,event',
151			'iconfile' => $this->service->getNotificationIconPath(),
152
153			self::NOTIFICATION_ENTITY => [
154			'processor' => [
155			EventConfigurationProcessor::class,
156			],
157			'dataProvider' => [
158			DefaultEventFromGet::ENABLE_DEFAULT_VALUE => true,
159			]
160			],
161			];
162			}
163
164			/**
165			* Returns the default TYPO3 columns to include in the final TCA array.
166			*/
167			private function addDefaultTypo3Columns()
168			{
169			$defaultColumns = [
170			'sys_language_uid' => [
171			'exclude' => 1,
172			'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.language',
173			'config' => [
174			'type' => 'select',
175			'renderType' => 'selectSingle',
176			'foreign_table' => 'sys_language',
177			'foreign_table_where' => 'ORDER BY sys_language.title',
178			'default' => 0,
179			'items' => [
180			['LLL:EXT:lang/locallang_general.xlf:LGL.allLanguages', -1],
181			['LLL:EXT:lang/locallang_general.xlf:LGL.default_value', 0],
182			],
183			],
184			],
185			'l10n_parent' => [
186			'displayCond' => 'FIELD:sys_language_uid:>:0',
187			'exclude' => 1,
188			'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.l18n_parent',
189			'l10n_display' => 'defaultAsReadonly',
190			'config' => [
191			'type' => 'select',
192			'renderType' => 'selectSingle',
193			'foreign_table' => $this->tableName,
194			'foreign_table_where' => "AND {$this->tableName}.pid=###CURRENT_PID### AND {$this->tableName}.sys_language_uid IN (-1,0)",
195			'items' => [
196			['', 0],
197			],
198			],
199			],
200			'l10n_diffsource' => [
201			'config' => [
202			'type' => 'passthrough',
203			],
204			],
205			't3ver_label' => [
206			'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.versionLabel',
207			'config' => [
208			'type' => 'input',
209			'size' => 30,
210			'max' => 255,
211			],
212			],
213			'hidden' => [
214			'exclude' => 1,
215			'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.hidden',
216			'config' => [
217			'type' => 'check',
218			],
219			],
220			'starttime' => [
221			'exclude' => 1,
222			'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.starttime',
223			'config' => [
224			'type' => 'input',
225			'renderType' => 'inputDateTime',
226			'eval' => 'datetime',
227			'default' => 0,
228			'behaviour' => [
229			'allowLanguageSynchronization' => true,
230			]
231			]
232			],
233			'endtime' => [
234			'exclude' => 1,
235			'label' => 'LLL:EXT:lang/locallang_general.xlf:LGL.endtime',
236			'config' => [
237			'type' => 'input',
238			'renderType' => 'inputDateTime',
239			'eval' => 'datetime',
240			'default' => 0,
241			'behaviour' => [
242			'allowLanguageSynchronization' => true,
243			]
244			]
245			],
246			];
247
248			ArrayUtility::mergeRecursiveWithOverrule(
249			$this->data['columns'],
250			$defaultColumns
251			);
252			}
253
254			/**
255			* This method adds the common columns used by all Entity Notifications.
256			*/
257			private function addCommonColumns()
258			{
259			$commonColumns = [
260			'title' => [
261			'exclude' => 1,
262			'label' => self::LLL . ":field.title",
263			'config' => [
264			'type' => 'input',
265			'size' => 30,
266			'eval' => 'trim,required',
267			],
268			],
269
270			'description' => [
271			'exclude' => 1,
272			'label' => self::LLL . ":field.description",
273			'config' => [
274			'type' => 'text',
275			'cols' => 40,
276			'rows' => 5,
277			],
278			],
279
280			// Event configuration
281
282			'event' => [
283			'exclude' => 1,
284			'label' => self::LLL . ":field.event",
285			'l10n_mode' => 'exclude',
286			'onChange' => 'reload',
287			'config' => [
288			'type' => 'select',
289			'renderType' => 'selectSingle',
290			'size' => 8,
291			'itemsProcFunc' => $this->getNotificationTcaServiceClass() . '->getEventsList',
292			'eval' => 'required',
293			],
294			],
295
296			/**
297			* This FlexForm field is fully configured in:
298			* @see \CuyZ\Notiz\Core\Notification\TCA\Processor\EventConfigurationProcessor
299			*/
300			'event_configuration_flex' => [
301			'label' => self::LLL . ':field.event_configuration',
302			'config' => [
303			'type' => 'flex',
304			'default' => '',
305			'ds_pointerField' => 'event',
306			'behaviour' => [
307			'allowLanguageSynchronization' => true,
308			],
309			],
310			],
311
312			// Channel configuration
313
314			'channel' => [
315			'exclude' => 1,
316			'label' => $this->getChannelLabel(),
317			'l10n_mode' => 'exclude',
318			'l10n_display' => 'defaultAsReadonly',
319			'config' => [
320			'type' => 'select',
321			'renderType' => 'selectSingle',
322			'itemsProcFunc' => $this->getNotificationTcaServiceClass() . '->getChannelsList',
323			'eval' => 'required',
324			],
325			],
326
327			// Markers configuration
328
329			'markers' => [
330			'exclude' => 1,
331			'label' => self::LLL . ":field.markers",
332			'l10n_display' => 'defaultAsReadonly',
333			'config' => [
334			'type' => 'user',
335			'userFunc' => $this->getNotificationTcaServiceClass() . '->getMarkersLabel',
336			],
337			],
338			];
339
340			ArrayUtility::mergeRecursiveWithOverrule(
341			$this->data['columns'],
342			$commonColumns
343			);
344			}
345			}
346

CuyZ / NotiZ

EntityTcaWriter::addCommonColumns() A last analyzed 2024-02-23 10:19 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

EntityTcaWriter::addCommonColumns() A
last analyzed 2024-02-23 10:19 UTC