FieldViewHelper::getPaths() - Code Metrics - Inspection of "Merge remote-tracking branch 'composer/development..." - romm/formz - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — middleware-wip ( c7460e...ebb7ba )

by Romain

created 2017-05-16 09:48 UTC

FieldViewHelper::getPaths() B

↳ Parent: Project

Complexity

Conditions	4
Paths	6

Size

Total Lines	25
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	17
nc	6
nop	1

<?php
/*
 * 2017 Romain CANON <[email protected]>
 *
 * This file is part of the TYPO3 FormZ 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 Romm\Formz\ViewHelpers;

use Romm\Formz\Configuration\View\Layouts\Layout;
use Romm\Formz\Configuration\View\View;
use Romm\Formz\Exceptions\ContextNotFoundException;
use Romm\Formz\Exceptions\EntryNotFoundException;
use Romm\Formz\Exceptions\InvalidArgumentTypeException;
use Romm\Formz\Exceptions\InvalidArgumentValueException;
use Romm\Formz\Exceptions\PropertyNotAccessibleException;
use Romm\Formz\Service\StringService;
use Romm\Formz\Service\ViewHelper\FieldViewHelperService;
use Romm\Formz\Service\ViewHelper\FormViewHelperService;
use Romm\Formz\Service\ViewHelper\SlotViewHelperService;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\VersionNumberUtility;

/**
 * This view helper is used to automatize the rendering of a field layout. It
 * will use the TypoScript properties at the path `config.tx_formz.view.layout`.
 *
 * You need to indicate the name of the field which will be rendered, and the
 * name of the layout which should be used (it must be present in the TypoScript
 * configuration).
 *
 * Example of layout: `bootstrap.3-cols`. You may indicate only the group, then
 * the name of the layout will be set to `default` (if you use the layout group
 * `bootstrap`, the layout `default` will be used, only if it does exist of
 * course).
 */
class FieldViewHelper extends AbstractViewHelper
{
    /**
     * @var bool
     */
    protected $escapeOutput = false;

    /**
     * @var array
     */
    public static $reservedVariablesNames = ['layout', 'formName', 'fieldName', 'fieldId'];

    /**
     * @var FormViewHelperService
     */
    protected $formService;

    /**
     * @var FieldViewHelperService
     */
    protected $fieldService;

    /**
     * @var SlotViewHelperService
     */
    protected $slotService;

    /**
     * @var array
     */
    protected $originalArguments = [];

    /**
     * @inheritdoc
     */
    public function initializeArguments()
    {
        $this->registerArgument('name', 'string', 'Name of the field which should be rendered.', true);
        $this->registerArgument('layout', 'string', 'Path of the TypoScript layout which will be used.', true);
        $this->registerArgument('arguments', 'array', 'Arbitrary arguments which will be sent to the field template.', false, []);
    }

    /**
     * @inheritdoc
     */
    public function render()
    {
        /*
         * First, we check if this view helper is called from within the
         * `FormViewHelper`, because it would not make sense anywhere else.
         */
        if (false === $this->formService->formContextExists()) {
            throw ContextNotFoundException::fieldViewHelperFormContextNotFound();
        }

        /*
         * Then, we inject the wanted field in the `FieldService` so we can know
         * later which field we're working with.
         */
        $this->injectFieldInService($this->arguments['name']);

        /*
         * Calling this here will process every view helper beneath this one,
         * allowing options and slots to be used correctly in the field layout.
         */
        $this->renderChildren();

        /*
         * We need to store original arguments declared for the current view
         * context, because we may override them during the rendering of this
         * view helper.
         */
        $this->storeOriginalArguments();

        /*
         * We merge the arguments with the ones registered with the
         * `OptionViewHelper`.
         */
        $templateArguments = $this->arguments['arguments'] ?: [];
        ArrayUtility::mergeRecursiveWithOverrule($templateArguments, $this->fieldService->getFieldOptions());

        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();
        $currentView = $viewHelperVariableContainer->getView();

        $result = $this->renderLayoutView($templateArguments);

        /*
         * Resetting all services data.
         */
        $this->fieldService->resetState();
        $this->slotService->resetState();

        $viewHelperVariableContainer->setView($currentView);
        $this->restoreOriginalArguments($templateArguments);

        return $result;
    }

