View GitHub Repository ezpublish-kernel

Schedule Inspection
Subscribe
Completed
Push — travis_trusty ( e78e49...6f0d6f )
by André
54:54 queued 34:46
created

Configuration::addRestRootResourcesSection()   A

↳ Parent: Configuration

Complexity

Conditions 1
Paths 1

Size

Total Lines 13
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
c 1
b 0
f 1
dl 0
loc 13
rs 9.4285
cc 1
eloc 11
nc 1
nop 1
1 
<?php
2 
/**
3 
 * This file is part of the eZ Publish Kernel package.
4 
 *
5 
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
6 
 * @license For full copyright and license information view LICENSE file distributed with this source code.
7 
 */
8 
namespace eZ\Bundle\EzPublishRestBundle\DependencyInjection;
9 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
use eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Configuration\SiteAccessAware\Configuration as SiteAccessConfiguration;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
class Configuration extends SiteAccessConfiguration

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
    public function getConfigTreeBuilder()

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
        $treeBuilder = new TreeBuilder();

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        $rootNode = $treeBuilder->root('ez_publish_rest');

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        $this->addRestRootResourcesSection($rootNode);

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
        return $treeBuilder;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    public function addRestRootResourcesSection($rootNode)

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
        $systemNode = $this->generateScopeBaseNode($rootNode);

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        $systemNode

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a specific sub-type and not the parent class Symfony\Component\Config...\Builder\NodeDefinition as the method children() does only exist in the following sub-classes of Symfony\Component\Config...\Builder\NodeDefinition: Symfony\Component\Config...der\ArrayNodeDefinition. Maybe you want to instanceof check for one of these explicitly?
                                                                                                                                                                                                                                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Let’s take a look at an example:


abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 sub-classes
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 parent class:
    

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

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

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
            ->arrayNode('rest_root_resources')

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
                ->prototype('array')

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
                    ->children()

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
                        ->scalarNode('mediaType')->isRequired()->end()

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
                        ->scalarNode('href')->isRequired()->end()

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
                    ->end()

            


            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
                ->end()

            


            
                                                        
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
            ->end();

            


            
                                                        
            
                                    
            
            

                
                    37
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    38
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    39