PrefillMultiValueFieldViewHelper::initializeArguments() - Code Metrics - Inspection of "[TASK] Make EditRecord and NewRecord ViewHelper wo..." - derhansen/sf_event_mgt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( ef0625...f79737 )

by Torben

created 2019-01-17 07:12 UTC

initializeArguments() A

↳ Parent: PrefillMultiValueFieldViewHelper

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php
namespace DERHANSEN\SfEventMgt\ViewHelpers\Registration\Field;

/*
 * 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\Registration\Field;
use DERHANSEN\SfEventMgt\Domain\Model\Registration\FieldValue;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Property\PropertyMapper;
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;

/**
 * PrefillMultiValueField ViewHelper for registration fields
 *
 * @author Torben Hansen <[email protected]>
 */
class PrefillMultiValueFieldViewHelper extends AbstractViewHelper
{
    /**
     * @var \TYPO3\CMS\Extbase\Property\PropertyMapper
     */
    protected $propertyMapper = null;

    /**
     * @param PropertyMapper $propertyMapper
     */
    public function injectPropertyMapper(\TYPO3\CMS\Extbase\Property\PropertyMapper $propertyMapper)
    {
        $this->propertyMapper = $propertyMapper;
    }

    /**
     * Initialize arguments
     */
    public function initializeArguments()
    {
        parent::initializeArguments();
        $this->registerArgument('registrationField', 'object', 'RegistrationField', true);
        $this->registerArgument('currentValue', 'strong', 'Current value', true);
    }

    /**
     * Returns, if the given $currentValue is selected/checked for the given registration field
     * If no originalRequest exist (form is not submitted), true is returned if the given $currentValue
     * matches the default value of the field
     *
     * @return bool
     */
    public function render()
    {
        /** @var Field $registrationField */
        $registrationField = $this->arguments['registrationField'];
        $currentValue = $this->arguments['currentValue'];

        // If mapping errors occured for form, return value that has been submitted
        $originalRequest = $this->getRequest()->getOriginalRequest();
        if ($originalRequest) {
            return $this->getFieldValueFromArguments(
                $originalRequest->getArguments(),
                $registrationField->getUid(),
                $currentValue
            );
        }

        return $this->getFieldValueFromDefaultProperty($registrationField, $currentValue);
    }

    /**
     * Returns the submitted value for the given field uid
     *
     * @param array $submittedValues
     * @param int $fieldUid
     * @param string $currentValue
     * @return bool
     */
    protected function getFieldValueFromArguments($submittedValues, $fieldUid, $currentValue)
    {
        $result = false;
        foreach ($submittedValues['registration']['fieldValues'] as $fieldValueArray) {
            /** @var FieldValue $fieldValue */
            $fieldValue = $this->propertyMapper->convert($fieldValueArray, FieldValue::class);
            if ($fieldValue->getField()->getUid() === $fieldUid) {
                $result = $this->isGivenValueSelected($fieldValue, $currentValue);
            }
        }

        return $result;
    }

    /**
     * @param FieldValue $fieldValue
     * @param string $currentValue
     * @return bool
     */
    protected function isGivenValueSelected($fieldValue, $currentValue)
    {
        $fieldValue = $fieldValue->getValue();
        if (is_array($fieldValue)) {
            return in_array($currentValue, $fieldValue);
        }

        return $currentValue === $fieldValue;
    }

    /**
     * @param \DERHANSEN\SfEventMgt\Domain\Model\Registration\Field $registrationField
     * @param string $currentValue
     * @return bool
     */
    protected function getFieldValueFromDefaultProperty($registrationField, $currentValue)
    {
        $defaultValues = GeneralUtility::trimExplode(',', $registrationField->getDefaultValue());

        return in_array($currentValue, $defaultValues);
    }

