RegistrationValidator::validateDefaultFields() - Code Metrics - Inspection of "[RELEASE] Release of version 5.0.0" - derhansen/sf_event_mgt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 70dfe1...a97a1c )

by Torben

created 2020-04-23 05:31 UTC

RegistrationValidator::validateDefaultFields() B

↳ Parent: RegistrationValidator

Complexity

Conditions	6
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
dl	0
loc	29
ccs	0
cts	0
cp	0
rs	8.8337
c	0
b	0
f	0
cc	6
nc	8
nop	1
crap	42

<?php

/*
 * 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.
 */

namespace DERHANSEN\SfEventMgt\Validation\Validator;

use DERHANSEN\SfEventMgt\Domain\Model\Registration;
use DERHANSEN\SfEventMgt\Service\SpamCheckService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use TYPO3\CMS\Extbase\Validation\Error;
use TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator;
use TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator;
use TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator;
use TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator;

/**
 * RegistrationValidator
 *
 * @author Torben Hansen <[email protected]>
 */
class RegistrationValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
{
    /**
     * Configuration Manager
     *
     * @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManager
     */
    protected $configurationManager;

    /**
     * Object Manager
     *
     * @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
     */
    protected $objectManager;

    /**
     * DI for $configurationManager
     *
     * @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
     */
    public function injectConfigurationManager(
        \TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
    ) {
        $this->configurationManager = $configurationManager;
    }

    /**
     * DI for $objectManager
     *
     * @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
     */
    public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
    {
        $this->objectManager = $objectManager;
    }

    /**
     * Validates the given registration according to required fields set in plugin
     * settings. For boolean fields, the booleanValidator is used and it is assumed,
     * that boolean fields must have the value "TRUE" (for checkboxes)
     *
     * @param Registration $value Registration
     *
     * @return bool
     */
    protected function isValid($value)
    {
        $settings = $this->configurationManager->getConfiguration(
            ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS,
            'SfEventMgt',
            'Pievent'
        );

        $spamSettings = $settings['registration']['spamCheck'] ?? [];
        if ((bool)$spamSettings['enabled'] && $this->isSpamCheckFailed($value, $spamSettings)) {
            $message = $this->translateErrorMessage('registration.spamCheckFailed', 'SfEventMgt');
            $error = new Error($message, 1578855253965);
            $this->result->forProperty('spamCheck')->addError($error);

            return false;
        }

        $result = $this->validateDefaultFields($value);

        // If no required fields are set, then the registration is valid
        if ($settings['registration']['requiredFields'] === '' ||
            !isset($settings['registration']['requiredFields'])
        ) {
            return true;
        }

        $requiredFields = array_map('trim', explode(',', $settings['registration']['requiredFields']));

        foreach ($requiredFields as $requiredField) {
            if ($value->_hasProperty($requiredField)) {
                $validator = $this->getValidator(gettype($value->_getProperty($requiredField)), $requiredField);
                /** @var \TYPO3\CMS\Extbase\Error\Result $validationResult */
                $validationResult = $validator->validate($value->_getProperty($requiredField));
                if ($validationResult->hasErrors()) {
                    $result = false;
                    foreach ($validationResult->getErrors() as $error) {
                        $this->result->forProperty($requiredField)->addError($error);
                    }
                }
            }
        }

        return $result;
    }

    /**
     * Validates the default fields of a registration, that must be filled out. Since domain object validation
     * did not work as expected with registration fields (domain object validation results completely ignored)
     * this own validation is done
     *
     * Checks:
     * - firstname: NotEmpty
     * - lastname: NotEmpty
     * - email: NotEmpty, EmailAddress
     *
     * @param Registration $value
     * @return bool
     */
    protected function validateDefaultFields(Registration $value): bool
    {
        $result = true;

        $defaultFields = ['firstname', 'lastname', 'email'];
        foreach ($defaultFields as $defaultField) {
            $validator = GeneralUtility::makeInstance(NotEmptyValidator::class);
            /** @var \TYPO3\CMS\Extbase\Error\Result $validationResult */
            $validationResult = $validator->validate($value->_getProperty($defaultField));
            if ($validationResult->hasErrors()) {
                $result = false;
                foreach ($validationResult->getErrors() as $error) {
                    $this->result->forProperty($defaultField)->addError($error);
                }
            }
        }

        $validator = GeneralUtility::makeInstance(EmailAddressValidator::class);
        /** @var \TYPO3\CMS\Extbase\Error\Result $validationResult */
        $validationResult = $validator->validate($value->_getProperty('email'));
        if ($validationResult->hasErrors()) {
            $result = false;
            foreach ($validationResult->getErrors() as $error) {
                $this->result->forProperty('email')->addError($error);
            }
        }

        return $result;
    }

