View GitHub Repository GraphQLBundle

Schedule Inspection
Subscribe

Scrutinizer GitHub App not installed

We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.

Install GitHub App

Completed
Pull Request — master (#40)
by Jérémiah
05:07
created

InputObjectTypeDefinition::getDefinition()   A

↳ Parent: InputObjectTypeDefinition

Complexity

Conditions 1
Paths 1

Size

Total Lines 23
Code Lines 19

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 18
CRAP Score 1

Importance

Changes 1
Bugs 1 Features 0
Metric Value
c 1
b 1
f 0
dl 0
loc 23
ccs 18
cts 18
cp 1
rs 9.0856
cc 1
eloc 19
nc 1
nop 0
crap 1
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
/*

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                
 * This file is part of the OverblogGraphQLBundle package.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
 * (c) Overblog <http://github.com/overblog/>

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
 * For the full copyright and license information, please view the LICENSE

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
 * file that was distributed with this source code.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
namespace Overblog\GraphQLBundle\Config;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

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

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
class InputObjectTypeDefinition extends TypeDefinition

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                             15                         
                
                
                
    public function getDefinition()

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                             15                         
                
                
                
        $builder = new TreeBuilder();

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                             15                         
                
                
                
        $node = $builder->root('_input_object_config');

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
        $node

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
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 append() 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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                             15                         
                
                
                
            ->children()

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                             15                         
                
                
                
                ->append($this->nameSection())

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                             15                         
                
                
                
                ->arrayNode('fields')

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                             15                         
                
                
                
                    ->useAttributeAsKey('name', false)

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                             15                         
                
                
                
                    ->prototype('array')

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                             15                         
                
                
                
                        ->append($this->typeSelection(true))

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                             15                         
                
                
                
                        ->append($this->descriptionSection())

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                             15                         
                
                
                
                        ->append($this->defaultValueSection())

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                             15                         
                
                
                
                    ->end()

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                             15                         
                
                
                
                    ->isRequired()

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                             15                         
                
                
                
                    ->requiresAtLeastOneElement()

            


            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                             15                         
                
                
                
                ->end()

            


            
                                                        
            
                                    
            
            

                
                    36
                

                                    
                             15                         
                
                
                
                ->append($this->descriptionSection())

            


            
                                                        
            
                                    
            
            

                
                    37
                

                                    
                             15                         
                
                
                
            ->end();

            


            
                                                        
            
                                    
            
            

                
                    38
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    39
                

                                    
                             15                         
                
                
                
        return $node;

            


            
                                                        
            
                                    
            
            

                
                    40
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    41
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    42