View GitHub Repository forge-publish

Schedule Inspection
Subscribe

skipIfEnvVarIsAlreadyInstalled()   A
last analyzed

↳ Parent: SkipsIfEnvVariableIsAlreadyInstalled

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

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

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace Acacha\ForgePublish\Commands\Traits;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
 * Trait SkipsIfTokenIsAlreadyInstalled

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
 *

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
 * @package Acacha\ForgePublish\Commands

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
trait SkipsIfEnvVariableIsAlreadyInstalled

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
     * Skip if token is already installed.

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
    protected function skipIfEnvVarIsAlreadyInstalled($env_var)

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
        if (fp_env($env_var, null) != null) {

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
            $this->info("The environment variable $env_var already exists in your environment (check .env file).");

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like info() must be provided by classes using this trait. How about adding it as abstract method to this trait?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for methods that are used by a trait but not required by it.


To illustrate, let’s look at the following code example


trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}





The trait Idable provides a method equalsId that in turn relies on the
method getId(). If this method does not exist on a class mixing in this
trait, the method will fail.


Adding the getId() as an abstract method to the trait will make sure it
is available.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
            $this->info("Please remove the $env_var an re-execute command. Skipping...");

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like info() must be provided by classes using this trait. How about adding it as abstract method to this trait?
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for methods that are used by a trait but not required by it.


To illustrate, let’s look at the following code example


trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}





The trait Idable provides a method equalsId that in turn relies on the
method getId(). If this method does not exist on a class mixing in this
trait, the method will fail.


Adding the getId() as an abstract method to the trait will make sure it
is available.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
            die();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Coding Style
            Compatibility
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The method skipIfEnvVarIsAlreadyInstalled() contains an exit expression.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
An exit expression should only be used in rare cases. For example, if you
write a short command line script.


In most cases however, using an exit expression makes the code untestable
and often causes incompatibilities with other libraries. Thus, unless you are
absolutely sure it is required here, we recommend to refactor your code to
avoid its usage.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    24