    /**
     * Processes the spam check and returns, if it failed or not
     *
     * @param Registration $registration
     * @param array $settings
     * @throws \DERHANSEN\SfEventMgt\SpamChecks\Exceptions\SpamCheckNotFoundException
     * @return bool
     */
    protected function isSpamCheckFailed(Registration $registration, array $settings): bool
    {
        $spamCheckService = new SpamCheckService(
            $registration,
            $settings,
            GeneralUtility::_GPmerged('tx_sfeventmgt_pievent')
        );

        return $spamCheckService->isSpamCheckFailed();
    }

    /**
     * Returns a validator object depending on the given type of the property
     *
     * @param string $type Type
     * @param string $field The field
     *
     * @return AbstractValidator
     */
    protected function getValidator($type, $field)
    {
        switch ($type) {
            case 'boolean':
                /** @var BooleanValidator $validator */
                $validator = $this->objectManager->get(

                    BooleanValidator::class,
                    ['is' => true]
                );
                break;
            default:
                if ($field == 'recaptcha') {
                    /** @var \DERHANSEN\SfEventMgt\Validation\Validator\RecaptchaValidator $validator */
                    $validator = $this->objectManager->get(RecaptchaValidator::class);

                } else {
                    /** @var \TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator $validator */
                    $validator = $this->objectManager->get(NotEmptyValidator::class);

                }
        }

        return $validator;
    }
}


