View GitHub Repository deathbycaptcha-php-sdk

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 ( 4bd95a...762678 )
by Carlos
02:56
created

handlerHttpResponseIsOk()   D

↳ Parent: HttpHandlerResponseAbstract

Complexity

Conditions 9
Paths 8

Size

Total Lines 39
Code Lines 24

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 19
CRAP Score 9

Importance

Changes 0
Metric Value
dl 0
loc 39
ccs 19
cts 19
cp 1
rs 4.909
c 0
b 0
f 0
cc 9
eloc 24
nc 8
nop 0
crap 9
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace juniorb2ss\DeathByCaptcha\Abstracts;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
use Psr\Http\Message\ResponseInterface;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
use juniorb2ss\DeathByCaptcha\Exceptions\AccessDeniedException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
use juniorb2ss\DeathByCaptcha\Exceptions\CaptchaNotFoundException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
use juniorb2ss\DeathByCaptcha\Exceptions\InternalServiceException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
use juniorb2ss\DeathByCaptcha\Exceptions\InvalidCaptchaException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
use juniorb2ss\DeathByCaptcha\Exceptions\InvalidServiceResponseException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
use juniorb2ss\DeathByCaptcha\Exceptions\ServiceOverloadException;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
abstract class HttpHandlerResponseAbstract

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
     * Define o content que deverá ser a resposta

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
     * do serviço

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
     * @var string

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
     */

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
    protected $contentTypeOk = 'application/json; charset=utf8';

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
     * Executa verificação da integridade da resposta

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
     * desde do cabeçalho do response até o conteúdo

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
     * @return void|ClientException

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    27
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                             75                         
                
                
                
    protected function handlerHttpResponseIsOk()

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                             75                         
                
                
                
        $response = $this->response;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The property response 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...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                             75                         
                
                
                
        $contentType = $response->getHeaderLine('Content-Type');

            


            
                                                        
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    33
                

                                    
                             75                         
                
                
                
        $statusCode = $response->getStatusCode();

            


            
                                                        
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
        // Efetua o tratamento do status code do response

            


            
                                                        
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
        switch ($statusCode) {

            


            
                                                        
            
                                    
            
            

                
                    37
                

                                    
                             75                         
                
                
                
            case 400:

            


            
                                                        
            
                                    
            
            

                
                    38
                

                                    
                             3                         
                
                
                
                throw new InvalidCaptchaException;

            


            
                                                        
            
                                    
            
            

                
                    39
                

                                    
                                                    
                
                
                
                break;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
break; does not seem to be reachable.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for unreachable code. It uses sophisticated control flow analysis techniques to
find statements which will never be executed.


Unreachable code is most often the result of return, die or exit
statements that have been added for debug purposes.


function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}





In the above example, the last return false will never be executed, because
a return statement has already been met in every possible execution path.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    40
                

                                    
                             72                         
                
                
                
            case 403:

            


            
                                                        
            
                                    
            
            

                
                    41
                

                                    
                             3                         
                
                
                
                throw new AccessDeniedException;

            


            
                                                        
            
                                    
            
            

                
                    42
                

                                    
                                                    
                
                
                
                break;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
break; does not seem to be reachable.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for unreachable code. It uses sophisticated control flow analysis techniques to
find statements which will never be executed.


Unreachable code is most often the result of return, die or exit
statements that have been added for debug purposes.


function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}





In the above example, the last return false will never be executed, because
a return statement has already been met in every possible execution path.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    43
                

                                    
                             69                         
                
                
                
            case 404:

            


            
                                                        
            
                                    
            
            

                
                    44
                

                                    
                             3                         
                
                
                
                throw new CaptchaNotFoundException;

            


            
                                                        
            
                                    
            
            

                
                    45
                

                                    
                                                    
                
                
                
                break;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
break; does not seem to be reachable.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for unreachable code. It uses sophisticated control flow analysis techniques to
find statements which will never be executed.


Unreachable code is most often the result of return, die or exit
statements that have been added for debug purposes.


function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}





