View GitHub Repository WebinoDraw

Schedule Inspection
Subscribe

FormFactory::createService()   A
last analyzed

↳ Parent: FormFactory

Complexity

Conditions 1
Paths 1

Size

Total Lines 22

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 22
rs 9.568
c 0
b 0
f 0
cc 1
nc 1
nop 1
1 
<?php
2 
/**
3 
 * Webino (http://webino.sk)
4 
 *
5 
 * @link        https://github.com/webino/WebinoDraw for the canonical source repository
6 
 * @copyright   Copyright (c) 2012-2017 Webino, s. r. o. (http://webino.sk)
7 
 * @author      Peter Bačinský <[email protected]>
8 
 * @license     BSD-3-Clause
9 
 */
10 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
namespace WebinoDraw\Factory\HelperFactory;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
use WebinoDraw\Draw\Helper\Form;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
use WebinoDraw\Form\View\Helper\FormRow;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
use WebinoDraw\Instructions\InstructionsRenderer;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
use Zend\ServiceManager\FactoryInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
use Zend\ServiceManager\ServiceLocatorInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
 * Class FormFactory

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
class FormFactory implements FactoryInterface

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
     * @param ServiceLocatorInterface $drawHelpers

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
     * @return Form

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
    public function createService(ServiceLocatorInterface $drawHelpers)

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        $services    = $drawHelpers->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: WebinoDraw\Draw\HelperPluginManager, WebinoDraw\Draw\LoopHelperPluginManager, Zend\Cache\PatternPlugin...PluginManagerV2Polyfill, Zend\Cache\PatternPlugin...PluginManagerV3Polyfill, Zend\Cache\Storage\AdapterPluginManager, Zend\Cache\Storage\PluginManager, Zend\Config\ReaderPluginManager, Zend\Config\WriterPluginManager, Zend\Filter\FilterPluginManager, Zend\Form\FormElementManager, Zend\Hydrator\HydratorPluginManager, Zend\I18n\Translator\LoaderPluginManager, Zend\InputFilter\InputFilterPluginManager, Zend\Log\FilterPluginManager, Zend\Log\FormatterPluginManager, Zend\Log\ProcessorPluginManager, Zend\Log\WriterPluginManager, Zend\Log\Writer\FilterPluginManager, Zend\Log\Writer\FormatterPluginManager, Zend\Mvc\Controller\ControllerManager, Zend\Mvc\Controller\PluginManager, Zend\Mvc\Router\RoutePluginManager, Zend\Paginator\AdapterPluginManager, Zend\Paginator\ScrollingStylePluginManager, Zend\ServiceManager\AbstractPluginManager, Zend\Stdlib\Hydrator\HydratorPluginManager, 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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
        $viewHelpers = $services->get('ViewHelperManager');

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
        $formRow     = $viewHelpers->get(FormRow::SERVICE);

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
        $formCollection = clone $viewHelpers->get('FormCollection');

            


            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
        $formCollection->setDefaultElementHelper(FormRow::SERVICE);

            


            
                                                        
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    37
                

                                    
                                                    
                
                
                
        $form = new Form(

            


            
                                                        
            
                                    
            
            

                
                    38
                

                                    
                                                    
                
                
                
            $services,

            


            
                                                        
            
                                    
            
            

                
                    39
                

                                    
                                                    
                
                
                
            $formRow,

            


            
                                                        
            
                                    
            
            

                
                    40
                

                                    
                                                    
                
                
                
            $formRow->getElementHelper(),

            


            
                                                        
            
                                    
            
            

                
                    41
                

                                    
                                                    
                
                
                
            $viewHelpers->get('FormElementErrors'),

            


            
                                                        
            
                                    
            
            

                
                    42
                

                                    
                                                    
                
                
                
            $formCollection,

            


            
                                                        
            
                                    
            
            

                
                    43
                

                                    
                                                    
                
                
                
            $viewHelpers->get('Url'),

            


            
                                                        
            
                                    
            
            

                
                    44
                

                                    
                                                    
                
                
                
            $services->get(InstructionsRenderer::class)

            


            
                                                        
            
                                    
            
            

                
                    45
                

                                    
                                                    
                
                
                
        );

            


            
                                                        
            
                                    
            
            

                
                    46
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    47
                

                                    
                                                    
                
                
                
        $form->setEventManager($services->get('EventManager'));

            


            
                                                        
            
                                    
            
            

                
                    48
                

                                    
                                                    
                
                
                
        return $form;

            


            
                                                        
            
                                    
            
            

                
                    49
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    50
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    51