Issues in UserControllerFactory.php - Fixed Issues - Inspection of "Spanish translation" - ZF-Commons/ZfcUser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 1.x (#641)

unknown

created 2016-05-25 21:29 UTC

Factory/Controller/UserControllerFactory.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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($serviceManager->get('zfcuser_change_email_form'));
        $controller->setOptions($serviceManager->get('zfcuser_module_options'));
        $controller->setChangePasswordForm($serviceManager->get('zfcuser_change_password_form'));
        $controller->setLoginForm($serviceManager->get('zfcuser_login_form'));
        $controller->setRegisterForm($serviceManager->get('zfcuser_register_form'));
        $controller->setUserService($serviceManager->get('zfcuser_user_service'));

        return $controller;
    }
}


Pull Request — 1.x (#641)

Factory/Controller/UserControllerFactory.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

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 Show Similar Issues like this 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($serviceManager->get('zfcuser_change_email_form'));
39			$controller->setOptions($serviceManager->get('zfcuser_module_options'));
40			$controller->setChangePasswordForm($serviceManager->get('zfcuser_change_password_form'));
41			$controller->setLoginForm($serviceManager->get('zfcuser_login_form'));
42			$controller->setRegisterForm($serviceManager->get('zfcuser_register_form'));
43			$controller->setUserService($serviceManager->get('zfcuser_user_service'));
44
45			return $controller;
46			}
47			}
48

ZF-Commons / ZfcUser

Pull Request — 1.x (#641)

Factory/Controller/UserControllerFactory.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like