Internet::supportsParent()   A
last analyzed

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 1
1
<?php
2
3
namespace Knp\FriendlyContexts\Faker\Provider;
4
5
class Internet extends Base
6
{
7
    public function login()
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->userName();
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 userName() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\Internet, Faker\Provider\ar_JO\Internet, Faker\Provider\ar_SA\Internet, Faker\Provider\bg_BG\Internet, Faker\Provider\cs_CZ\Internet, Faker\Provider\da_DK\Internet, Faker\Provider\de_AT\Internet, Faker\Provider\de_CH\Internet, Faker\Provider\de_DE\Internet, Faker\Provider\en_AU\Internet, Faker\Provider\en_GB\Internet, Faker\Provider\en_IN\Internet, Faker\Provider\en_NZ\Internet, Faker\Provider\en_UG\Internet, Faker\Provider\en_ZA\Internet, Faker\Provider\es_ES\Internet, Faker\Provider\es_VE\Internet, Faker\Provider\fa_IR\Internet, Faker\Provider\fi_FI\Internet, Faker\Provider\fr_BE\Internet, Faker\Provider\fr_CH\Internet, Faker\Provider\fr_FR\Internet, Faker\Provider\hy_AM\Internet, Faker\Provider\id_ID\Internet, Faker\Provider\is_IS\Internet, Faker\Provider\it_CH\Internet, Faker\Provider\it_IT\Internet, Faker\Provider\ja_JP\Internet, Faker\Provider\ka_GE\Internet, Faker\Provider\kk_KZ\Internet, Faker\Provider\ko_KR\Internet, Faker\Provider\lt_LT\Internet, Faker\Provider\lv_LV\Internet, Faker\Provider\ne_NP\Internet, Faker\Provider\nl_BE\Internet, Faker\Provider\nl_NL\Internet, Faker\Provider\pl_PL\Internet, Faker\Provider\pt_BR\Internet, Faker\Provider\ru_RU\Internet, Faker\Provider\sk_SK\Internet, Faker\Provider\sl_SI\Internet, Faker\Provider\tr_TR\Internet, Faker\Provider\uk_UA\Internet, Faker\Provider\vi_VN\Internet, Faker\Provider\zh_CN\Internet, Faker\Provider\zh_TW\Internet. 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. 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.'
                );
            }
    
        }
    }
    
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();
    }
    
Loading history...
10
    }
11
12
    public function supportsParent($parent)
13
    {
14
        return $parent instanceOf \Faker\Provider\Internet;
15
    }
16
}
17