View GitHub Repository compiler

Schedule Inspection
Subscribe
Completed
Push — master ( 69b695...671bd7 )
by Kirill
06:49
created

PragmaResolver   A

↳ Parent: Project

Complexity

Total Complexity 3

Size/Duplication

Total Lines 20
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 2

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
wmc 3
lcom 1
cbo 2
dl 0
loc 20
ccs 0
cts 10
cp 0
rs 10
c 0
b 0
f 0

1 Method

Rating   Name   Duplication   Size   Complexity  
A resolve() 0 12 3
1 
<?php
2 
/**
3 
 * This file is part of Railt package.
4 
 *
5 
 * For the full copyright and license information, please view the LICENSE
6 
 * file that was distributed with this source code.
7 
 */
8 
declare(strict_types=1);
9 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
namespace Railt\Compiler\Grammar\PP2;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
use Railt\Compiler\Reader\BasePragmas;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
use Railt\Io\Readable;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
use Railt\Lexer\TokenInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
 * Class PragmaResolver

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
 */

            


            
                                                                        
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
class PragmaResolver extends BasePragmas implements ResolverInterface

            


            
                                                                        
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
{

            


            
                                                                        
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                        
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
     * @param Readable $readable

            


            
                                                                        
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
     * @param TokenInterface $token

            


            
                                                                        
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
     * @throws \Railt\Io\Exception\ExternalFileException

            


            
                                                                        
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
     */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
    public function resolve(Readable $readable, TokenInterface $token): void

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        [$name, $value] = [$token->value(1), $token->value(2)];

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                                                                        
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The variable $name seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This error can happen if you refactor code and forget to move the variable
initialization.


Let’s take a look at a simple example:


function someFunction() {
    $x = 5;
    echo $x;
}





The above code is perfectly fine. Now imagine that we re-order the statements:


function someFunction() {
    echo $x;
    $x = 5;
}





In that case, $x would be read before it is initialized. This was a very
basic example, however the principle is the same for the found issue.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                            




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The variable $value does not exist. Did you forget to declare it?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check marks access to variables or properties that have not been declared yet. While PHP
has no explicit notion of declaring a variable, accessing it before a value is assigned
to it is most likely a bug.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        foreach ($this->getResolvers() as $group => $resolver) {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
            if ($resolver->match($name)) {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
                $name = $this->verifyPragmaName($readable, $token, $resolver->resolve($name));

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The variable $name 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
                

                                    
                                                    
                
                
                
                $this->set($group, $name, $value);

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
            }

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
        }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    37
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    38
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    39