AbstractWidgetViewHelper::initiateSubRequest() - Code Metrics - Inspection of "[TASK] Add compatibility for current TYPO3 9 maste..." - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8f9ec7...80523f )

by Timo

created 2017-12-11 14:57 UTC

AbstractWidgetViewHelper::initiateSubRequest() A

↳ Parent: AbstractWidgetViewHelper

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3.9148

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	8
cts	15
cp	0.5333
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	11
nc	3
nop	0
crap	3.9148

<?php
namespace ApacheSolrForTypo3\Solr\Widget;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use ApacheSolrForTypo3\Solr\Mvc\Controller\SolrControllerContext;
use ApacheSolrForTypo3\Solr\Widget\WidgetRequest as SolrFluidWidgetRequest;
use TYPO3\CMS\Extbase\Mvc\Web\Response;
use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
use TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode;
use TYPO3\CMS\Fluid\Core\ViewHelper\Facets\ChildNodeAccessInterface;
use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper as AbstractCoreWidgetViewHelper;
use TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder;
use TYPO3\CMS\Fluid\Core\Widget\Exception\MissingControllerException;
use TYPO3\CMS\Fluid\Core\Widget\WidgetRequest as CoreWidgetRequest;
use TYPO3\CMS\Fluid\Core\Widget\WidgetContext;


/**
 * Class AbstractWidgetViewHelper
 *
 * This is almost a exact copy of \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 * because we need to switch the request object to overrule the widget prefix for url params
 * todo: find cleaner way to let widget listen to tx_solr[] instead of tx_solr[@widget]
 *
 * @author Frans Saris <[email protected]>
 * @author Timo Hund <[email protected]>
 * @package ApacheSolrForTypo3\Solr\Widget
 */
abstract class AbstractWidgetViewHelper extends AbstractCoreWidgetViewHelper implements ChildNodeAccessInterface
{

    /**
     * The Controller associated to this widget.
     * This needs to be filled by the individual subclass by an @inject
     * annotation.
     *
     * @var AbstractWidgetController
     * @api
     */
    protected $controller;

    /**
     * If set to TRUE, it is an AJAX widget.
     *
     * @var boolean
     * @api
     */
    protected $ajaxWidget = false;

    /**
     * @var AjaxWidgetContextHolder
     */
    private $ajaxWidgetContextHolder;


    /**
     * @var ObjectManagerInterface
     */
    protected $objectManager;

    /**
     * @var \TYPO3\CMS\Extbase\Service\ExtensionService
     * @inject
     */
    protected $extensionService;

    /**
     * @var \TYPO3\CMS\Fluid\Core\Widget\WidgetContext
     */
    private $widgetContext;


    /**
     * @param AjaxWidgetContextHolder $ajaxWidgetContextHolder
     * @return void
     */
    public function injectAjaxWidgetContextHolder(AjaxWidgetContextHolder $ajaxWidgetContextHolder)
    {
        $this->ajaxWidgetContextHolder = $ajaxWidgetContextHolder;
    }

    /**
     * @param ObjectManagerInterface $objectManager
     * @return void
     */
    public function injectObjectManager(ObjectManagerInterface $objectManager)
    {
        $this->objectManager = $objectManager;
        $this->widgetContext = $this->objectManager->get(WidgetContext::class);
    }

    /**
     * Initialize the arguments of the ViewHelper, and call the render() method of the ViewHelper.
     *
     * @return string the rendered ViewHelper.
     */
    public function initializeArgumentsAndRender()
    {
        $this->validateArguments();
        $this->initialize();
        $this->initializeWidgetContext();
        return $this->callRenderMethod();
    }

