UserControllerFactory - Code Metrics - Inspection of "Merge pull request #637 from Eye4web/hotfix/servic..." - ZF-Commons/ZfcUser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 1.x ( fd103f...647e2f )

by Daniel

created 2016-05-05 19:22 UTC

UserControllerFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
wmc	1
c	3
b	2
f	0
lcom	1
cbo	1
dl	0
loc	31
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
A	createService()	0	21	1

<?php
/**
 * Created by PhpStorm.
 * User: Clayton Daley
 * Date: 5/6/2015
 * Time: 6:50 PM
 */

namespace ZfcUser\Factory\Controller;

use Zend\Mvc\Controller\ControllerManager;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
use ZfcUser\Controller\RedirectCallback;
use ZfcUser\Controller\UserController;

class UserControllerFactory implements FactoryInterface
{

    /**
     * Create service
     *
     * @param ServiceLocatorInterface $controllerManager
     * @return mixed
     */
    public function createService(ServiceLocatorInterface $controllerManager)
    {
        /* @var ControllerManager $controllerManager*/
        $serviceManager = $controllerManager->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 RedirectCallback $redirectCallback */
        $redirectCallback = $serviceManager->get('zfcuser_redirect_callback');

        /* @var UserController $controller */
        $controller = new UserController($redirectCallback);
        $controller->setServiceLocator($serviceManager);

        $controller->setChangeEmailForm($this->serviceLocator->get('zfcuser_change_email_form'));
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $controller->setOptions($this->serviceLocator->get('zfcuser_module_options'));
        $controller->setChangePasswordForm($this->serviceLocator->get('zfcuser_change_password_form'));
        $controller->setLoginForm($this->serviceLocator->get('zfcuser_login_form'));
        $controller->setRegisterForm($this->serviceLocator->get('zfcuser_register_form'));
        $controller->setUserService($this->serviceLocator->get('zfcuser_user_service'));

        return $controller;
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: Clayton Daley
5			* Date: 5/6/2015
6			* Time: 6:50 PM
7			*/
8
9			namespace ZfcUser\Factory\Controller;
10
11			use Zend\Mvc\Controller\ControllerManager;
12			use Zend\ServiceManager\FactoryInterface;
13			use Zend\ServiceManager\ServiceLocatorInterface;
14			use ZfcUser\Controller\RedirectCallback;
15			use ZfcUser\Controller\UserController;
16
17			class UserControllerFactory implements FactoryInterface
18			{
19
20			/**
21			* Create service
22			*
23			* @param ServiceLocatorInterface $controllerManager
24			* @return mixed
25			*/
26			public function createService(ServiceLocatorInterface $controllerManager)
27			{
28			/* @var ControllerManager $controllerManager*/
29			$serviceManager = $controllerManager->getServiceLocator();
			0 ignored issues – show Bug introduced 2016-04-01 16:53 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...
30
31			/* @var RedirectCallback $redirectCallback */
32			$redirectCallback = $serviceManager->get('zfcuser_redirect_callback');
33
34			/* @var UserController $controller */
35			$controller = new UserController($redirectCallback);
36			$controller->setServiceLocator($serviceManager);
37
38			$controller->setChangeEmailForm($this->serviceLocator->get('zfcuser_change_email_form'));
			0 ignored issues – show Bug introduced 2016-05-05 19:25 UTC by Report Bug Copy Issue Report The property `serviceLocator` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
39			$controller->setOptions($this->serviceLocator->get('zfcuser_module_options'));
40			$controller->setChangePasswordForm($this->serviceLocator->get('zfcuser_change_password_form'));
41			$controller->setLoginForm($this->serviceLocator->get('zfcuser_login_form'));
42			$controller->setRegisterForm($this->serviceLocator->get('zfcuser_register_form'));
43			$controller->setUserService($this->serviceLocator->get('zfcuser_user_service'));
44
45			return $controller;
46			}
47			}
48

ZF-Commons / ZfcUser

Push — 1.x ( fd103f...647e2f )

UserControllerFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like