View GitHub Repository ZfcUser

Schedule Inspection
Subscribe
Completed
Push — 1.x ( 6e286e...c7aa89 )
by Daniel
45:22 queued 35:25
created

ZfcUserAuthentication::createService()   A

↳ Parent: ZfcUserAuthentication

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
c 2
b 1
f 0
dl 0
loc 10
rs 9.4286
cc 1
eloc 8
nc 1
nop 1
1 
<?php
2 
/**
3 
 * Created by PhpStorm.
4 
 * User: Clayton Daley
5 
 * Date: 5/6/2015
6 
 * Time: 6:48 PM
7 
 */
8 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
namespace ZfcUser\Factory\Controller\Plugin;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
use Zend\ServiceManager\FactoryInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
use Zend\ServiceManager\ServiceLocatorInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
use ZfcUser\Controller;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
class ZfcUserAuthentication implements FactoryInterface

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
     * Create service

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
     *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
     * @param ServiceLocatorInterface $serviceManager

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
     * @return mixed

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
    public function createService(ServiceLocatorInterface $serviceManager)

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
        $serviceLocator = $serviceManager->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\Crypt\SymmetricPluginManager, Zend\Crypt\Symmetric\PaddingPluginManager, Zend\Filter\FilterPluginManager, Zend\Form\FormElementManager, Zend\Hydrator\HydratorPluginManager, Zend\InputFilter\InputFilterPluginManager, Zend\Math\BigInteger\AdapterPluginManager, 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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
        $authService = $serviceLocator->get('zfcuser_auth_service');

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        $authAdapter = $serviceLocator->get('ZfcUser\Authentication\Adapter\AdapterChain');

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
        $controllerPlugin = new Controller\Plugin\ZfcUserAuthentication;

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        $controllerPlugin->setAuthService($authService);

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
        $controllerPlugin->setAuthAdapter($authAdapter);

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
        return $controllerPlugin;

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    35