AbstractModuleController::getFallbackSite() - Code Metrics - Inspection of "[TASK] Final scrutinizer issues" - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1105)

unknown

created 2017-03-01 09:30 UTC

AbstractModuleController::getFallbackSite() A

↳ Parent: AbstractModuleController

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	0
cts	3
cp	0
rs	9.4285
cc	1
eloc	4
nc	1
nop	0
crap	2

<?php
namespace ApacheSolrForTypo3\Solr\Backend\SolrModule;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2013-2015 Ingo Renner <[email protected]>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use ApacheSolrForTypo3\Solr\Site;
use ApacheSolrForTypo3\Solr\Utility\StringUtility;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
use TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException;
use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;

/**
 * Abstract Module
 *
 * @author Ingo Renner <[email protected]>
 */
abstract class AbstractModuleController extends ActionController implements AdministrationModuleInterface
{

    /**
     * Module name, used to identify a module f.e. in URL parameters.
     *
     * @var string
     */
    protected $moduleName = '';

    /**
     * Module title, shows up in the module menu.
     *
     * @var string
     */
    protected $moduleTitle = '';

    /**
     * @var \ApacheSolrForTypo3\Solr\Service\ModuleDataStorageService
     * @inject
     */
    protected $moduleDataStorageService;

    /**
     * Extension key
     *
     * @var string
     */
    protected $extensionKey = '';

    /**
     * @var \ApacheSolrForTypo3\Solr\ConnectionManager
     * @inject
     */
    protected $connectionManager = null;

    /**
     * The currently selected Site.
     *
     * @var Site
     */
    protected $site;

    /**
     * @var \ApacheSolrForTypo3\Solr\Utility\StringUtility
     */
    protected $stringUtility;

    /**
     * Gets the module name.
     *
     * @return string Module name
     */
    public function getName()
    {
        return $this->moduleName;
    }

    /**
     * Gets the module title.
     *
     * @return string Module title
     */
    public function getTitle()
    {
        return $this->moduleTitle;
    }

    /**
     * Sets the extension key
     *
     * @param string $extensionKey Extension key
     */
    public function setExtensionKey($extensionKey)
    {
        $this->extensionKey = $extensionKey;
    }

    /**
     * Gets the extension key
     *
     * @return string Extension key
     */
    public function getExtensionKey()
    {
        return $this->extensionKey;
    }

    /**
     * Method to pass a StringUtil object.
     * Use to overwrite injected object in unit test context.
     *
     * @param \ApacheSolrForTypo3\Solr\Utility\StringUtility $stringUtility
     */
    public function injectStringHelper(StringUtility $stringUtility)
    {
        $this->stringUtility = $stringUtility;
    }

    /**
     * Initializes resources commonly needed for several actions
     *
     * @return void
     */
    protected function initializeAction()
    {
        try {
            $site = $this->request->getArgument('site');

            if (is_numeric($site)) {
                $siteRootPageId = $this->request->getArgument('site');
                $this->site = Site::getSiteByPageId($siteRootPageId);
            } else {
                if ($site instanceof Site) {
                    $this->site = $site;
                } else {
                    $this->site = $this->getFallbackSite();
                }
            }
        } catch (NoSuchArgumentException $nsae) {
            $this->site = $this->getFallbackSite();
        }

        $this->request->setArgument('site', $this->site);

        $moduleData = $this->moduleDataStorageService->loadModuleData();
        $moduleData->setSite($this->site);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $this->moduleDataStorageService->persistModuleData($moduleData);
    }

    /**
     * Return Fallback site
     *
     * @return Site
     */
    protected function getFallbackSite()
    {
        $sites = Site::getAvailableSites();

        $site = array_shift($sites);
        return $site;
    }

    /**
     * Initializes the view before invoking an action method.
     *
     * Assigns the current module to the view
     *
     * @param \TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view The view to be initialized
     * @return void
     */
    protected function initializeView(ViewInterface $view)
    {
        $view->assign('module', $this);
    }

    /**
     * Checks if the request argument is present an returns it. If not it returns the default value.
     *
     * @param string $argumentKey
     * @param mixed $default
     * @return mixed
     */
    protected function getRequestArgumentOrDefaultValue($argumentKey, $default)
    {
        // no request -> return default
        if (!isset($this->request)) {
            return $default;
        }

        // argument not present -> return default value
        if (!$this->request->hasArgument($argumentKey)) {
            return $default;
        }

        return $this->request->getArgument($argumentKey);
    }

    /**
     * Forwards to the index action after resetting module and moduleAction
     * arguments to prevent execution of module actions.
     *
     * @return void
     */
    protected function forwardToIndex()
    {
        $requestArguments = $this->request->getArguments();

        foreach ($requestArguments as $argumentName => $_) {
            if (!in_array($argumentName,
                ['module', 'controller', 'site'])
            ) {
                unset($requestArguments[$argumentName]);
                unset($_GET['tx_solr_tools_solradministration'][$argumentName]);
                unset($this->arguments[$argumentName]);
            }
        }

        $this->request->setArguments($requestArguments);

        $this->forward('index');
    }

