UserControllerFactory - Code Metrics - ZF-Commons/ZfcUser - Measure and Improve Code Quality continuously with Scrutinizer

UserControllerFactory A
last analyzed 2016-09-27 16:19 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

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

1 Method

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

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license.
 */

namespace ZfcUser\Factory\Controller;

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

class UserControllerFactory implements FactoryInterface
{
    /**
     * Create controller
     *
     * @param ControllerManager $serviceLocator
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return UserController
     */
    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.
    }
}

        $userService = $serviceLocator->get('zfcuser_user_service');
        $registerForm = $serviceLocator->get('zfcuser_register_form');
        $loginForm = $serviceLocator->get('zfcuser_login_form');
        $options = $serviceLocator->get('zfcuser_module_options');

        $controller = new UserController($userService, $options, $registerForm, $loginForm);

        return $controller;
    }
}


1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the MIT license.
17			*/
18
19			namespace ZfcUser\Factory\Controller;
20
21			use Zend\Mvc\Controller\ControllerManager;
22			use Zend\ServiceManager\FactoryInterface;
23			use Zend\ServiceManager\ServiceLocatorInterface;
24			use ZfcUser\Controller\UserController;
25
26			class UserControllerFactory implements FactoryInterface
27			{
28			/**
29			* Create controller
30			*
31			* @param ControllerManager $serviceLocator
			0 ignored issues – show Bug introduced 2016-03-07 22:45 UTC by Report Bug Copy Issue Report There is no parameter named `$serviceLocator`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
32			* @return UserController
33			*/
34			public function createService(ServiceLocatorInterface $controllerManager)
35			{
36			/* @var ServiceLocatorInterface $serviceLocator */
37			$serviceLocator = $controllerManager->getServiceLocator();
			0 ignored issues – show Bug introduced 2016-07-08 13:56 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\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...
38
39			$userService = $serviceLocator->get('zfcuser_user_service');
40			$registerForm = $serviceLocator->get('zfcuser_register_form');
41			$loginForm = $serviceLocator->get('zfcuser_login_form');
42			$options = $serviceLocator->get('zfcuser_module_options');
43
44			$controller = new UserController($userService, $options, $registerForm, $loginForm);
45
46			return $controller;
47			}
48			}
49

ZF-Commons / ZfcUser

UserControllerFactory A last analyzed 2016-09-27 16:19 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like

UserControllerFactory A
last analyzed 2016-09-27 16:19 UTC