View GitHub Repository FriendlyContexts

Schedule Inspection
Subscribe

PhoneNumber::phone()   A
last analyzed

↳ Parent: PhoneNumber

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1 
<?php
2 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    3
                

                                    
                                                    
                
                
                
namespace Knp\FriendlyContexts\Faker\Provider;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    4
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
class PhoneNumber extends Base

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                
{

            


            
                                                                        
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
    public function phone()

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Documentation
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The return type could not be reliably inferred; please add a @return annotation.
                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Our type inference engine in quite powerful, but sometimes the code does not
provide enough clues to go by. In these cases we request you to add a @return
annotation as described here.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                        
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
    {

            


            
                                                                        
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
        return $this->parent->phoneNumber();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a specific sub-type and not the parent class Faker\Provider\Base as the method phoneNumber() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\PhoneNumber, Faker\Provider\bg_BG\PhoneNumber, Faker\Provider\bn_BD\PhoneNumber, Faker\Provider\cs_CZ\PhoneNumber, Faker\Provider\da_DK\PhoneNumber, Faker\Provider\de_AT\PhoneNumber, Faker\Provider\de_CH\PhoneNumber, Faker\Provider\de_DE\PhoneNumber, Faker\Provider\el_GR\PhoneNumber, Faker\Provider\en_AU\PhoneNumber, Faker\Provider\en_CA\PhoneNumber, Faker\Provider\en_GB\PhoneNumber, Faker\Provider\en_IN\PhoneNumber, Faker\Provider\en_NZ\PhoneNumber, Faker\Provider\en_PH\PhoneNumber, Faker\Provider\en_SG\PhoneNumber, Faker\Provider\en_UG\PhoneNumber, Faker\Provider\en_US\PhoneNumber, Faker\Provider\en_ZA\PhoneNumber, Faker\Provider\es_AR\PhoneNumber, Faker\Provider\es_ES\PhoneNumber, Faker\Provider\es_PE\PhoneNumber, Faker\Provider\es_VE\PhoneNumber, Faker\Provider\fa_IR\PhoneNumber, Faker\Provider\fi_FI\PhoneNumber, Faker\Provider\fr_BE\PhoneNumber, Faker\Provider\fr_CH\PhoneNumber, Faker\Provider\fr_FR\PhoneNumber, Faker\Provider\he_IL\PhoneNumber, Faker\Provider\hr_HR\PhoneNumber, Faker\Provider\hu_HU\PhoneNumber, Faker\Provider\hy_AM\PhoneNumber, Faker\Provider\id_ID\PhoneNumber, Faker\Provider\is_IS\PhoneNumber, Faker\Provider\it_CH\PhoneNumber, Faker\Provider\it_IT\PhoneNumber, Faker\Provider\ja_JP\PhoneNumber, Faker\Provider\ka_GE\PhoneNumber, Faker\Provider\kk_KZ\PhoneNumber, Faker\Provider\ko_KR\PhoneNumber, Faker\Provider\lt_LT\PhoneNumber, Faker\Provider\lv_LV\PhoneNumber, Faker\Provider\me_ME\PhoneNumber, Faker\Provider\mn_MN\PhoneNumber, Faker\Provider\nb_NO\PhoneNumber, Faker\Provider\ne_NP\PhoneNumber, Faker\Provider\nl_BE\PhoneNumber, Faker\Provider\nl_NL\PhoneNumber, Faker\Provider\pl_PL\PhoneNumber, Faker\Provider\pt_BR\PhoneNumber, Faker\Provider\pt_PT\PhoneNumber, Faker\Provider\ro_MD\PhoneNumber, Faker\Provider\ro_RO\PhoneNumber, Faker\Provider\ru_RU\PhoneNumber, Faker\Provider\sk_SK\PhoneNumber, Faker\Provider\sl_SI\PhoneNumber, Faker\Provider\sv_SE\PhoneNumber, Faker\Provider\tr_TR\PhoneNumber, Faker\Provider\uk_UA\PhoneNumber, Faker\Provider\vi_VN\PhoneNumber, Faker\Provider\zh_CN\PhoneNumber, Faker\Provider\zh_TW\PhoneNumber. Maybe you want to instanceof check for one of these explicitly?
                                                                                                                                                                                                                                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Let’s take a look at an example:


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

class MyUser extends 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 sub-classes
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 parent class:
    

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

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

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                        
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                
    public function fax()

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Documentation
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The return type could not be reliably inferred; please add a @return annotation.
                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Our type inference engine in quite powerful, but sometimes the code does not
provide enough clues to go by. In these cases we request you to add a @return
annotation as described here.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                
        return $this->parent->phoneNumber();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a specific sub-type and not the parent class Faker\Provider\Base as the method phoneNumber() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\PhoneNumber, Faker\Provider\bg_BG\PhoneNumber, Faker\Provider\bn_BD\PhoneNumber, Faker\Provider\cs_CZ\PhoneNumber, Faker\Provider\da_DK\PhoneNumber, Faker\Provider\de_AT\PhoneNumber, Faker\Provider\de_CH\PhoneNumber, Faker\Provider\de_DE\PhoneNumber, Faker\Provider\el_GR\PhoneNumber, Faker\Provider\en_AU\PhoneNumber, Faker\Provider\en_CA\PhoneNumber, Faker\Provider\en_GB\PhoneNumber, Faker\Provider\en_IN\PhoneNumber, Faker\Provider\en_NZ\PhoneNumber, Faker\Provider\en_PH\PhoneNumber, Faker\Provider\en_SG\PhoneNumber, Faker\Provider\en_UG\PhoneNumber, Faker\Provider\en_US\PhoneNumber, Faker\Provider\en_ZA\PhoneNumber, Faker\Provider\es_AR\PhoneNumber, Faker\Provider\es_ES\PhoneNumber, Faker\Provider\es_PE\PhoneNumber, Faker\Provider\es_VE\PhoneNumber, Faker\Provider\fa_IR\PhoneNumber, Faker\Provider\fi_FI\PhoneNumber, Faker\Provider\fr_BE\PhoneNumber, Faker\Provider\fr_CH\PhoneNumber, Faker\Provider\fr_FR\PhoneNumber, Faker\Provider\he_IL\PhoneNumber, Faker\Provider\hr_HR\PhoneNumber, Faker\Provider\hu_HU\PhoneNumber, Faker\Provider\hy_AM\PhoneNumber, Faker\Provider\id_ID\PhoneNumber, Faker\Provider\is_IS\PhoneNumber, Faker\Provider\it_CH\PhoneNumber, Faker\Provider\it_IT\PhoneNumber, Faker\Provider\ja_JP\PhoneNumber, Faker\Provider\ka_GE\PhoneNumber, Faker\Provider\kk_KZ\PhoneNumber, Faker\Provider\ko_KR\PhoneNumber, Faker\Provider\lt_LT\PhoneNumber, Faker\Provider\lv_LV\PhoneNumber, Faker\Provider\me_ME\PhoneNumber, Faker\Provider\mn_MN\PhoneNumber, Faker\Provider\nb_NO\PhoneNumber, Faker\Provider\ne_NP\PhoneNumber, Faker\Provider\nl_BE\PhoneNumber, Faker\Provider\nl_NL\PhoneNumber, Faker\Provider\pl_PL\PhoneNumber, Faker\Provider\pt_BR\PhoneNumber, Faker\Provider\pt_PT\PhoneNumber, Faker\Provider\ro_MD\PhoneNumber, Faker\Provider\ro_RO\PhoneNumber, Faker\Provider\ru_RU\PhoneNumber, Faker\Provider\sk_SK\PhoneNumber, Faker\Provider\sl_SI\PhoneNumber, Faker\Provider\sv_SE\PhoneNumber, Faker\Provider\tr_TR\PhoneNumber, Faker\Provider\uk_UA\PhoneNumber, Faker\Provider\vi_VN\PhoneNumber, Faker\Provider\zh_CN\PhoneNumber, Faker\Provider\zh_TW\PhoneNumber. Maybe you want to instanceof check for one of these explicitly?
                                                                                                                                                                                                                                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Let’s take a look at an example:


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

class MyUser extends 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 sub-classes
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 parent class:
    

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

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

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                
    public function mobile()

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Documentation
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
The return type could not be reliably inferred; please add a @return annotation.
                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Our type inference engine in quite powerful, but sometimes the code does not
provide enough clues to go by. In these cases we request you to add a @return
annotation as described here.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    19
                

                                    
                                                    
                
                
                
        return $this->parent->phoneNumber();

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you code against a specific sub-type and not the parent class Faker\Provider\Base as the method phoneNumber() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\PhoneNumber, Faker\Provider\bg_BG\PhoneNumber, Faker\Provider\bn_BD\PhoneNumber, Faker\Provider\cs_CZ\PhoneNumber, Faker\Provider\da_DK\PhoneNumber, Faker\Provider\de_AT\PhoneNumber, Faker\Provider\de_CH\PhoneNumber, Faker\Provider\de_DE\PhoneNumber, Faker\Provider\el_GR\PhoneNumber, Faker\Provider\en_AU\PhoneNumber, Faker\Provider\en_CA\PhoneNumber, Faker\Provider\en_GB\PhoneNumber, Faker\Provider\en_IN\PhoneNumber, Faker\Provider\en_NZ\PhoneNumber, Faker\Provider\en_PH\PhoneNumber, Faker\Provider\en_SG\PhoneNumber, Faker\Provider\en_UG\PhoneNumber, Faker\Provider\en_US\PhoneNumber, Faker\Provider\en_ZA\PhoneNumber, Faker\Provider\es_AR\PhoneNumber, Faker\Provider\es_ES\PhoneNumber, Faker\Provider\es_PE\PhoneNumber, Faker\Provider\es_VE\PhoneNumber, Faker\Provider\fa_IR\PhoneNumber, Faker\Provider\fi_FI\PhoneNumber, Faker\Provider\fr_BE\PhoneNumber, Faker\Provider\fr_CH\PhoneNumber, Faker\Provider\fr_FR\PhoneNumber, Faker\Provider\he_IL\PhoneNumber, Faker\Provider\hr_HR\PhoneNumber, Faker\Provider\hu_HU\PhoneNumber, Faker\Provider\hy_AM\PhoneNumber, Faker\Provider\id_ID\PhoneNumber, Faker\Provider\is_IS\PhoneNumber, Faker\Provider\it_CH\PhoneNumber, Faker\Provider\it_IT\PhoneNumber, Faker\Provider\ja_JP\PhoneNumber, Faker\Provider\ka_GE\PhoneNumber, Faker\Provider\kk_KZ\PhoneNumber, Faker\Provider\ko_KR\PhoneNumber, Faker\Provider\lt_LT\PhoneNumber, Faker\Provider\lv_LV\PhoneNumber, Faker\Provider\me_ME\PhoneNumber, Faker\Provider\mn_MN\PhoneNumber, Faker\Provider\nb_NO\PhoneNumber, Faker\Provider\ne_NP\PhoneNumber, Faker\Provider\nl_BE\PhoneNumber, Faker\Provider\nl_NL\PhoneNumber, Faker\Provider\pl_PL\PhoneNumber, Faker\Provider\pt_BR\PhoneNumber, Faker\Provider\pt_PT\PhoneNumber, Faker\Provider\ro_MD\PhoneNumber, Faker\Provider\ro_RO\PhoneNumber, Faker\Provider\ru_RU\PhoneNumber, Faker\Provider\sk_SK\PhoneNumber, Faker\Provider\sl_SI\PhoneNumber, Faker\Provider\sv_SE\PhoneNumber, Faker\Provider\tr_TR\PhoneNumber, Faker\Provider\uk_UA\PhoneNumber, Faker\Provider\vi_VN\PhoneNumber, Faker\Provider\zh_CN\PhoneNumber, Faker\Provider\zh_TW\PhoneNumber. Maybe you want to instanceof check for one of these explicitly?
                                                                                                                                                                                                                                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
Let’s take a look at an example:


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

class MyUser extends 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 sub-classes
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 parent class:
    

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

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

    

    

    2. 



                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
    public function supportsParent($parent)

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    23
                

                                    
                                                    
                
                
                
    {

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    24
                

                                    
                                                    
                
                
                
        return $parent instanceOf \Faker\Provider\PhoneNumber;

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                
    }

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    26
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    27