1		<?php
2
3		/*
4		* This file is part of the Extension "sf_event_mgt" for TYPO3 CMS.
5		*
6		* For the full copyright and license information, please read the
7		* LICENSE.txt file that was distributed with this source code.
8		*/
9
10		namespace DERHANSEN\SfEventMgt\Validation\Validator;
11
12		use DERHANSEN\SfEventMgt\Domain\Model\Registration;
13		use DERHANSEN\SfEventMgt\Service\SpamCheckService;
14		use TYPO3\CMS\Core\Utility\GeneralUtility;
15		use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
16		use TYPO3\CMS\Extbase\Validation\Error;
17		use TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator;
18		use TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator;
19		use TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator;
20		use TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator;
21
22		/**
23		* RegistrationValidator
24		*
25		* @author Torben Hansen <[email protected]>
26		*/
27		class RegistrationValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
28		{
29		/**
30		* Configuration Manager
31		*
32		* @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManager
33		*/
34		protected $configurationManager;
35
36		/**
37		* Object Manager
38		*
39		* @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
40		*/
41		protected $objectManager;
42
43		/**
44		* DI for $configurationManager
45		*
46		* @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
47		*/
48		public function injectConfigurationManager(
49		\TYPO3\CMS\Extbase\Configuration\ConfigurationManager $configurationManager
50		) {
51		$this->configurationManager = $configurationManager;
52		}
53
54		/**
55	18	* DI for $objectManager
56		*
57	18	* @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
58	18	*/
59	18	public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
60		{
61	18	$this->objectManager = $objectManager;
62		}
63
64	18	/**
65	16	* Validates the given registration according to required fields set in plugin
66	18	* settings. For boolean fields, the booleanValidator is used and it is assumed,
67	4	* that boolean fields must have the value "TRUE" (for checkboxes)
68		*
69		* @param Registration $value Registration
70	14	*
71	14	* @return bool
72		*/
73	14	protected function isValid($value)
74	14	{
75	12	$settings = $this->configurationManager->getConfiguration(
76		ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS,
77	12	'SfEventMgt',
78	12	'Pievent'
79	4	);
80	4
81	4	$spamSettings = $settings['registration']['spamCheck'] ?? [];
82	4	if ((bool)$spamSettings['enabled'] && $this->isSpamCheckFailed($value, $spamSettings)) {
83	4	$message = $this->translateErrorMessage('registration.spamCheckFailed', 'SfEventMgt');
84	12	$error = new Error($message, 1578855253965);
85	14	$this->result->forProperty('spamCheck')->addError($error);
86
87	14	return false;
88		}
89
90		$result = $this->validateDefaultFields($value);
91
92		// If no required fields are set, then the registration is valid
93		if ($settings['registration']['requiredFields'] === '' \|\|
94		!isset($settings['registration']['requiredFields'])
95		) {
96		return true;
97		}
98	4
99		$requiredFields = array_map('trim', explode(',', $settings['registration']['requiredFields']));
100
101	4	foreach ($requiredFields as $requiredField) {
102		if ($value->_hasProperty($requiredField)) {
103	2	$validator = $this->getValidator(gettype($value->_getProperty($requiredField)), $requiredField);
104	2	/** @var \TYPO3\CMS\Extbase\Error\Result $validationResult */
105	2	$validationResult = $validator->validate($value->_getProperty($requiredField));
106	2	if ($validationResult->hasErrors()) {
107	2	$result = false;
108	2	foreach ($validationResult->getErrors() as $error) {
109	2	$this->result->forProperty($requiredField)->addError($error);
110		}
111		}
112		}
113		}
114	2
115		return $result;
116	2	}
117	4
118		/**
119		* Validates the default fields of a registration, that must be filled out. Since domain object validation
120		* did not work as expected with registration fields (domain object validation results completely ignored)
121		* this own validation is done
122		*
123		* Checks:
124		* - firstname: NotEmpty
125		* - lastname: NotEmpty
126		* - email: NotEmpty, EmailAddress
127		*
128		* @param Registration $value
129		* @return bool
130		*/
131		protected function validateDefaultFields(Registration $value): bool
132		{
133		$result = true;
134
135		$defaultFields = ['firstname', 'lastname', 'email'];
136		foreach ($defaultFields as $defaultField) {
137		$validator = GeneralUtility::makeInstance(NotEmptyValidator::class);
138		/** @var \TYPO3\CMS\Extbase\Error\Result $validationResult */
139		$validationResult = $validator->validate($value->_getProperty($defaultField));
140		if ($validationResult->hasErrors()) {
141		$result = false;
142		foreach ($validationResult->getErrors() as $error) {
143		$this->result->forProperty($defaultField)->addError($error);
144		}
145		}
146		}
147
148		$validator = GeneralUtility::makeInstance(EmailAddressValidator::class);
149		/** @var \TYPO3\CMS\Extbase\Error\Result $validationResult */
150		$validationResult = $validator->validate($value->_getProperty('email'));
151		if ($validationResult->hasErrors()) {
152		$result = false;
153		foreach ($validationResult->getErrors() as $error) {
154		$this->result->forProperty('email')->addError($error);
155		}
156		}
157
158		return $result;
159		}
160
161		/**
162		* Processes the spam check and returns, if it failed or not
163		*
164		* @param Registration $registration
165		* @param array $settings
166		* @throws \DERHANSEN\SfEventMgt\SpamChecks\Exceptions\SpamCheckNotFoundException
167		* @return bool
168		*/
169		protected function isSpamCheckFailed(Registration $registration, array $settings): bool
170		{
171		$spamCheckService = new SpamCheckService(
172		$registration,
173		$settings,
174		GeneralUtility::_GPmerged('tx_sfeventmgt_pievent')
175		);
176
177		return $spamCheckService->isSpamCheckFailed();
178		}
179
180		/**
181		* Returns a validator object depending on the given type of the property
182		*
183		* @param string $type Type
184		* @param string $field The field
185		*
186		* @return AbstractValidator
187		*/
188		protected function getValidator($type, $field)
189		{
190		switch ($type) {
191		case 'boolean':
192		/** @var BooleanValidator $validator */
193		$validator = $this->objectManager->get(
		0 ignored issues – show Deprecated Code introduced 2020-04-22 17:44 UTC by Report Bug Copy Issue Report The method `TYPO3\CMS\Extbase\Object...ManagerInterface::get()` has been deprecated with message: since TYPO3 10.4, will be removed in version 12.0 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...
194		BooleanValidator::class,
195		['is' => true]
196		);
197		break;
198		default:
199		if ($field == 'recaptcha') {
200		/** @var \DERHANSEN\SfEventMgt\Validation\Validator\RecaptchaValidator $validator */
201		$validator = $this->objectManager->get(RecaptchaValidator::class);
		0 ignored issues – show Deprecated Code introduced 2020-04-22 17:44 UTC by Report Bug Copy Issue Report The method `TYPO3\CMS\Extbase\Object...ManagerInterface::get()` has been deprecated with message: since TYPO3 10.4, will be removed in version 12.0 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...
202		} else {
203		/** @var \TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator $validator */
204		$validator = $this->objectManager->get(NotEmptyValidator::class);
		0 ignored issues – show Deprecated Code introduced 2020-04-22 17:44 UTC by Report Bug Copy Issue Report The method `TYPO3\CMS\Extbase\Object...ManagerInterface::get()` has been deprecated with message: since TYPO3 10.4, will be removed in version 12.0 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...
205		}
206		}
207
208		return $validator;
209		}
210		}
211

derhansen / sf_event_mgt

Push — master ( 70dfe1...a97a1c )

RegistrationValidator::validateDefaultFields() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like