    /**
     * Shortcut for retrieving the request from the controller context
     *
     * @return \TYPO3\CMS\Extbase\Mvc\Request
     */
    protected function getRequest()
    {
        return $this->renderingContext->getControllerContext()->getRequest();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1			<?php
2			namespace DERHANSEN\SfEventMgt\ViewHelpers\Registration\Field;
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\Registration\Field;
12			use DERHANSEN\SfEventMgt\Domain\Model\Registration\FieldValue;
13			use TYPO3\CMS\Core\Utility\GeneralUtility;
14			use TYPO3\CMS\Extbase\Property\PropertyMapper;
15			use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
16
17			/**
18			* PrefillMultiValueField ViewHelper for registration fields
19			*
20			* @author Torben Hansen <[email protected]>
21			*/
22			class PrefillMultiValueFieldViewHelper extends AbstractViewHelper
23			{
24			/**
25			* @var \TYPO3\CMS\Extbase\Property\PropertyMapper
26			*/
27			protected $propertyMapper = null;
28
29			/**
30			* @param PropertyMapper $propertyMapper
31			*/
32			public function injectPropertyMapper(\TYPO3\CMS\Extbase\Property\PropertyMapper $propertyMapper)
33			{
34			$this->propertyMapper = $propertyMapper;
35			}
36
37			/**
38			* Initialize arguments
39			*/
40			public function initializeArguments()
41			{
42			parent::initializeArguments();
43			$this->registerArgument('registrationField', 'object', 'RegistrationField', true);
44			$this->registerArgument('currentValue', 'strong', 'Current value', true);
45			}
46
47			/**
48			* Returns, if the given $currentValue is selected/checked for the given registration field
49			* If no originalRequest exist (form is not submitted), true is returned if the given $currentValue
50			* matches the default value of the field
51			*
52			* @return bool
53			*/
54			public function render()
55			{
56			/** @var Field $registrationField */
57			$registrationField = $this->arguments['registrationField'];
58			$currentValue = $this->arguments['currentValue'];
59
60			// If mapping errors occured for form, return value that has been submitted
61			$originalRequest = $this->getRequest()->getOriginalRequest();
62			if ($originalRequest) {
63			return $this->getFieldValueFromArguments(
64			$originalRequest->getArguments(),
65			$registrationField->getUid(),
66			$currentValue
67			);
68			}
69
70			return $this->getFieldValueFromDefaultProperty($registrationField, $currentValue);
71			}
72
73			/**
74			* Returns the submitted value for the given field uid
75			*
76			* @param array $submittedValues
77			* @param int $fieldUid
78			* @param string $currentValue
79			* @return bool
80			*/
81			protected function getFieldValueFromArguments($submittedValues, $fieldUid, $currentValue)
82			{
83			$result = false;
84			foreach ($submittedValues['registration']['fieldValues'] as $fieldValueArray) {
85			/** @var FieldValue $fieldValue */
86			$fieldValue = $this->propertyMapper->convert($fieldValueArray, FieldValue::class);
87			if ($fieldValue->getField()->getUid() === $fieldUid) {
88			$result = $this->isGivenValueSelected($fieldValue, $currentValue);
89			}
90			}
91
92			return $result;
93			}
94
95			/**
96			* @param FieldValue $fieldValue
97			* @param string $currentValue
98			* @return bool
99			*/
100			protected function isGivenValueSelected($fieldValue, $currentValue)
101			{
102			$fieldValue = $fieldValue->getValue();
103			if (is_array($fieldValue)) {
104			return in_array($currentValue, $fieldValue);
105			}
106
107			return $currentValue === $fieldValue;
108			}
109
110			/**
111			* @param \DERHANSEN\SfEventMgt\Domain\Model\Registration\Field $registrationField
112			* @param string $currentValue
113			* @return bool
114			*/
115			protected function getFieldValueFromDefaultProperty($registrationField, $currentValue)
116			{
117			$defaultValues = GeneralUtility::trimExplode(',', $registrationField->getDefaultValue());
118
119			return in_array($currentValue, $defaultValues);
120			}
121
122			/**
123			* Shortcut for retrieving the request from the controller context
124			*
125			* @return \TYPO3\CMS\Extbase\Mvc\Request
126			*/
127			protected function getRequest()
128			{
129			return $this->renderingContext->getControllerContext()->getRequest();
			0 ignored issues – show Bug introduced 2019-01-17 07:16 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `TYPO3Fluid\Fluid\Core\Re...nderingContextInterface` as the method `getControllerContext()` does only exist in the following implementations of said interface: `Nimut\TestingFramework\R...RenderingContextFixture`, `TYPO3\CMS\Fluid\Core\Rendering\RenderingContext`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
130			}
131			}
132

derhansen / sf_event_mgt

Push — development ( ef0625...f79737 )

initializeArguments() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like