View GitHub Repository framework.php

Schedule Inspection
Subscribe
Completed
Push — master ( 5cc458...7cbfbf )
by Dmitry
03:21
created

GuzzleProvider::register()   A

↳ Parent: GuzzleProvider

Complexity

Conditions 3
Paths 1

Size

Total Lines 17

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 3.072

Importance

Changes 0
Metric Value
dl 0
loc 17
ccs 8
cts 10
cp 0.8
rs 9.7
c 0
b 0
f 0
cc 3
nc 1
nop 0
crap 3.072
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace Basis\Provider;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
use GuzzleHttp\Client;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
use League\Container\ServiceProvider\AbstractServiceProvider;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
class GuzzleProvider extends AbstractServiceProvider

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
    protected $provides = [

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                
        Client::class,

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
    ];

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
    public function register()

            


            
                                                        
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    16
                

                                    
                             1                         
                
                
                
        $this->getContainer()->share(Client::class, function () {

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a concrete implementation and not the interface Psr\Container\ContainerInterface as the method share() does only exist in the following implementations of said interface: Basis\Application, Basis\Test\Application, League\Container\Container.
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Let’s take a look at an example:


interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}





In the above example, the authenticate() method works fine as long as you just pass
instances of MyUser. However, if you now also want to pass a different implementation
of User which does not have a getDisplayName() method, the code will break.




Available Fixes


  1. Change the type-hint for the parameter:
    

    class AuthSystem
{
    public function authenticate(MyUser $user) { /* ... */ }
}

    

    

    2. 

  2. Add an additional type-check:
    

    class AuthSystem
{
    public function authenticate(User $user)
    {
        if ($user instanceof MyUser) {
            $this->logger->info(/** ... */);
        }

        // or alternatively
        if ( ! $user instanceof MyUser) {
            throw new \LogicException(
                '$user must be an instance of MyUser, '
               .'other instances are not supported.'
            );
        }

    }
}

    

    

    3. 




 Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.


  1. Add the method to the interface:
    

    interface User
{
    /** @return string */
    public function getPassword();

    /** @return string */
    public function getDisplayName();
}

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
            $headers = [

            


            
                                                        
            
                                    
            
            

                
                    18
                

                                    
                             1                         
                
                
                
                'transfer-encoding' => 'chunked',

            


            
                                                        
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
            ];

            


            
                                                        
            
                                    
            
            

                
                    20
                

                                    
                             1                         
                
                
                
            if (array_key_exists('HTTP_X_REAL_IP', $_SERVER)) {

            


            
                                                        
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
                $headers['x-real-ip'] = $_SERVER['HTTP_X_REAL_IP'];

            


            
                                                        
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
            }

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                             1                         
                
                
                
            if (array_key_exists('HTTP_X_SESSION', $_SERVER)) {

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
                $headers['x-session'] = $_SERVER['HTTP_X_SESSION'];

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
            }

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                             1                         
                
                
                
            return new Client([

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                             1                         
                
                
                
                'headers' => $headers

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                
            ]);

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                             1                         
                
                
                
        });

            


            
                                                        
            
                                    
            
            

                
                    30
                

                                    
                             1                         
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    32