Issues in DefaultTaxZoneProvider.php - All Issues - Inspection of "Merge pull request #4876 from lchrusciel/promotion..." - Sylius/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 308c33...4cc160 )

by Michał

created 2016-04-26 12:15 UTC

CoreBundle/Provider/DefaultTaxZoneProvider.php (1 issue)

Labels

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sylius\Bundle\CoreBundle\Provider;

use Sylius\Bundle\SettingsBundle\Model\SettingsInterface;
use Sylius\Component\Core\Provider\ZoneProviderInterface;

/**
 * @author Mateusz Zalewski <[email protected]>
 */
class DefaultTaxZoneProvider implements ZoneProviderInterface
{
    /**
     * @var SettingsInterface
     */
    private $settings;

    /**
     * @param SettingsInterface $settings
     */
    public function __construct(SettingsInterface $settings)
    {
        $this->settings = $settings;
    }

    /**
     * {@inheritdoc}
     */
    public function getZone()
    {
        return $this->settings->get('default_tax_zone');
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Bundle\CoreBundle\Provider;
13
14			use Sylius\Bundle\SettingsBundle\Model\SettingsInterface;
15			use Sylius\Component\Core\Provider\ZoneProviderInterface;
16
17			/**
18			* @author Mateusz Zalewski <[email protected]>
19			*/
20			class DefaultTaxZoneProvider implements ZoneProviderInterface
21			{
22			/**
23			* @var SettingsInterface
24			*/
25			private $settings;
26
27			/**
28			* @param SettingsInterface $settings
29			*/
30			public function __construct(SettingsInterface $settings)
31			{
32			$this->settings = $settings;
33			}
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function getZone()
39			{
40			return $this->settings->get('default_tax_zone');
			0 ignored issues – show Bug Best Practice introduced 2016-03-09 17:35 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return $this->settings->get('default_tax_zone');` (`string`) is incompatible with the return type declared by the interface `Sylius\Component\Core\Pr...viderInterface::getZone` of type `Sylius\Component\Address...odel\ZoneInterface\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
41			}
42			}
43

Sylius / Sylius

Push — master ( 308c33...4cc160 )

CoreBundle/Provider/DefaultTaxZoneProvider.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like