    /**
     * @todo The fallback on $this->controllerContext is only needed for TYPO3 8 backwards compatibility and can be dropped when TYPO3 8 is not supported anymore
     * @return SolrControllerContext
     * @throws \InvalidArgumentException
     */
    protected function getControllerContext()
    {
        $controllerContext = null;
        if (!is_null($this->controllerContext)) {
            $controllerContext = $this->controllerContext;
        } elseif (method_exists($this->renderingContext, 'getControllerContext')) {
            $controllerContext = $this->renderingContext->getControllerContext();
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.
    }
}
        }

        if (!$controllerContext instanceof SolrControllerContext) {
            throw new \InvalidArgumentException('No valid SolrControllerContext found', 1512998673);
        }

        return $controllerContext;
    }

    /**
     * Initialize the Widget Context, before the Render method is called.
     *
     * @return void
     */
    private function initializeWidgetContext()

    {
        $this->widgetContext->setWidgetConfiguration($this->getWidgetConfiguration());
        $this->initializeWidgetIdentifier();
        $this->widgetContext->setControllerObjectName(get_class($this->controller));

        $extensionName = $this->getControllerContext()->getRequest()->getControllerExtensionName();
        $pluginName = $this->getControllerContext()->getRequest()->getPluginName();
        $this->widgetContext->setParentExtensionName($extensionName);
        $this->widgetContext->setParentPluginName($pluginName);
        $pluginNamespace = $this->extensionService->getPluginNamespace($extensionName, $pluginName);
        $this->widgetContext->setParentPluginNamespace($pluginNamespace);
        $this->widgetContext->setWidgetViewHelperClassName(get_class($this));

        if ($this->ajaxWidget === true) {
            $this->ajaxWidgetContextHolder->store($this->widgetContext);
        }
    }

    /**
     * Stores the syntax tree child nodes in the Widget Context, so they can be
     * rendered with <f:widget.renderChildren> lateron.
     *
     * @param array $childNodes The SyntaxTree Child nodes of this ViewHelper.
     * @return void
     */
    public function setChildNodes(array $childNodes)
    {
        $rootNode = $this->objectManager->get(RootNode::class);
        foreach ($childNodes as $childNode) {
            $rootNode->addChildNode($childNode);
        }
        $this->widgetContext->setViewHelperChildNodes($rootNode, $this->renderingContext);
    }

    /**
     * Generate the configuration for this widget. Override to adjust.
     *
     * @return array
     * @api
     */
    protected function getWidgetConfiguration()
    {
        return $this->arguments;
    }

    /**
     * Initiate a sub request to $this->controller. Make sure to fill $this->controller
     * via Dependency Injection.
     *
     * @return \TYPO3\CMS\Extbase\Mvc\ResponseInterface the response of this request.
     * @throws MissingControllerException
     */
    protected function initiateSubRequest()
    {
        if (!$this->controller instanceof AbstractWidgetController) {
            if (isset($this->controller)) {
                throw new MissingControllerException('initiateSubRequest() can not be called if there is no valid controller extending TYPO3\\CMS\\Fluid\\Core\\Widget\\AbstractWidgetController. Got "' . get_class($this->controller) . '" in class "' . get_class($this) . '".', 1289422564);
            }
            throw new MissingControllerException('initiateSubRequest() can not be called if there is no controller inside $this->controller. Make sure to add a corresponding injectController method to your WidgetViewHelper class "' . get_class($this) . '".', 1284401632);
        }
            /** @var $subRequest \ApacheSolrForTypo3\Solr\Widget\WidgetRequest */
        $subRequest = $this->objectManager->get(SolrFluidWidgetRequest::class);
        $subRequest->setWidgetContext($this->widgetContext);

        $this->passArgumentsToSubRequest($subRequest);
        $subResponse = $this->objectManager->get(Response::class);
        $this->controller->processRequest($subRequest, $subResponse);
        return $subResponse;
    }

    /**
     * Pass the arguments of the widget to the subrequest.
     *
     * @param CoreWidgetRequest $subRequest
     * @return void
     */
    private function passArgumentsToSubRequest(CoreWidgetRequest $subRequest)

    {
        $arguments = $this->getControllerContext()->getRequest()->getArguments();

        if (isset($arguments)) {
            if (isset($arguments['action'])) {
                $subRequest->setControllerActionName($arguments['action']);
                unset($arguments['action']);
            }
            $subRequest->setArguments($arguments);
        }
    }

    /**
     * The widget identifier is unique on the current page, and is used
     * in the URI as a namespace for the widget's arguments.
     *
     * @return string the widget identifier for this widget
     * @return void
     * @todo clean up, and make it somehow more routing compatible.
     */
    private function initializeWidgetIdentifier()

    {
        $this->widgetContext->setWidgetIdentifier('');
    }
}


