View GitHub Repository firewall

Schedule Inspection
Subscribe
Passed
Branch — master (ecb760)
by Antonio Carlos
05:12
created

CacheTest::test_cache_put()   A

↳ Parent: CacheTest

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 4
nc 2
nop 0
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace PragmaRX\Firewall\Tests;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
class CacheTest extends TestCase

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
    public function setUp()

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
        parent::setup();

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
        $this->cache = app('firewall.cache');

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The property cache does not exist. Did you maybe forget to declare it?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
In PHP it is possible to write to properties without declaring them. For example,
the following is perfectly valid PHP code:


class MyClass { }

$x = new MyClass();
$x->foo = true;





Generally, it is a good practice to explictly declare properties to avoid
accidental typos and provide IDE auto-completion:


class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;





                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
    public function test_cache_put()

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
        foreach (range(1, 100) as $counter) {

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
            $this->cache->put($key = '1234', $this->cache->get($key, 0) + 1, 10);

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        $this->assertEquals(100, $this->cache->get($key));

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The variable $key 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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    23