View GitHub Repository ZfcUser

Schedule Inspection
Subscribe
Completed
Pull Request — 1.x (#641)
by
unknown
15:00
created

UserControllerFactory::createService()   A

↳ Parent: UserControllerFactory

Complexity

Conditions 1
Paths 1

Size

Total Lines 21
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 4
Bugs 3 Features 0
Metric Value
c 4
b 3
f 0
dl 0
loc 21
rs 9.3142
cc 1
eloc 12
nc 1
nop 1
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 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
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


  1. Change the type-hint for the parameter:
    

    class AuthSystem
{
    public function authenticate(MyUser $user) { /* ... */ }
}

    

    

    2. 

  2. 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.'
            );
        }

    }
}

    

    

    3. 




 Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.


  1. Add the method to the interface:
    

    interface User
{
    /** @return string */
    public function getPassword();

    /** @return string */
    public function getDisplayName();
}

    

    

    2. 



                        

                                                    

                     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