In the above example, the last return false will never be executed, because
a return statement has already been met in every possible execution path.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    46
                

                                    
                             66                         
                
                
                
            case 413:

            


            
                                                        
            
                                    
            
            

                
                    47
                

                                    
                             3                         
                
                
                
                throw new InvalidCaptchaException;

            


            
                                                        
            
                                    
            
            

                
                    48
                

                                    
                                                    
                
                
                
                break;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
break; does not seem to be reachable.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for unreachable code. It uses sophisticated control flow analysis techniques to
find statements which will never be executed.


Unreachable code is most often the result of return, die or exit
statements that have been added for debug purposes.


function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}





In the above example, the last return false will never be executed, because
a return statement has already been met in every possible execution path.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    49
                

                                    
                             63                         
                
                
                
            case 500:

            


            
                                                        
            
                                    
            
            

                
                    50
                

                                    
                             3                         
                
                
                
                throw new InternalServiceException;

            


            
                                                        
            
                                    
            
            

                
                    51
                

                                    
                             60                         
                
                
                
            case 503:

            


            
                                                        
            
                                    
            
            

                
                    52
                

                                    
                             3                         
                
                
                
                throw new ServiceOverloadException;

            


            
                                                        
            
                                    
            
            

                
                    53
                

                                    
                                                    
                
                
                
                break;

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Unused Code
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
break; does not seem to be reachable.
                                                                                                

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for unreachable code. It uses sophisticated control flow analysis techniques to
find statements which will never be executed.


Unreachable code is most often the result of return, die or exit
statements that have been added for debug purposes.


function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}





In the above example, the last return false will never be executed, because
a return statement has already been met in every possible execution path.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    54
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    55
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    56
                

                                    
                                                    
                
                
                
        // Uma coisa básica é verificar o tipo do conteúdo

            


            
                                                        
            
                                    
            
            

                
                    57
                

                                    
                                                    
                
                
                
        // da resposta HTTP.

            


            
                                                        
            
                                    
            
            

                
                    58
                

                                    
                                                    
                
                
                
        // Parece a principio algo meio "desnecessário"

            


            
                                                        
            
                                    
            
            

                
                    59
                

                                    
                                                    
                
                
                
        // já que se a resposta for ok e for passado o

            


            
                                                        
            
                                    
            
            

                
                    60
                

                                    
                                                    
                
                
                
        // accept de json, técnicamente deverá retornar

            


            
                                                        
            
                                    
            
            

                
                    61
                

                                    
                                                    
                
                
                
        // o content type como json

            


            
                                                        
            
                                    
            
            

                
                    62
                

                                    
                                                    
                
                
                
        // mas... nunca se sabe, né?

            


            
                                                        
            
                                    
            
            

                
                    63
                

                                    
                             57                         
                
                
                
        if (($contentType !== $this->contentTypeOk) or (empty((string)$response->getBody()))) {

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Comprehensibility
            Best Practice
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
Using logical operators such as or instead of || is generally not recommended.
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
PHP has two types of connecting operators (logical operators, and boolean operators):


 
Logical Operators
Boolean Operator

AND - meaning
and
&&

OR - meaning
or
||

The difference between these is the order in which they are executed. In most cases,
you would want to use a boolean operator like &&, or ||.


Let’s take a look at a few examples:


// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);







Logical Operators are used for Control-Flow


One case where you explicitly want to use logical operators is for control-flow
such as this:


$x === 5
    or die('$x must be 5.');

// Instead of
if ($x !== 5) {
    die('$x must be 5.');
}





Since die introduces problems of its own, f.e. it makes our code hardly
testable, and prevents any kind of more sophisticated error handling; you probably
do not want to use this in real-world code. Unfortunately, logical operators
cannot be combined with throw at this point:


// The following is currently a parse error.
$x === 5
    or throw new RuntimeException('$x must be 5.');





These limitations lead to logical operators rarely being of use in current
PHP code.




                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    64
                

                                    
                             6                         
                
                
                
            throw new InvalidServiceResponseException;

            


            
                                                        
            
                                    
            
            

                
                    65
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    66
                

                                    
                             51                         
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    67
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    68