    /**
     * Finds the Solr connection to use for the currently selected core.
     *
     * @return \ApacheSolrForTypo3\Solr\SolrService Solr connection
     */
    protected function getSelectedCoreSolrConnection()
    {
        $currentCoreConnection = null;

        $solrConnections = $this->connectionManager->getConnectionsBySite($this->site);
        $currentCore = $this->moduleDataStorageService->loadModuleData()->getCore();

        foreach ($solrConnections as $solrConnection) {
            if ($solrConnection->getPath() == $currentCore) {
                $currentCoreConnection = $solrConnection;
                break;
            }
        }

        if (is_null($currentCoreConnection)) {
            // when switching sites $currentCore is empty and nothing matched
            // fall back to the connection's first core
            $currentCoreConnection = $solrConnections[0];
        }

        return $currentCoreConnection;
    }

    /**
     * Adds flash massages from another flash message queue, e.g. solr.queue.initializer
     *
     * @param string $identifier
     * @return void
     */
    protected function addFlashMessagesByQueueIdentifier($identifier)
    {
        $flashMessages = $this->controllerContext->getFlashMessageQueue($identifier)->getAllMessages();
        foreach ($flashMessages as $message) {
            $this->addFlashMessage($message->getMessage(), $message->getTitle(), $message->getSeverity());
        }
    }
}


