IndexControllerFactory::createService() - Code Metrics - Inspection of "add ability to change auth layout" - t4web/Authentication - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a7921...d76339 )

by max

created 2016-04-15 14:22 UTC

IndexControllerFactory::createService() B

↳ Parent: IndexControllerFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	30
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	30
rs	8.8571
cc	2
eloc	15
nc	2
nop	1

<?php

namespace T4web\Authentication\Controller\User;

use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\Mvc\Controller\Plugin\Redirect;
use Zend\Mvc\Router\Http\RouteMatch;
use Zend\Mvc\Application;
use T4web\Authentication\Service\InteractiveAuth;

class IndexControllerFactory implements FactoryInterface
{
    /**
     * @param ServiceLocatorInterface $cm
     * @return IndexController
     */
    public function createService(ServiceLocatorInterface $cm)
    {
        $sl = $cm->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.
    }
}

        $plugins = $sl->get('ControllerPluginManager');

        /** @var Application $app */
        $app = $sl->get('Application');
        $event = $app->getMvcEvent();

        /** @var RouteMatch $routeMatch */
        $routeMatch = $event->getRouteMatch();

        if ($routeMatch->getParam('layout')) {
            $viewModel = $event->getViewModel();
            $viewModel->setTemplate($routeMatch->getParam('layout'));
        }

        /** @var Redirect $redirect */
        $redirect = $plugins->get('redirect');

        $controller = new IndexController(
            $sl->get(InteractiveAuth::class),
            $redirect
        );

        $redirect->setController($controller);

        return $controller;
    }
}


1			<?php
2
3			namespace T4web\Authentication\Controller\User;
4
5			use Zend\ServiceManager\FactoryInterface;
6			use Zend\ServiceManager\ServiceLocatorInterface;
7			use Zend\Mvc\Controller\Plugin\Redirect;
8			use Zend\Mvc\Router\Http\RouteMatch;
9			use Zend\Mvc\Application;
10			use T4web\Authentication\Service\InteractiveAuth;
11
12			class IndexControllerFactory implements FactoryInterface
13			{
14			/**
15			* @param ServiceLocatorInterface $cm
16			* @return IndexController
17			*/
18			public function createService(ServiceLocatorInterface $cm)
19			{
20			$sl = $cm->getServiceLocator();
			0 ignored issues – show Bug introduced 2016-03-11 08:19 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\Filter\FilterPluginManager`, `Zend\Form\FormElementManager`, `Zend\Hydrator\HydratorPluginManager`, `Zend\InputFilter\InputFilterPluginManager`, `Zend\Mvc\Controller\ControllerManager`, `Zend\Mvc\Controller\PluginManager`, `Zend\Mvc\Router\RoutePluginManager`, `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...
21
22			$plugins = $sl->get('ControllerPluginManager');
23
24			/** @var Application $app */
25			$app = $sl->get('Application');
26			$event = $app->getMvcEvent();
27
28			/** @var RouteMatch $routeMatch */
29			$routeMatch = $event->getRouteMatch();
30
31			if ($routeMatch->getParam('layout')) {
32			$viewModel = $event->getViewModel();
33			$viewModel->setTemplate($routeMatch->getParam('layout'));
34			}
35
36			/** @var Redirect $redirect */
37			$redirect = $plugins->get('redirect');
38
39			$controller = new IndexController(
40			$sl->get(InteractiveAuth::class),
41			$redirect
42			);
43
44			$redirect->setController($controller);
45
46			return $controller;
47			}
48			}
49

t4web / Authentication

Push — master ( 6a7921...d76339 )

IndexControllerFactory::createService() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like