View GitHub Repository phpab-module

Schedule Inspection
Subscribe
Completed
Push — master ( 348af9...23656b )
by Walter
05:14 queued 02:58
created

ScriptFactory::createService()   A

↳ Parent: ScriptFactory

Complexity

Conditions 2
Paths 2

Size

Total Lines 17
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 17
rs 9.4285
cc 2
eloc 9
nc 2
nop 1
1 
<?php
2 
/**
3 
 * This file is part of phpab/phpab-module. (https://github.com/phpab/phpab-module)
4 
 *
5 
 * @link https://github.com/phpab/phpab-module for the canonical source repository
6 
 * @copyright Copyright (c) 2015-2016 phpab. (https://github.com/phpab/)
7 
 * @license https://raw.githubusercontent.com/phpab/phpab-module/master/LICENSE MIT
8 
 */
9 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
namespace PhpAbModule\View\Helper\Service;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
use PhpAbModule\View\Helper\Script;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
use RuntimeException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
use Zend\ServiceManager\FactoryInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
use Zend\ServiceManager\ServiceLocatorInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
class ScriptFactory implements FactoryInterface

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
    public function createService(ServiceLocatorInterface $serviceLocator)

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
        $serviceManager = $serviceLocator->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\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\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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
        $config = $serviceManager->get('Config');

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
        if (!$serviceManager->has($config['phpab']['analytics']['renderer'])) {

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
            throw new RuntimeException(sprintf(

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
                'The data renderer "%s" does not exists.',

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
                $config['phpab']['analytics']['renderer']

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
            ));

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
        $renderer = $serviceManager->get($config['phpab']['analytics']['renderer']);

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
        return new Script($renderer);

            


            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    37