Address   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 22
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 1

Importance

Changes 0
Metric Value
wmc 4
lcom 1
cbo 1
dl 0
loc 22
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A address1() 0 4 1
A postalcode() 0 4 1
A zipcode() 0 4 1
A supportsParent() 0 4 1
1
<?php
2
3
namespace Knp\FriendlyContexts\Faker\Provider;
4
5
class Address extends Base
6
{
7
    public function address1()
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->streetAddress();
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 streetAddress() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\Address, Faker\Provider\ar_JO\Address, Faker\Provider\ar_SA\Address, Faker\Provider\bn_BD\Address, Faker\Provider\cs_CZ\Address, Faker\Provider\da_DK\Address, Faker\Provider\de_AT\Address, Faker\Provider\de_CH\Address, Faker\Provider\de_DE\Address, Faker\Provider\el_GR\Address, Faker\Provider\en_AU\Address, Faker\Provider\en_CA\Address, Faker\Provider\en_GB\Address, Faker\Provider\en_IN\Address, Faker\Provider\en_NZ\Address, Faker\Provider\en_PH\Address, Faker\Provider\en_SG\Address, Faker\Provider\en_UG\Address, Faker\Provider\en_US\Address, Faker\Provider\en_ZA\Address, Faker\Provider\es_AR\Address, Faker\Provider\es_ES\Address, Faker\Provider\es_PE\Address, Faker\Provider\es_VE\Address, Faker\Provider\fi_FI\Address, Faker\Provider\fr_BE\Address, Faker\Provider\fr_CA\Address, Faker\Provider\fr_CH\Address, Faker\Provider\fr_FR\Address, Faker\Provider\he_IL\Address, Faker\Provider\hr_HR\Address, Faker\Provider\hu_HU\Address, Faker\Provider\hy_AM\Address, Faker\Provider\id_ID\Address, Faker\Provider\is_IS\Address, Faker\Provider\it_CH\Address, Faker\Provider\it_IT\Address, Faker\Provider\ja_JP\Address, Faker\Provider\ka_GE\Address, Faker\Provider\kk_KZ\Address, Faker\Provider\ko_KR\Address, Faker\Provider\lt_LT\Address, Faker\Provider\lv_LV\Address, Faker\Provider\me_ME\Address, Faker\Provider\nb_NO\Address, Faker\Provider\ne_NP\Address, Faker\Provider\nl_BE\Address, Faker\Provider\nl_NL\Address, Faker\Provider\pl_PL\Address, Faker\Provider\pt_BR\Address, Faker\Provider\pt_PT\Address, Faker\Provider\ro_MD\Address, Faker\Provider\ro_RO\Address, Faker\Provider\ru_RU\Address, Faker\Provider\sk_SK\Address, Faker\Provider\sl_SI\Address, Faker\Provider\sr_Cyrl_RS\Address, Faker\Provider\sr_Latn_RS\Address, Faker\Provider\sr_RS\Address, Faker\Provider\sv_SE\Address, Faker\Provider\tr_TR\Address, Faker\Provider\uk_UA\Address, Faker\Provider\vi_VN\Address, Faker\Provider\zh_CN\Address, Faker\Provider\zh_TW\Address. 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 postalcode()
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->postcode();
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 postcode() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\Address, Faker\Provider\ar_JO\Address, Faker\Provider\ar_SA\Address, Faker\Provider\bn_BD\Address, Faker\Provider\cs_CZ\Address, Faker\Provider\da_DK\Address, Faker\Provider\de_AT\Address, Faker\Provider\de_CH\Address, Faker\Provider\de_DE\Address, Faker\Provider\el_GR\Address, Faker\Provider\en_AU\Address, Faker\Provider\en_CA\Address, Faker\Provider\en_GB\Address, Faker\Provider\en_IN\Address, Faker\Provider\en_NZ\Address, Faker\Provider\en_PH\Address, Faker\Provider\en_SG\Address, Faker\Provider\en_UG\Address, Faker\Provider\en_US\Address, Faker\Provider\en_ZA\Address, Faker\Provider\es_AR\Address, Faker\Provider\es_ES\Address, Faker\Provider\es_PE\Address, Faker\Provider\es_VE\Address, Faker\Provider\fi_FI\Address, Faker\Provider\fr_BE\Address, Faker\Provider\fr_CA\Address, Faker\Provider\fr_CH\Address, Faker\Provider\fr_FR\Address, Faker\Provider\he_IL\Address, Faker\Provider\hr_HR\Address, Faker\Provider\hu_HU\Address, Faker\Provider\hy_AM\Address, Faker\Provider\id_ID\Address, Faker\Provider\is_IS\Address, Faker\Provider\it_CH\Address, Faker\Provider\it_IT\Address, Faker\Provider\ja_JP\Address, Faker\Provider\ka_GE\Address, Faker\Provider\kk_KZ\Address, Faker\Provider\ko_KR\Address, Faker\Provider\lt_LT\Address, Faker\Provider\lv_LV\Address, Faker\Provider\me_ME\Address, Faker\Provider\nb_NO\Address, Faker\Provider\ne_NP\Address, Faker\Provider\nl_BE\Address, Faker\Provider\nl_NL\Address, Faker\Provider\pl_PL\Address, Faker\Provider\pt_BR\Address, Faker\Provider\pt_PT\Address, Faker\Provider\ro_MD\Address, Faker\Provider\ro_RO\Address, Faker\Provider\ru_RU\Address, Faker\Provider\sk_SK\Address, Faker\Provider\sl_SI\Address, Faker\Provider\sr_Cyrl_RS\Address, Faker\Provider\sr_Latn_RS\Address, Faker\Provider\sr_RS\Address, Faker\Provider\sv_SE\Address, Faker\Provider\tr_TR\Address, Faker\Provider\uk_UA\Address, Faker\Provider\vi_VN\Address, Faker\Provider\zh_CN\Address, Faker\Provider\zh_TW\Address. 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...
15
    }
