RoutesControllerFactory::createService() - Code Metrics - noiselabs/zf-debug-utils - Measure and Improve Code Quality continuously with Scrutinizer

RoutesControllerFactory::createService() A
last analyzed 2017-01-25 14:38 UTC

↳ Parent: RoutesControllerFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	1
crap	1

<?php
/**
 * ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
 *
 * @license http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright 2016 Vítor Brandão <[email protected]>
 */

namespace Noiselabs\ZfDebugModule\Factory\Controller\Console;

use Noiselabs\ZfDebugModule\Controller\Console\RoutesController;
use Noiselabs\ZfDebugModule\Factory\Util\Routing\RouteCollectionFactory;
use Noiselabs\ZfDebugModule\Factory\Util\Routing\RouteMatcherFactory;
use Noiselabs\ZfDebugModule\Util\Routing\RouteCollection;
use Noiselabs\ZfDebugModule\Util\Routing\RouteMatcher;
use Zend\Mvc\Controller\ControllerManager;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

/**
 * Console\RoutesControllerFactory creates instances of Console\RoutesController.
 */
class RoutesControllerFactory implements FactoryInterface
{
    const SERVICE_NAME = RoutesController::class;

    /**
     * @param ServiceLocatorInterface|ControllerManager $serviceLocator
     *
     * @return RoutesController
     */
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        /** @var ServiceLocatorInterface $mainServiceManager */
        $mainServiceManager = $serviceLocator->getServiceLocator();
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.
    }
}

        /** @var RouteCollection $routeCollection */
        $routeCollection = $mainServiceManager->get(RouteCollectionFactory::SERVICE_NAME);
        /** @var RouteMatcher $routeMatcher */
        $routeMatcher = $mainServiceManager->get(RouteMatcherFactory::SERVICE_NAME);
        $console = $mainServiceManager->get('Console');

        return new RoutesController($routeCollection, $routeMatcher, $console);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1		<?php
2		/**
3		* ZfDebugModule. WebUI and Console commands for debugging ZF2 apps.
4		*
5		* @license http://www.opensource.org/licenses/mit-license.html MIT License
6		* @copyright 2016 Vítor Brandão <[email protected]>
7		*/
8
9		namespace Noiselabs\ZfDebugModule\Factory\Controller\Console;
10
11		use Noiselabs\ZfDebugModule\Controller\Console\RoutesController;
12		use Noiselabs\ZfDebugModule\Factory\Util\Routing\RouteCollectionFactory;
13		use Noiselabs\ZfDebugModule\Factory\Util\Routing\RouteMatcherFactory;
14		use Noiselabs\ZfDebugModule\Util\Routing\RouteCollection;
15		use Noiselabs\ZfDebugModule\Util\Routing\RouteMatcher;
16		use Zend\Mvc\Controller\ControllerManager;
17		use Zend\ServiceManager\FactoryInterface;
18		use Zend\ServiceManager\ServiceLocatorInterface;
19
20		/**
21		* Console\RoutesControllerFactory creates instances of Console\RoutesController.
22		*/
23		class RoutesControllerFactory implements FactoryInterface
24		{
25		const SERVICE_NAME = RoutesController::class;
26
27		/**
28		* @param ServiceLocatorInterface\|ControllerManager $serviceLocator
29		*
30		* @return RoutesController
31		*/
32	5	public function createService(ServiceLocatorInterface $serviceLocator)
33		{
34		/** @var ServiceLocatorInterface $mainServiceManager */
35	5	$mainServiceManager = $serviceLocator->getServiceLocator();
		0 ignored issues – show Bug introduced 2017-01-25 14:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\ServiceManager\ServiceLocatorInterface` as the method `getServiceLocator()` does only exist in the following implementations of said interface: `Zend\Config\ReaderPluginManager`, `Zend\Config\WriterPluginManager`, `Zend\Filter\FilterPluginManager`, `Zend\Form\FormElementMan...lementManagerV2Polyfill`, `Zend\Form\FormElementMan...lementManagerV3Polyfill`, `Zend\Hydrator\HydratorPluginManager`, `Zend\I18n\Translator\LoaderPluginManager`, `Zend\InputFilter\InputFilterPluginManager`, `Zend\Log\FilterPluginManager`, `Zend\Log\FormatterPluginManager`, `Zend\Log\ProcessorPluginManager`, `Zend\Log\WriterPluginManager`, `Zend\Log\Writer\FilterPluginManager`, `Zend\Log\Writer\FormatterPluginManager`, `Zend\Mvc\Controller\ControllerManager`, `Zend\Mvc\Controller\PluginManager`, `Zend\Mvc\Router\RoutePluginManager`, `Zend\Serializer\AdapterPluginManager`, `Zend\ServiceManager\AbstractPluginManager`, `Zend\Validator\ValidatorPluginManager`, `Zend\View\HelperPluginManager`, `Zend\View\Helper\Navigation\PluginManager`. 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...
36
37		/** @var RouteCollection $routeCollection */
38	5	$routeCollection = $mainServiceManager->get(RouteCollectionFactory::SERVICE_NAME);
39		/** @var RouteMatcher $routeMatcher */
40	5	$routeMatcher = $mainServiceManager->get(RouteMatcherFactory::SERVICE_NAME);
41	5	$console = $mainServiceManager->get('Console');
42
43	5	return new RoutesController($routeCollection, $routeMatcher, $console);
		0 ignored issues – show Documentation introduced 2016-07-22 17:32 UTC by Report Bug Copy Issue Report `$console` is of type `object\|array`, but the function expects a `object<Zend\Console\Adapter\AdapterInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
44		}
45		}
46

noiselabs / zf-debug-utils

RoutesControllerFactory::createService() A last analyzed 2017-01-25 14:38 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

RoutesControllerFactory::createService() A
last analyzed 2017-01-25 14:38 UTC