View GitHub Repository input

Schedule Inspection
Subscribe
Completed
Push — master ( 13238d...60cc44 )
by Klaus
02:13
created

SchemaBuilder::walk()   A

↳ Parent: SchemaBuilder

Complexity

Conditions 3
Paths 3

Size

Total Lines 16
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 16
rs 9.4285
c 0
b 0
f 0
cc 3
eloc 10
nc 3
nop 1
1 
<?php
2 
declare(strict_types=1);
3 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                
namespace Linio\Component\Input;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
use Linio\Component\Input\Node\BaseNode;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
class SchemaBuilder

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
    public function build(InputHandler $inputHandler): array

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
        $inputHandler->define();

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        $schema = $this->walk($inputHandler->getRoot());

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
        return $schema;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
    protected function walk(BaseNode $node): array

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        if (!$node->hasChildren()) {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
            return [];

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
        foreach ($node->getChildren() as $field => $childNode) {

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
            $schema[$field]['type'] = $childNode->getTypeAlias();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Coding Style
            Comprehensibility
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
$schema was never initialized. Although not strictly required by PHP, it is generally a good practice to add $schema = array(); before regardless.
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Adding an explicit array definition is generally preferable to implicit array
definition as it guarantees a stable state of the code.


Let’s take a look at an example:


foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}





As you can see in this example, the array $myArray is initialized the first
time when the foreach loop is entered. You can also see that the value of the
bar key is only written conditionally; thus, its value might result from a
previous iteration.


This might or might not be intended. To make your intention clear, your code
more readible and to avoid accidental bugs, we recommend to add an explicit
initialization $myArray = array() either outside or inside the foreach loop.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
            $schema[$field]['required'] = $childNode->isRequired();

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
            $schema[$field]['default'] = $childNode->getDefault();

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
            $schema[$field]['nullable'] = $childNode->allowNull();

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
            $schema[$field]['children'] = $this->walk($childNode);

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
        return $schema;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The variable $schema does not seem to be defined for all execution paths leading up to this point.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
If you define a variable conditionally, it can happen that it is not defined
for all execution paths.


Let’s take a look at an example:


function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}





In the above example, the variable $x is defined if you pass “foo” or “bar”
as argument for $a. However, since the switch statement has no default
case statement, if you pass any other value, the variable $x would be undefined.




Available Fixes


  1. Check for existence of the variable explicitly:
    

    function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    if (isset($x)) { // Make sure it's always set.
        echo $x;
    }
}

    

    

    2. 

  2. Define a default value for the variable:
    

    function myFunction($a) {
    $x = ''; // Set a default which gets overridden for certain paths.
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    echo $x;
}

    

    

    3. 

  3. Add a value for the missing path:
    

    function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;

        // We add support for the missing case.
        default:
            $x = '';
            break;
    }

    echo $x;
}

    

    

    4. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    35