View GitHub Repository stakx

Schedule Inspection
Subscribe
Completed
Push — master ( 2fc7ef...2c7029 )
by Vladimir
07:48
created

ExceptionRenderer::render()   A

↳ Parent: ExceptionRenderer

Complexity

Conditions 2
Paths 2

Size

Total Lines 21

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 21
rs 9.584
c 0
b 0
f 0
cc 2
nc 2
nop 2
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
/**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                
 * @copyright 2018 Vladimir Jimenez

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
 * @license   https://github.com/stakx-io/stakx/blob/master/LICENSE.md MIT

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
 */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
namespace allejo\stakx\Server;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
use allejo\stakx\Compiler;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
use allejo\stakx\Filesystem\FilesystemLoader as fs;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
use allejo\stakx\Templating\TemplateErrorInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
class ExceptionRenderer

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
{

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    public static function render(\Exception $exception, Compiler $compiler)

            


            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
        $source = fs::getInternalResource('error.html.twig');

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Documentation
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
'error.html.twig' is of type string, but the function expects a object<string>.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
It seems like the type of the argument is not accepted by the function/method
which you are calling.


In some cases, in particular if PHP’s automatic type-juggling kicks in this
might be fine. In other cases, however this might be a bug.


We suggest to add an explicit type cast like in the following example:


function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);





                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
        $template = $compiler->getTemplateBridge()->createTemplate($source);

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
        if ($exception instanceof TemplateErrorInterface)

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
        {

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
            $message = [

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
                sprintf('File: %s:%d', $exception->getRelativeFilePath(), $exception->getTemplateLine()),

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
            ];

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
        $message[] = $exception->getMessage();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                                                                        
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

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

                    


    




                                                                                            




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The method getMessage does only exist in Exception, but not in allejo\stakx\Templating\TemplateErrorInterface.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
It seems like the method you are trying to call exists only in some of the
possible types.


Let’s take a look at an example:


class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}







Available Fixes


  1. Add an additional type-check:
    

    /**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo();

    if ($x instanceof B) {
        $x->bar();
    }
}

    

    

    2. 

  2. Only allow a single type to be passed if the variable comes from a parameter:
    

    function someFunction(B $x) { /** ... */ }

    

    

    3. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
        return $template->render([

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
            'error_title' => 'Internal Server Error (500)',

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
            'error_exception' => get_class($exception),

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
            'error_message' => implode("\n\n", $message),

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
            'error_trace' => $exception->getTraceAsString(),

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The method getTraceAsString does only exist in Exception, but not in allejo\stakx\Templating\TemplateErrorInterface.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
It seems like the method you are trying to call exists only in some of the
possible types.


Let’s take a look at an example:


class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}







Available Fixes


  1. Add an additional type-check:
    

    /**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo();

    if ($x instanceof B) {
        $x->bar();
    }
}

    

    

    2. 

  2. Only allow a single type to be passed if the variable comes from a parameter:
    

    function someFunction(B $x) { /** ... */ }

    

    

    3. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
        ]);

            


            
                                                        
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    37
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    38