1			<?php
2			namespace ApacheSolrForTypo3\Solr\Backend\SolrModule;
3
4			/***************************************************************
5			* Copyright notice
6			*
7			* (c) 2013-2015 Ingo Renner <[email protected]>
8			* All rights reserved
9			*
10			* This script is part of the TYPO3 project. The TYPO3 project is
11			* free software; you can redistribute it and/or modify
12			* it under the terms of the GNU General Public License as published by
13			* the Free Software Foundation; either version 2 of the License, or
14			* (at your option) any later version.
15			*
16			* The GNU General Public License can be found at
17			* http://www.gnu.org/copyleft/gpl.html.
18			*
19			* This script is distributed in the hope that it will be useful,
20			* but WITHOUT ANY WARRANTY; without even the implied warranty of
21			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22			* GNU General Public License for more details.
23			*
24			* This copyright notice MUST APPEAR in all copies of the script!
25			***************************************************************/
26
27			use ApacheSolrForTypo3\Solr\Site;
28			use ApacheSolrForTypo3\Solr\Utility\StringUtility;
29			use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
30			use TYPO3\CMS\Extbase\Mvc\Exception\NoSuchArgumentException;
31			use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
32
33			/**
34			* Abstract Module
35			*
36			* @author Ingo Renner <[email protected]>
37			*/
38			abstract class AbstractModuleController extends ActionController implements AdministrationModuleInterface
39			{
40
41			/**
42			* Module name, used to identify a module f.e. in URL parameters.
43			*
44			* @var string
45			*/
46			protected $moduleName = '';
47
48			/**
49			* Module title, shows up in the module menu.
50			*
51			* @var string
52			*/
53			protected $moduleTitle = '';
54
55			/**
56			* @var \ApacheSolrForTypo3\Solr\Service\ModuleDataStorageService
57			* @inject
58			*/
59			protected $moduleDataStorageService;
60
61			/**
62			* Extension key
63			*
64			* @var string
65			*/
66			protected $extensionKey = '';
67
68			/**
69			* @var \ApacheSolrForTypo3\Solr\ConnectionManager
70			* @inject
71			*/
72			protected $connectionManager = null;
73
74			/**
75			* The currently selected Site.
76			*
77			* @var Site
78			*/
79			protected $site;
80
81			/**
82			* @var \ApacheSolrForTypo3\Solr\Utility\StringUtility
83			*/
84			protected $stringUtility;
85
86			/**
87			* Gets the module name.
88			*
89			* @return string Module name
90			*/
91			public function getName()
92			{
93			return $this->moduleName;
94			}
95
96			/**
97			* Gets the module title.
98			*
99			* @return string Module title
100			*/
101			public function getTitle()
102			{
103			return $this->moduleTitle;
104			}
105
106			/**
107			* Sets the extension key
108			*
109			* @param string $extensionKey Extension key
110			*/
111			public function setExtensionKey($extensionKey)
112			{
113			$this->extensionKey = $extensionKey;
114			}
115
116			/**
117			* Gets the extension key
118			*
119			* @return string Extension key
120			*/
121			public function getExtensionKey()
122			{
123			return $this->extensionKey;
124			}
125
126			/**
127			* Method to pass a StringUtil object.
128			* Use to overwrite injected object in unit test context.
129			*
130			* @param \ApacheSolrForTypo3\Solr\Utility\StringUtility $stringUtility
131			*/
132			public function injectStringHelper(StringUtility $stringUtility)
133			{
134			$this->stringUtility = $stringUtility;
135			}
136
137			/**
138			* Initializes resources commonly needed for several actions
139			*
140			* @return void
141			*/
142			protected function initializeAction()
143			{
144			try {
145			$site = $this->request->getArgument('site');
146
147			if (is_numeric($site)) {
148			$siteRootPageId = $this->request->getArgument('site');
149			$this->site = Site::getSiteByPageId($siteRootPageId);
150			} else {
151			if ($site instanceof Site) {
152			$this->site = $site;
153			} else {
154			$this->site = $this->getFallbackSite();
155			}
156			}
157			} catch (NoSuchArgumentException $nsae) {
158			$this->site = $this->getFallbackSite();
159			}
160
161			$this->request->setArgument('site', $this->site);
162
163			$moduleData = $this->moduleDataStorageService->loadModuleData();
164			$moduleData->setSite($this->site);
			0 ignored issues – show Bug introduced 2016-08-17 21:45 UTC by Report Bug Copy Issue Report It seems like `$this->site` can be `null`; however, `setSite()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
165			$this->moduleDataStorageService->persistModuleData($moduleData);
166			}
167
168			/**
169			* Return Fallback site
170			*
171			* @return Site
172			*/
173			protected function getFallbackSite()
174			{
175			$sites = Site::getAvailableSites();
176
177			$site = array_shift($sites);
178			return $site;
179			}
180
181			/**
182			* Initializes the view before invoking an action method.
183			*
184			* Assigns the current module to the view
185			*
186			* @param \TYPO3\CMS\Extbase\Mvc\View\ViewInterface $view The view to be initialized
187			* @return void
188			*/
189			protected function initializeView(ViewInterface $view)
190			{
191			$view->assign('module', $this);
192			}
193
194			/**
195			* Checks if the request argument is present an returns it. If not it returns the default value.
196			*
197			* @param string $argumentKey
198			* @param mixed $default
199			* @return mixed
200			*/
201			protected function getRequestArgumentOrDefaultValue($argumentKey, $default)
202			{
203			// no request -> return default
204			if (!isset($this->request)) {
205			return $default;
206			}
207
208			// argument not present -> return default value
209			if (!$this->request->hasArgument($argumentKey)) {
210			return $default;
211			}
212
213			return $this->request->getArgument($argumentKey);
214			}
215
216			/**
217			* Forwards to the index action after resetting module and moduleAction
218			* arguments to prevent execution of module actions.
219			*
220			* @return void
221			*/
222			protected function forwardToIndex()
223			{
224			$requestArguments = $this->request->getArguments();
225
226			foreach ($requestArguments as $argumentName => $_) {
227			if (!in_array($argumentName,
228			['module', 'controller', 'site'])
229			) {
230			unset($requestArguments[$argumentName]);
231			unset($_GET['tx_solr_tools_solradministration'][$argumentName]);
232			unset($this->arguments[$argumentName]);
233			}
234			}
235
236			$this->request->setArguments($requestArguments);
237
238			$this->forward('index');
239			}
240
241			/**
242			* Finds the Solr connection to use for the currently selected core.
243			*
244			* @return \ApacheSolrForTypo3\Solr\SolrService Solr connection
245			*/
246			protected function getSelectedCoreSolrConnection()
247			{
248			$currentCoreConnection = null;
249
250			$solrConnections = $this->connectionManager->getConnectionsBySite($this->site);
251			$currentCore = $this->moduleDataStorageService->loadModuleData()->getCore();
252
253			foreach ($solrConnections as $solrConnection) {
254			if ($solrConnection->getPath() == $currentCore) {
255			$currentCoreConnection = $solrConnection;
256			break;
257			}
258			}
259
260			if (is_null($currentCoreConnection)) {
261			// when switching sites $currentCore is empty and nothing matched
262			// fall back to the connection's first core
263			$currentCoreConnection = $solrConnections[0];
264			}
265
266			return $currentCoreConnection;
267			}
268
269			/**
270			* Adds flash massages from another flash message queue, e.g. solr.queue.initializer
271			*
272			* @param string $identifier
273			* @return void
274			*/
275			protected function addFlashMessagesByQueueIdentifier($identifier)
276			{
277			$flashMessages = $this->controllerContext->getFlashMessageQueue($identifier)->getAllMessages();
278			foreach ($flashMessages as $message) {
279			$this->addFlashMessage($message->getMessage(), $message->getTitle(), $message->getSeverity());
280			}
281			}
282			}
283

TYPO3-Solr / ext-solr

Pull Request — master (#1105)

AbstractModuleController::getFallbackSite() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like