View GitHub Repository improved-php-iterable

Schedule Inspection
Subscribe

iterable_first()   A
last analyzed

↳ Parent: Project

Complexity

Conditions 3
Paths 3

Size

Total Lines 11
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 3

Importance

Changes 0
Metric Value
cc 3
eloc 5
nc 3
nop 2
dl 0
loc 11
ccs 5
cts 5
cp 1
crap 3
rs 10
c 0
b 0
f 0
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
declare(strict_types=1);

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
namespace Improved;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
 * Get the first element of an iterable.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
 * @param iterable $iterable

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
 * @param bool     $required  Throw RangeException instead of returning null for empty iterable

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
 * @return mixed

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
 */

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
function iterable_first(iterable $iterable, bool $required = false)

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                        

                                        
Function Improved\iterable_first() has parameter $iterable with no value type specified in iterable type iterable.
                                            

                    
                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                             9                         
                
                
                
    foreach ($iterable as $value) {

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                             7                         
                
                
                
        return $value;

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                             2                         
                
                
                
    if ($required) {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                             1                         
                
                
                
        throw new \RangeException("Unable to get first element; iterable is empty");

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                             1                         
                
                
                
    return null;

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    26