View GitHub Repository iterators

Schedule Inspection
Subscribe

GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Push — master ( fc5653...e1c659 )
by Thomas
23:54
created

RandomIterator::getIterator()   A

↳ Parent: RandomIterator

Complexity

Conditions 3
Paths 2

Size

Total Lines 14
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

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

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace Gielfeldt\Iterators;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
class RandomIterator implements \IteratorAggregate

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
    private $count;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
    private $innerIterator;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
    public function __construct(\Traversable $iterator, int $count)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
        $this->innerIterator = new CountableIterator($iterator, CountableIterator::CACHE_COUNT);

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
        $this->count = $count;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    public function getIterator()

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        $innerCount = $this->innerIterator->count();

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
        $count = min($this->count, $innerCount);

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
        for ($i = 0; $i < $count; $i++) {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
            do {

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
                $index = rand(0, $innerCount - 1);

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
            } while (isset($indexes[$index]));

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
            $indexes[$index] = $index;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

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

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
        sort($indexes);

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
        $indexes = new \ArrayIterator($indexes);

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        return new IndexIterator($this->innerIterator, $indexes);

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    31