IndexControllerFactory::__invoke() - Code Metrics - Inspection of "[General] makes factories ZF3 compatible (#336)" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 49270f...975a05 )

unknown

created 2017-03-02 19:59 UTC

IndexControllerFactory::__invoke() A

↳ Parent: IndexControllerFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	23
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	9.0856
c	0
b	0
f	0
cc	2
eloc	12
nc	2
nop	3

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

namespace Auth\Factory\Controller;

use Interop\Container\ContainerInterface;
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 an IndexController controller
     *
     * @param  ContainerInterface $container
     * @param  string             $requestedName
     * @param  null|array         $options
     *
     * @return IndexController
     * @throws ServiceNotFoundException if unable to resolve the service.
     * @throws ServiceNotCreatedException if an exception is raised when
     *     creating a service.
     * @throws ContainerException if any other error occurs
     */
    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
    {
        $auth = $container->get('AuthenticationService');
        $formElementManager = $container->get('formElementManager');
        $loginForm = $formElementManager->get('Auth\Form\Login');

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

        /* @var $options \Auth\Options\ModuleOptions */
        $options = $container->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 = $formElementManager->get('Auth\Form\Register');
            $forms[IndexController::REGISTER] = $registerForm;
        }

        $controller = new IndexController($auth, $logger, $forms, $options);
        return $controller;
    }
    /**
     * Create controller
     *
     * @param ServiceLocatorInterface $controllerManager
     *
     * @return IndexController
     */
    public function createService(ServiceLocatorInterface $controllerManager)
    {
        return $this($controllerManager->getServiceLocator(), UserStatusFieldset::class);
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.
    }
}
    }
}


1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
7			* @author cbleek
8			* @license MIT
9			*/
10
11			namespace Auth\Factory\Controller;
12
13			use Interop\Container\ContainerInterface;
14			use Zend\ServiceManager\FactoryInterface;
15			use Zend\ServiceManager\ServiceLocatorInterface;
16			use Zend\Log\LoggerInterface;
17			use Auth\Controller\IndexController;
18			use Auth\Form\Register;
19
20			class IndexControllerFactory implements FactoryInterface
21			{
22
23
24			/**
25			* Create an IndexController controller
26			*
27			* @param ContainerInterface $container
28			* @param string $requestedName
29			* @param null\|array $options
30			*
31			* @return IndexController
32			* @throws ServiceNotFoundException if unable to resolve the service.
33			* @throws ServiceNotCreatedException if an exception is raised when
34			* creating a service.
35			* @throws ContainerException if any other error occurs
36			*/
37			public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
38			{
39			$auth = $container->get('AuthenticationService');
40			$formElementManager = $container->get('formElementManager');
41			$loginForm = $formElementManager->get('Auth\Form\Login');
42
43			/* @var $logger LoggerInterface*/
44			$logger = $container->get('Core/Log');
45
46			/* @var $options \Auth\Options\ModuleOptions */
47			$options = $container->get('Auth/Options');
48
49			$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...
50
51			if ($options->getEnableRegistration()) {
52			/* @var $registerForm Register */
53			$registerForm = $formElementManager->get('Auth\Form\Register');
54			$forms[IndexController::REGISTER] = $registerForm;
55			}
56
57			$controller = new IndexController($auth, $logger, $forms, $options);
58			return $controller;
59			}
60			/**
61			* Create controller
62			*
63			* @param ServiceLocatorInterface $controllerManager
64			*
65			* @return IndexController
66			*/
67			public function createService(ServiceLocatorInterface $controllerManager)
68			{
69			return $this($controllerManager->getServiceLocator(), UserStatusFieldset::class);
			0 ignored issues – show Bug introduced 2017-03-02 20:05 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`, `Zend\Barcode\ObjectPluginManager`, `Zend\Barcode\RendererPluginManager`, `Zend\Cache\PatternPluginManager`, `Zend\Cache\Storage\AdapterPluginManager`, `Zend\Cache\Storage\PluginManager`, `Zend\Config\ReaderPluginManager`, `Zend\Config\WriterPluginManager`, `Zend\Feed\Reader\ExtensionPluginManager`, `Zend\Feed\Writer\ExtensionPluginManager`, `Zend\File\Transfer\Adapter\FilterPluginManager`, `Zend\File\Transfer\Adapter\ValidatorPluginManager`, `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\Mail\Protocol\SmtpPluginManager`, `Zend\Mvc\Controller\ControllerManager`, `Zend\Mvc\Controller\PluginManager`, `Zend\Mvc\Router\RoutePluginManager`, `Zend\Paginator\AdapterPluginManager`, `Zend\Paginator\ScrollingStylePluginManager`, `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...
70			}
71			}
72

cross-solution / YAWIK

Push — develop ( 49270f...975a05 )

IndexControllerFactory::__invoke() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like