    /**
     * Will render the associated Fluid view for this field (configured with the
     * `layout` argument).
     *
     * @param array $templateArguments
     * @return string
     */
    protected function renderLayoutView(array $templateArguments)
    {
        $fieldName = $this->arguments['name'];
        $formObject = $this->formService->getFormObject();
        $formConfiguration = $formObject->getDefinition();
        $viewConfiguration = $formConfiguration->getRootConfiguration()->getView();
        $layout = $this->getLayout($viewConfiguration);

        $templateArguments['layout'] = $layout->getLayout();
        $templateArguments['formName'] = $formObject->getName();
        $templateArguments['fieldName'] = $fieldName;
        $templateArguments['fieldId'] = ($templateArguments['fieldId']) ?: StringService::get()->sanitizeString('formz-' . $formObject->getName() . '-' . $fieldName);

        $view = $this->fieldService->getView($layout);

        $layoutPaths = $this->getPaths('layout');

        $partialPaths = $this->getPaths('partial');


        if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '8.0.0', '<')) {
            $view->setRenderingContext($this->renderingContext);
        } else {
            $view->setControllerContext($this->controllerContext);

            $variableProvider = $this->getVariableProvider();

            foreach ($templateArguments as $key => $value) {
                if ($variableProvider->exists($key)) {
                    $variableProvider->remove($key);
                }

                $variableProvider->add($key, $value);
            }
        }

        $view->setLayoutRootPaths($layoutPaths);
        $view->setPartialRootPaths($partialPaths);
        $view->assignMultiple($templateArguments);

        return $view->render();
    }

    /**
     * Will check that the given field exists in the current form definition and
     * inject it in the `FieldService` as `currentField`.
     *
     * Throws an error if the field is not found or incorrect.
     *
     * @param string $fieldName
     * @throws InvalidArgumentTypeException
     * @throws PropertyNotAccessibleException
     */
    protected function injectFieldInService($fieldName)
    {
        $formObject = $this->formService->getFormObject();
        $formConfiguration = $formObject->getDefinition();

        if (false === is_string($fieldName)) {
            throw InvalidArgumentTypeException::fieldViewHelperInvalidTypeNameArgument();
        } elseif (false === $formConfiguration->hasField($fieldName)) {
            throw PropertyNotAccessibleException::fieldViewHelperFieldNotAccessibleInForm($formObject, $fieldName);
        }

        $this->fieldService->setCurrentField($formConfiguration->getField($fieldName));
    }

    /**
     * Returns the layout instance used by this field.
     *
     * @param View $viewConfiguration
     * @return Layout
     * @throws EntryNotFoundException
     * @throws InvalidArgumentTypeException
     * @throws InvalidArgumentValueException
     */
    protected function getLayout(View $viewConfiguration)
    {
        $layout = $this->arguments['layout'];

        if (false === is_string($layout)) {
            throw InvalidArgumentTypeException::invalidTypeNameArgumentFieldViewHelper($layout);
        }

        list($layoutName, $templateName) = GeneralUtility::trimExplode('.', $layout);

        if (empty($templateName)) {
            $templateName = 'default';
        }

        if (empty($layoutName)) {
            throw InvalidArgumentValueException::fieldViewHelperEmptyLayout();
        }

        if (false === $viewConfiguration->hasLayout($layoutName)) {
            throw EntryNotFoundException::fieldViewHelperLayoutNotFound($layout);
        }

        if (false === $viewConfiguration->getLayout($layoutName)->hasItem($templateName)) {
            throw EntryNotFoundException::fieldViewHelperLayoutItemNotFound($layout, $templateName);
        }

        return $viewConfiguration->getLayout($layoutName)->getItem($templateName);
    }

    /**
     * Stores some arguments which may already have been initialized, and could
     * be overridden in the local scope.
     */
    protected function storeOriginalArguments()
    {
        $this->originalArguments = [];
        $variableProvider = $this->getVariableProvider();

        foreach (self::$reservedVariablesNames as $key) {
            if ($variableProvider->exists($key)) {
                $this->originalArguments[$key] = $variableProvider->get($key);
            }
        }
    }

    /**
     * Will restore original arguments in the template variable container.
     *
     * @param array $templateArguments
     */
    protected function restoreOriginalArguments(array $templateArguments)
    {
        $variableProvider = $this->getVariableProvider();

        foreach ($variableProvider->getAllIdentifiers() as $identifier) {
            if (array_key_exists($identifier, $templateArguments)) {
                $variableProvider->remove($identifier);
            }
        }

        foreach ($this->originalArguments as $key => $value) {
            if ($variableProvider->exists($key)) {
                $variableProvider->remove($key);
            }

            $variableProvider->add($key, $value);
        }
    }

    /**
     * This function will determinate the layout/partial root paths that should
     * be given to the standalone view. This must be a merge between the paths
     * given in the TypoScript configuration and the paths of the current view.
     *
     * This way, the user can use the layouts/partials from both the form
     * rendering extension, as well as the ones used by the field layout.
     *
     * Please note that TYPO3 v8+ has this behaviour by default, meaning only
     * the TypoScript configuration paths are needed, however in TYPO3 v7.6- we
     * need to access the root paths, which is *not* granted by Fluid... We are
     * then forced to use reflection, please don't do this at home!
     *
     * @param string $type `partial` or `layout`
     * @return array
     *
     * @deprecated Must be removed when TYPO3 7.6 is not supported anymore!
     */
    protected function getPaths($type)
    {
        $viewConfiguration = $this->formService->getFormObject()->getDefinition()->getRootConfiguration()->getView();

        $paths = $type === 'partial'
            ? $viewConfiguration->getAbsolutePartialRootPaths()
            : $viewConfiguration->getAbsoluteLayoutRootPaths();

        if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '8.0.0', '>=')) {
            return $paths;
        } else {
            $currentView = $this->renderingContext->getViewHelperVariableContainer()->getView();
            $propertyName = $type === 'partial'
                ? 'getPartialRootPaths'
                : 'getLayoutRootPaths';

            $reflectionClass = new \ReflectionClass($currentView);
            $method = $reflectionClass->getMethod($propertyName);
            $method->setAccessible(true);

            $value = $method->invoke($currentView);

            return array_unique(array_merge($paths, $value));
        }
    }

    /**
     * @param FormViewHelperService $service
     */
    public function injectFormService(FormViewHelperService $service)
    {
        $this->formService = $service;
    }

    /**
     * @param FieldViewHelperService $service
     */
    public function injectFieldService(FieldViewHelperService $service)
    {
        $this->fieldService = $service;
    }

    /**
     * @param SlotViewHelperService $slotService
     */
    public function injectSlotService(SlotViewHelperService $slotService)
    {
        $this->slotService = $slotService;
    }
}