1		<?php
2		namespace ApacheSolrForTypo3\Solr\Widget;
3
4		/*
5		* This file is part of the TYPO3 CMS project.
6		*
7		* It is free software; you can redistribute it and/or modify it under
8		* the terms of the GNU General Public License, either version 2
9		* of the License, or any later version.
10		*
11		* For the full copyright and license information, please read the
12		* LICENSE.txt file that was distributed with this source code.
13		*
14		* The TYPO3 project - inspiring people to share!
15		*/
16
17		use ApacheSolrForTypo3\Solr\Mvc\Controller\SolrControllerContext;
18		use ApacheSolrForTypo3\Solr\Widget\WidgetRequest as SolrFluidWidgetRequest;
19		use TYPO3\CMS\Extbase\Mvc\Web\Response;
20		use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
21		use TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\RootNode;
22		use TYPO3\CMS\Fluid\Core\ViewHelper\Facets\ChildNodeAccessInterface;
23		use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper as AbstractCoreWidgetViewHelper;
24		use TYPO3\CMS\Fluid\Core\Widget\AjaxWidgetContextHolder;
25		use TYPO3\CMS\Fluid\Core\Widget\Exception\MissingControllerException;
26		use TYPO3\CMS\Fluid\Core\Widget\WidgetRequest as CoreWidgetRequest;
27		use TYPO3\CMS\Fluid\Core\Widget\WidgetContext;
28
29
30		/**
31		* Class AbstractWidgetViewHelper
32		*
33		* This is almost a exact copy of \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
34		* because we need to switch the request object to overrule the widget prefix for url params
35		* todo: find cleaner way to let widget listen to tx_solr[] instead of tx_solr[@widget]
36		*
37		* @author Frans Saris <[email protected]>
38		* @author Timo Hund <[email protected]>
39		* @package ApacheSolrForTypo3\Solr\Widget
40		*/
41		abstract class AbstractWidgetViewHelper extends AbstractCoreWidgetViewHelper implements ChildNodeAccessInterface
42		{
43
44		/**
45		* The Controller associated to this widget.
46		* This needs to be filled by the individual subclass by an @inject
47		* annotation.
48		*
49		* @var AbstractWidgetController
50		* @api
51		*/
52		protected $controller;
53
54		/**
55		* If set to TRUE, it is an AJAX widget.
56		*
57		* @var boolean
58		* @api
59		*/
60		protected $ajaxWidget = false;
61
62		/**
63		* @var AjaxWidgetContextHolder
64		*/
65		private $ajaxWidgetContextHolder;
		0 ignored issues – show Comprehensibility introduced 2017-06-01 10:00 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
66
67		/**
68		* @var ObjectManagerInterface
69		*/
70		protected $objectManager;
71
72		/**
73		* @var \TYPO3\CMS\Extbase\Service\ExtensionService
74		* @inject
75		*/
76		protected $extensionService;
77
78		/**
79		* @var \TYPO3\CMS\Fluid\Core\Widget\WidgetContext
80		*/
81		private $widgetContext;
		0 ignored issues – show Comprehensibility introduced 2017-09-18 07:48 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
82
83		/**
84		* @param AjaxWidgetContextHolder $ajaxWidgetContextHolder
85		* @return void
86		*/
87	31	public function injectAjaxWidgetContextHolder(AjaxWidgetContextHolder $ajaxWidgetContextHolder)
88		{
89	31	$this->ajaxWidgetContextHolder = $ajaxWidgetContextHolder;
90	31	}
91
92		/**
93		* @param ObjectManagerInterface $objectManager
94		* @return void
95		*/
96	31	public function injectObjectManager(ObjectManagerInterface $objectManager)
97		{
98	31	$this->objectManager = $objectManager;
99	31	$this->widgetContext = $this->objectManager->get(WidgetContext::class);
100	31	}
101
102		/**
103		* Initialize the arguments of the ViewHelper, and call the render() method of the ViewHelper.
104		*
105		* @return string the rendered ViewHelper.
106		*/
107	30	public function initializeArgumentsAndRender()
108		{
109	30	$this->validateArguments();
110	30	$this->initialize();
111	30	$this->initializeWidgetContext();
112	30	return $this->callRenderMethod();
113		}
114
115		/**
116		* @todo The fallback on $this->controllerContext is only needed for TYPO3 8 backwards compatibility and can be dropped when TYPO3 8 is not supported anymore
117		* @return SolrControllerContext
118		* @throws \InvalidArgumentException
119		*/
120	30	protected function getControllerContext()
121		{
122	30	$controllerContext = null;
123	30	if (!is_null($this->controllerContext)) {
124	30	$controllerContext = $this->controllerContext;
125		} elseif (method_exists($this->renderingContext, 'getControllerContext')) {
126		$controllerContext = $this->renderingContext->getControllerContext();
		0 ignored issues – show Bug introduced 2017-12-11 13:56 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`, `TYPO3\CMS\Fluid\Tests\Un...RenderingContextFixture`. 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...
127		}
128
129	30	if (!$controllerContext instanceof SolrControllerContext) {
130		throw new \InvalidArgumentException('No valid SolrControllerContext found', 1512998673);
131		}
132
133	30	return $controllerContext;
134		}
135
136		/**
137		* Initialize the Widget Context, before the Render method is called.
138		*
139		* @return void
140		*/
141	30	private function initializeWidgetContext()
		0 ignored issues – show Bug introduced 2017-07-31 07:38 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
142		{
143	30	$this->widgetContext->setWidgetConfiguration($this->getWidgetConfiguration());
144	30	$this->initializeWidgetIdentifier();
145	30	$this->widgetContext->setControllerObjectName(get_class($this->controller));
146
147	30	$extensionName = $this->getControllerContext()->getRequest()->getControllerExtensionName();
148	30	$pluginName = $this->getControllerContext()->getRequest()->getPluginName();
149	30	$this->widgetContext->setParentExtensionName($extensionName);
150	30	$this->widgetContext->setParentPluginName($pluginName);
151	30	$pluginNamespace = $this->extensionService->getPluginNamespace($extensionName, $pluginName);
152	30	$this->widgetContext->setParentPluginNamespace($pluginNamespace);
153	30	$this->widgetContext->setWidgetViewHelperClassName(get_class($this));
154
155	30	if ($this->ajaxWidget === true) {
156		$this->ajaxWidgetContextHolder->store($this->widgetContext);
157		}
158	30	}
159
160		/**
161		* Stores the syntax tree child nodes in the Widget Context, so they can be
162		* rendered with <f:widget.renderChildren> lateron.
163		*
164		* @param array $childNodes The SyntaxTree Child nodes of this ViewHelper.
165		* @return void
166		*/
167	31	public function setChildNodes(array $childNodes)
168		{
169	31	$rootNode = $this->objectManager->get(RootNode::class);
170	31	foreach ($childNodes as $childNode) {
171	31	$rootNode->addChildNode($childNode);
172		}
173	31	$this->widgetContext->setViewHelperChildNodes($rootNode, $this->renderingContext);
174	31	}
175
176		/**
177		* Generate the configuration for this widget. Override to adjust.
178		*
179		* @return array
180		* @api
181		*/
182	30	protected function getWidgetConfiguration()
183		{
184	30	return $this->arguments;
185		}
186
187		/**
188		* Initiate a sub request to $this->controller. Make sure to fill $this->controller
189		* via Dependency Injection.
190		*
191		* @return \TYPO3\CMS\Extbase\Mvc\ResponseInterface the response of this request.
192		* @throws MissingControllerException
193		*/
194	30	protected function initiateSubRequest()
195		{
196	30	if (!$this->controller instanceof AbstractWidgetController) {
197		if (isset($this->controller)) {
198		throw new MissingControllerException('initiateSubRequest() can not be called if there is no valid controller extending TYPO3\\CMS\\Fluid\\Core\\Widget\\AbstractWidgetController. Got "' . get_class($this->controller) . '" in class "' . get_class($this) . '".', 1289422564);
199		}
200		throw new MissingControllerException('initiateSubRequest() can not be called if there is no controller inside $this->controller. Make sure to add a corresponding injectController method to your WidgetViewHelper class "' . get_class($this) . '".', 1284401632);
201		}
202		/** @var $subRequest \ApacheSolrForTypo3\Solr\Widget\WidgetRequest */
203	30	$subRequest = $this->objectManager->get(SolrFluidWidgetRequest::class);
204	30	$subRequest->setWidgetContext($this->widgetContext);
205
206	30	$this->passArgumentsToSubRequest($subRequest);
207	30	$subResponse = $this->objectManager->get(Response::class);
208	30	$this->controller->processRequest($subRequest, $subResponse);
209	30	return $subResponse;
210		}
211
212		/**
213		* Pass the arguments of the widget to the subrequest.
214		*
215		* @param CoreWidgetRequest $subRequest
216		* @return void
217		*/
218	30	private function passArgumentsToSubRequest(CoreWidgetRequest $subRequest)
		0 ignored issues – show Bug introduced 2017-07-31 07:38 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
219		{
220	30	$arguments = $this->getControllerContext()->getRequest()->getArguments();
221
222	30	if (isset($arguments)) {
223	30	if (isset($arguments['action'])) {
224		$subRequest->setControllerActionName($arguments['action']);
225		unset($arguments['action']);
226		}
227	30	$subRequest->setArguments($arguments);
228		}
229	30	}
230
231		/**
232		* The widget identifier is unique on the current page, and is used
233		* in the URI as a namespace for the widget's arguments.
234		*
235		* @return string the widget identifier for this widget
236		* @return void
237		* @todo clean up, and make it somehow more routing compatible.
238		*/
239	30	private function initializeWidgetIdentifier()
		0 ignored issues – show Bug introduced 2017-07-31 07:38 UTC by Report Bug Copy Issue Report Consider using a different method name as you override a private method of the parent class. Overwriting private methods is generally fine as long as you also use private visibility. It might still be preferable for understandability to use a different method name. Loading history...
240		{
241	30	$this->widgetContext->setWidgetIdentifier('');
242	30	}
243		}
244

TYPO3-Solr / ext-solr

Push — master ( 8f9ec7...80523f )

AbstractWidgetViewHelper::initiateSubRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like