Completed
Push — develop ( dcf765...a9e6df )
by Léo
11s
created

BasicSeoConfigurator::getConfig()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 12
Code Lines 6

Duplication

Lines 12
Ratio 100 %

Importance

Changes 0
Metric Value
dl 12
loc 12
rs 9.4285
c 0
b 0
f 0
cc 3
eloc 6
nc 3
nop 1
1
<?php
2
3
namespace Leogout\Bundle\SeoBundle\Seo\Basic;
4
5
use Leogout\Bundle\SeoBundle\Seo\AbstractSeoConfigurator;
6
use Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator;
7
8
/**
9
 * Description of BasicSeoConfigurator.
10
 *
11
 * @author: leogout
12
 */
13
class BasicSeoConfigurator extends AbstractSeoConfigurator
14
{
15
    /**
16
     * @param AbstractSeoGenerator $generator
17
     */
18
    public function configure(AbstractSeoGenerator $generator)
19
    {
20
        if (null !== $title = $this->getConfig('title')) {
21
            $generator->setTitle($title);
22
        }
23
        if (null !== $description = $this->getConfig('description')) {
24
            $generator->setDescription($description);
25
        }
26
        if (null !== $keywords = $this->getConfig('keywords')) {
27
            $generator->setKeywords($keywords);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator as the method setKeywords() does only exist in the following sub-classes of Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator: Leogout\Bundle\SeoBundle...Basic\BasicSeoGenerator. 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...
28
        }
29
        if (null !== $robots = $this->getConfig('robots')) {
30
            $generator->setRobots($robots['index'], $robots['follow']);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator as the method setRobots() does only exist in the following sub-classes of Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator: Leogout\Bundle\SeoBundle...Basic\BasicSeoGenerator. 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...
31
        }
32
        if (null !== $canonical = $this->getConfig('canonical')) {
33
            $generator->setCanonical($canonical);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator as the method setCanonical() does only exist in the following sub-classes of Leogout\Bundle\SeoBundle\Seo\AbstractSeoGenerator: Leogout\Bundle\SeoBundle...Basic\BasicSeoGenerator. 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...
34
        }
35
    }
36
}
37