IndexControllerFactory - Code Metrics - Inspection of "[Auth] moves Captcha options into own options file" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 828b3f...60c2a6 )

unknown

created 2016-01-03 16:57 UTC

IndexControllerFactory A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes	3
Bugs	0	Features	0

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

1 Method

Rating	Name	Duplication	Size	Complexity
B	createService()	0	32	2

<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013-2015 Cross Solution (http://cross-solution.de)
 * @author cbleek
 * @license   MIT
 */

namespace Auth\Factory\Controller;

use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\Log\LoggerInterface;
use Auth\Controller\IndexController;
use Auth\Form\Register;

class IndexControllerFactory implements FactoryInterface
{
    /**
     * Create controller
     *
     * @param ServiceLocatorInterface $controllerManager
     *
     * @return IndexController
     */
    public function createService(ServiceLocatorInterface $controllerManager)
    {
        /* @var ServiceLocatorInterface $serviceLocator */
        $serviceLocator = $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.
    }
}
        $auth = $serviceLocator->get('AuthenticationService');
        $loginForm = $serviceLocator->get('Auth\Form\Login');

        /* @var $logger LoggerInterface*/
        $logger = $serviceLocator->get('Core/Log');

        /* @var $options \Auth\Options\ModuleOptions */
        $options = $serviceLocator->get('Auth/Options');

        $forms[IndexController::LOGIN] = $loginForm;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        if ($options->getEnableRegistration()) {
            /* @var $registerForm Register */
            $registerForm = $serviceLocator->get('Auth\Form\Register');

            /* @var \Zend\ServiceManager\AbstractPluginManager $serviceLocator */
            /* @var \Zend\Mvc\MvcEvent $event */
            #$event = $controllerManager->getServiceLocator()->get('application')->getMvcEvent();

            #$lang = $event->getRouteMatch();


            #$registerForm->setAttribute("action", $this->s);


            $forms[IndexController::REGISTER] = $registerForm;
        }

        $controller = new IndexController($auth, $logger, $forms, $options);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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


1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @copyright (c) 2013-2015 Cross Solution (http://cross-solution.de)
7			* @author cbleek
8			* @license MIT
9			*/
10
11			namespace Auth\Factory\Controller;
12
13			use Zend\ServiceManager\FactoryInterface;
14			use Zend\ServiceManager\ServiceLocatorInterface;
15			use Zend\Log\LoggerInterface;
16			use Auth\Controller\IndexController;
17			use Auth\Form\Register;
18
19			class IndexControllerFactory implements FactoryInterface
20			{
21			/**
22			* Create controller
23			*
24			* @param ServiceLocatorInterface $controllerManager
25			*
26			* @return IndexController
27			*/
28			public function createService(ServiceLocatorInterface $controllerManager)
29			{
30			/* @var ServiceLocatorInterface $serviceLocator */
31			$serviceLocator = $controllerManager->getServiceLocator();
			0 ignored issues – show Bug introduced 2015-12-04 15:30 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: `Acl\Assertion\AssertionManager`, `Core\Mail\MailService`, `Core\Paginator\PaginatorService`, `ZendTest\Paginator\TestA...llingStylePluginManager`, `ZendTest\ServiceManager\TestAsset\FooPluginManager`, `Zend\Barcode\ObjectPluginManager`, `Zend\Barcode\RendererPluginManager`, `Zend\Cache\PatternPluginManager`, `Zend\Cache\Storage\AdapterPluginManager`, `Zend\Cache\Storage\PluginManager`, `Zend\Config\ReaderPluginManager`, `Zend\Config\WriterPluginManager`, `Zend\Crypt\SymmetricPluginManager`, `Zend\Crypt\Symmetric\PaddingPluginManager`, `Zend\Feed\Reader\ExtensionPluginManager`, `Zend\Feed\Writer\ExtensionPluginManager`, `Zend\File\Transfer\Adapter\FilterPluginManager`, `Zend\Filter\FilterPluginManager`, `Zend\Form\FormElementManager`, `Zend\I18n\Translator\LoaderPluginManager`, `Zend\InputFilter\InputFilterPluginManager`, `Zend\Log\ProcessorPluginManager`, `Zend\Log\WriterPluginManager`, `Zend\Log\Writer\FilterPluginManager`, `Zend\Log\Writer\FormatterPluginManager`, `Zend\Mail\Protocol\SmtpPluginManager`, `Zend\Mvc\Controller\ControllerManager`, `Zend\Mvc\Controller\PluginManager`, `Zend\Mvc\Router\RoutePluginManager`, `Zend\Paginator\AdapterPluginManager`, `Zend\Paginator\ScrollingStylePluginManager`, `Zend\Permissions\Acl\Assertion\AssertionManager`, `Zend\Serializer\AdapterPluginManager`, `Zend\ServiceManager\AbstractPluginManager`, `Zend\Stdlib\Hydrator\HydratorPluginManager`, `Zend\Tag\Cloud\DecoratorPluginManager`, `Zend\Text\Table\DecoratorManager`, `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...
32			$auth = $serviceLocator->get('AuthenticationService');
33			$loginForm = $serviceLocator->get('Auth\Form\Login');
34
35			/* @var $logger LoggerInterface*/
36			$logger = $serviceLocator->get('Core/Log');
37
38			/* @var $options \Auth\Options\ModuleOptions */
39			$options = $serviceLocator->get('Auth/Options');
40
41			$forms[IndexController::LOGIN] = $loginForm;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-03 17:05 UTC by Report Bug Copy Issue Report `$forms` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$forms = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
42
43			if ($options->getEnableRegistration()) {
44			/* @var $registerForm Register */
45			$registerForm = $serviceLocator->get('Auth\Form\Register');
46
47			/* @var \Zend\ServiceManager\AbstractPluginManager $serviceLocator */
48			/* @var \Zend\Mvc\MvcEvent $event */
49			#$event = $controllerManager->getServiceLocator()->get('application')->getMvcEvent();
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-01-03 17:05 UTC by Report Bug Copy Issue Report `69%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
50			#$lang = $event->getRouteMatch();
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-01-03 17:05 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
51
52			#$registerForm->setAttribute("action", $this->s);
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-01-03 17:05 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
53
54			$forms[IndexController::REGISTER] = $registerForm;
55			}
56
57			$controller = new IndexController($auth, $logger, $forms, $options);
			0 ignored issues – show Documentation introduced 2015-11-30 11:54 UTC by Report Bug Copy Issue Report `$auth` is of type `object\|array`, but the function expects a `object<Auth\AuthenticationService>`. 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... Documentation introduced 2015-11-30 11:54 UTC by Report Bug Copy Issue Report `$logger` is of type `object\|array`, but the function expects a `object<Zend\Log\LoggerInterface>`. 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...
58			return $controller;
59			}
60			}
61

cross-solution / YAWIK

Push — develop ( 828b3f...60c2a6 )

IndexControllerFactory A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like