16
17
    public function zipcode()
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->postcode();
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 postcode() does only exist in the following sub-classes of Faker\Provider\Base: Faker\Provider\Address, Faker\Provider\ar_JO\Address, Faker\Provider\ar_SA\Address, Faker\Provider\bn_BD\Address, Faker\Provider\cs_CZ\Address, Faker\Provider\da_DK\Address, Faker\Provider\de_AT\Address, Faker\Provider\de_CH\Address, Faker\Provider\de_DE\Address, Faker\Provider\el_GR\Address, Faker\Provider\en_AU\Address, Faker\Provider\en_CA\Address, Faker\Provider\en_GB\Address, Faker\Provider\en_IN\Address, Faker\Provider\en_NZ\Address, Faker\Provider\en_PH\Address, Faker\Provider\en_SG\Address, Faker\Provider\en_UG\Address, Faker\Provider\en_US\Address, Faker\Provider\en_ZA\Address, Faker\Provider\es_AR\Address, Faker\Provider\es_ES\Address, Faker\Provider\es_PE\Address, Faker\Provider\es_VE\Address, Faker\Provider\fi_FI\Address, Faker\Provider\fr_BE\Address, Faker\Provider\fr_CA\Address, Faker\Provider\fr_CH\Address, Faker\Provider\fr_FR\Address, Faker\Provider\he_IL\Address, Faker\Provider\hr_HR\Address, Faker\Provider\hu_HU\Address, Faker\Provider\hy_AM\Address, Faker\Provider\id_ID\Address, Faker\Provider\is_IS\Address, Faker\Provider\it_CH\Address, Faker\Provider\it_IT\Address, Faker\Provider\ja_JP\Address, Faker\Provider\ka_GE\Address, Faker\Provider\kk_KZ\Address, Faker\Provider\ko_KR\Address, Faker\Provider\lt_LT\Address, Faker\Provider\lv_LV\Address, Faker\Provider\me_ME\Address, Faker\Provider\nb_NO\Address, Faker\Provider\ne_NP\Address, Faker\Provider\nl_BE\Address, Faker\Provider\nl_NL\Address, Faker\Provider\pl_PL\Address, Faker\Provider\pt_BR\Address, Faker\Provider\pt_PT\Address, Faker\Provider\ro_MD\Address, Faker\Provider\ro_RO\Address, Faker\Provider\ru_RU\Address, Faker\Provider\sk_SK\Address, Faker\Provider\sl_SI\Address, Faker\Provider\sr_Cyrl_RS\Address, Faker\Provider\sr_Latn_RS\Address, Faker\Provider\sr_RS\Address, Faker\Provider\sv_SE\Address, Faker\Provider\tr_TR\Address, Faker\Provider\uk_UA\Address, Faker\Provider\vi_VN\Address, Faker\Provider\zh_CN\Address, Faker\Provider\zh_TW\Address. 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...
20
    }
21
22
    public function supportsParent($parent)
23
    {
24
        return $parent instanceOf \Faker\Provider\Address;
25
    }
26
}
27