1			<?php
2			/*
3			* 2017 Romain CANON <[email protected]>
4			*
5			* This file is part of the TYPO3 FormZ project.
6			* It is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU General Public License, either
8			* version 3 of the License, or any later version.
9			*
10			* For the full copyright and license information, see:
11			* http://www.gnu.org/licenses/gpl-3.0.html
12			*/
13
14			namespace Romm\Formz\ViewHelpers;
15
16			use Romm\Formz\Configuration\View\Layouts\Layout;
17			use Romm\Formz\Configuration\View\View;
18			use Romm\Formz\Exceptions\ContextNotFoundException;
19			use Romm\Formz\Exceptions\EntryNotFoundException;
20			use Romm\Formz\Exceptions\InvalidArgumentTypeException;
21			use Romm\Formz\Exceptions\InvalidArgumentValueException;
22			use Romm\Formz\Exceptions\PropertyNotAccessibleException;
23			use Romm\Formz\Service\StringService;
24			use Romm\Formz\Service\ViewHelper\FieldViewHelperService;
25			use Romm\Formz\Service\ViewHelper\FormViewHelperService;
26			use Romm\Formz\Service\ViewHelper\SlotViewHelperService;
27			use TYPO3\CMS\Core\Utility\ArrayUtility;
28			use TYPO3\CMS\Core\Utility\GeneralUtility;
29			use TYPO3\CMS\Core\Utility\VersionNumberUtility;
30
31			/**
32			* This view helper is used to automatize the rendering of a field layout. It
33			* will use the TypoScript properties at the path `config.tx_formz.view.layout`.
34			*
35			* You need to indicate the name of the field which will be rendered, and the
36			* name of the layout which should be used (it must be present in the TypoScript
37			* configuration).
38			*
39			* Example of layout: `bootstrap.3-cols`. You may indicate only the group, then
40			* the name of the layout will be set to `default` (if you use the layout group
41			* `bootstrap`, the layout `default` will be used, only if it does exist of
42			* course).
43			*/
44			class FieldViewHelper extends AbstractViewHelper
45			{
46			/**
47			* @var bool
48			*/
49			protected $escapeOutput = false;
50
51			/**
52			* @var array
53			*/
54			public static $reservedVariablesNames = ['layout', 'formName', 'fieldName', 'fieldId'];
55
56			/**
57			* @var FormViewHelperService
58			*/
59			protected $formService;
60
61			/**
62			* @var FieldViewHelperService
63			*/
64			protected $fieldService;
65
66			/**
67			* @var SlotViewHelperService
68			*/
69			protected $slotService;
70
71			/**
72			* @var array
73			*/
74			protected $originalArguments = [];
75
76			/**
77			* @inheritdoc
78			*/
79			public function initializeArguments()
80			{
81			$this->registerArgument('name', 'string', 'Name of the field which should be rendered.', true);
82			$this->registerArgument('layout', 'string', 'Path of the TypoScript layout which will be used.', true);
83			$this->registerArgument('arguments', 'array', 'Arbitrary arguments which will be sent to the field template.', false, []);
84			}
85
86			/**
87			* @inheritdoc
88			*/
89			public function render()
90			{
91			/*
92			* First, we check if this view helper is called from within the
93			* `FormViewHelper`, because it would not make sense anywhere else.
94			*/
95			if (false === $this->formService->formContextExists()) {
96			throw ContextNotFoundException::fieldViewHelperFormContextNotFound();
97			}
98
99			/*
100			* Then, we inject the wanted field in the `FieldService` so we can know
101			* later which field we're working with.
102			*/
103			$this->injectFieldInService($this->arguments['name']);
104
105			/*
106			* Calling this here will process every view helper beneath this one,
107			* allowing options and slots to be used correctly in the field layout.
108			*/
109			$this->renderChildren();
110
111			/*
112			* We need to store original arguments declared for the current view
113			* context, because we may override them during the rendering of this
114			* view helper.
115			*/
116			$this->storeOriginalArguments();
117
118			/*
119			* We merge the arguments with the ones registered with the
120			* `OptionViewHelper`.
121			*/
122			$templateArguments = $this->arguments['arguments'] ?: [];
123			ArrayUtility::mergeRecursiveWithOverrule($templateArguments, $this->fieldService->getFieldOptions());
124
125			$viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();
126			$currentView = $viewHelperVariableContainer->getView();
127
128			$result = $this->renderLayoutView($templateArguments);
129
130			/*
131			* Resetting all services data.
132			*/
133			$this->fieldService->resetState();
134			$this->slotService->resetState();
135
136			$viewHelperVariableContainer->setView($currentView);
137			$this->restoreOriginalArguments($templateArguments);
138
139			return $result;
140			}
141
142			/**
143			* Will render the associated Fluid view for this field (configured with the
144			* `layout` argument).
145			*
146			* @param array $templateArguments
147			* @return string
148			*/
149			protected function renderLayoutView(array $templateArguments)
150			{
151			$fieldName = $this->arguments['name'];
152			$formObject = $this->formService->getFormObject();
153			$formConfiguration = $formObject->getDefinition();
154			$viewConfiguration = $formConfiguration->getRootConfiguration()->getView();
155			$layout = $this->getLayout($viewConfiguration);
156
157			$templateArguments['layout'] = $layout->getLayout();
158			$templateArguments['formName'] = $formObject->getName();
159			$templateArguments['fieldName'] = $fieldName;
160			$templateArguments['fieldId'] = ($templateArguments['fieldId']) ?: StringService::get()->sanitizeString('formz-' . $formObject->getName() . '-' . $fieldName);
161
162			$view = $this->fieldService->getView($layout);
163
164			$layoutPaths = $this->getPaths('layout');
			0 ignored issues – show Deprecated Code introduced 2017-05-16 09:28 UTC by Report Bug Copy Issue Report The method `Romm\Formz\ViewHelpers\FieldViewHelper::getPaths()` has been deprecated with message: Must be removed when TYPO3 7.6 is not supported anymore! 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...
165			$partialPaths = $this->getPaths('partial');
			0 ignored issues – show Deprecated Code introduced 2017-05-16 09:28 UTC by Report Bug Copy Issue Report The method `Romm\Formz\ViewHelpers\FieldViewHelper::getPaths()` has been deprecated with message: Must be removed when TYPO3 7.6 is not supported anymore! 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...
166
167			if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '8.0.0', '<')) {
168			$view->setRenderingContext($this->renderingContext);
169			} else {
170			$view->setControllerContext($this->controllerContext);
171
172			$variableProvider = $this->getVariableProvider();
173
174			foreach ($templateArguments as $key => $value) {
175			if ($variableProvider->exists($key)) {
176			$variableProvider->remove($key);
177			}
178
179			$variableProvider->add($key, $value);
180			}
181			}
182
183			$view->setLayoutRootPaths($layoutPaths);
184			$view->setPartialRootPaths($partialPaths);
185			$view->assignMultiple($templateArguments);
186
187			return $view->render();
188			}
189
190			/**
191			* Will check that the given field exists in the current form definition and
192			* inject it in the `FieldService` as `currentField`.
193			*
194			* Throws an error if the field is not found or incorrect.
195			*
196			* @param string $fieldName
197			* @throws InvalidArgumentTypeException
198			* @throws PropertyNotAccessibleException
199			*/
200			protected function injectFieldInService($fieldName)
201			{
202			$formObject = $this->formService->getFormObject();
203			$formConfiguration = $formObject->getDefinition();
204
205			if (false === is_string($fieldName)) {
206			throw InvalidArgumentTypeException::fieldViewHelperInvalidTypeNameArgument();
207			} elseif (false === $formConfiguration->hasField($fieldName)) {
208			throw PropertyNotAccessibleException::fieldViewHelperFieldNotAccessibleInForm($formObject, $fieldName);
209			}
210
211			$this->fieldService->setCurrentField($formConfiguration->getField($fieldName));
212			}
213
214			/**
215			* Returns the layout instance used by this field.
216			*
217			* @param View $viewConfiguration
218			* @return Layout
219			* @throws EntryNotFoundException
220			* @throws InvalidArgumentTypeException
221			* @throws InvalidArgumentValueException
222			*/
223			protected function getLayout(View $viewConfiguration)
224			{
225			$layout = $this->arguments['layout'];
226
227			if (false === is_string($layout)) {
228			throw InvalidArgumentTypeException::invalidTypeNameArgumentFieldViewHelper($layout);
229			}
230
231			list($layoutName, $templateName) = GeneralUtility::trimExplode('.', $layout);
232
233			if (empty($templateName)) {
234			$templateName = 'default';
235			}
236
237			if (empty($layoutName)) {
238			throw InvalidArgumentValueException::fieldViewHelperEmptyLayout();
239			}
240
241			if (false === $viewConfiguration->hasLayout($layoutName)) {
242			throw EntryNotFoundException::fieldViewHelperLayoutNotFound($layout);
243			}
244
245			if (false === $viewConfiguration->getLayout($layoutName)->hasItem($templateName)) {
246			throw EntryNotFoundException::fieldViewHelperLayoutItemNotFound($layout, $templateName);
247			}
248
249			return $viewConfiguration->getLayout($layoutName)->getItem($templateName);
250			}
251
252			/**
253			* Stores some arguments which may already have been initialized, and could
254			* be overridden in the local scope.
255			*/
256			protected function storeOriginalArguments()
257			{
258			$this->originalArguments = [];
259			$variableProvider = $this->getVariableProvider();
260
261			foreach (self::$reservedVariablesNames as $key) {
262			if ($variableProvider->exists($key)) {
263			$this->originalArguments[$key] = $variableProvider->get($key);
264			}
265			}
266			}
267
268			/**
269			* Will restore original arguments in the template variable container.
270			*
271			* @param array $templateArguments
272			*/
273			protected function restoreOriginalArguments(array $templateArguments)
274			{
275			$variableProvider = $this->getVariableProvider();
276
277			foreach ($variableProvider->getAllIdentifiers() as $identifier) {
278			if (array_key_exists($identifier, $templateArguments)) {
279			$variableProvider->remove($identifier);
280			}
281			}
282
283			foreach ($this->originalArguments as $key => $value) {
284			if ($variableProvider->exists($key)) {
285			$variableProvider->remove($key);
286			}
287
288			$variableProvider->add($key, $value);
289			}
290			}
291
292			/**
293			* This function will determinate the layout/partial root paths that should
294			* be given to the standalone view. This must be a merge between the paths
295			* given in the TypoScript configuration and the paths of the current view.
296			*
297			* This way, the user can use the layouts/partials from both the form
298			* rendering extension, as well as the ones used by the field layout.
299			*
300			* Please note that TYPO3 v8+ has this behaviour by default, meaning only
301			* the TypoScript configuration paths are needed, however in TYPO3 v7.6- we
302			* need to access the root paths, which is not granted by Fluid... We are
303			* then forced to use reflection, please don't do this at home!
304			*
305			* @param string $type `partial` or `layout`
306			* @return array
307			*
308			* @deprecated Must be removed when TYPO3 7.6 is not supported anymore!
309			*/
310			protected function getPaths($type)
311			{
312			$viewConfiguration = $this->formService->getFormObject()->getDefinition()->getRootConfiguration()->getView();
313
314			$paths = $type === 'partial'
315			? $viewConfiguration->getAbsolutePartialRootPaths()
316			: $viewConfiguration->getAbsoluteLayoutRootPaths();
317
318			if (version_compare(VersionNumberUtility::getCurrentTypo3Version(), '8.0.0', '>=')) {
319			return $paths;
320			} else {
321			$currentView = $this->renderingContext->getViewHelperVariableContainer()->getView();
322			$propertyName = $type === 'partial'
323			? 'getPartialRootPaths'
324			: 'getLayoutRootPaths';
325
326			$reflectionClass = new \ReflectionClass($currentView);
327			$method = $reflectionClass->getMethod($propertyName);
328			$method->setAccessible(true);
329
330			$value = $method->invoke($currentView);
331
332			return array_unique(array_merge($paths, $value));
333			}
334			}
335
336			/**
337			* @param FormViewHelperService $service
338			*/
339			public function injectFormService(FormViewHelperService $service)
340			{
341			$this->formService = $service;
342			}
343
344			/**
345			* @param FieldViewHelperService $service
346			*/
347			public function injectFieldService(FieldViewHelperService $service)
348			{
349			$this->fieldService = $service;
350			}
351
352			/**
353			* @param SlotViewHelperService $slotService
354			*/
355			public function injectSlotService(SlotViewHelperService $slotService)
356			{
357			$this->slotService = $slotService;
358			}
359			}
360

romm / formz

Push — middleware-wip ( c7460e...ebb7ba )

FieldViewHelper::getPaths() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like