Entry - Code Metrics - Inspection of "Removed usage of docblocks, fixed several parsing..." - php-opencloud/openstack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#159)

by Roman

created 2017-10-20 07:38 UTC

Entry A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	7
lcom	2
cbo	2
dl	0
loc	58
ccs	8
cts	8
cp	1
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	getAliases()	6	1
A	matches()	4	2
A	getEndpointUrl()	10	4

<?php declare(strict_types=1);

namespace OpenStack\Identity\v2\Models;

use OpenStack\Common\Resource\Alias;
use OpenStack\Common\Resource\OperatorResource;

/**
 * Represents an Identity v2 Catalog Entry.
 *
 * @package OpenStack\Identity\v2\Models
 */
class Entry extends OperatorResource
{
    /** @var string */
    public $name;

    /** @var string */
    public $type;

    /** @var []Endpoint */
    public $endpoints = [];

    /**
     * @var array
     */
    protected $aliases = [];

    /**
     * @inheritdoc
     */
    protected function getAliases()
    {
        $aliases = parent::getAliases();
        $aliases['endpoints'] = new Alias('endpoints', Endpoint::class, true);
        return $aliases;
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());
}
    }

    /**
     * Indicates whether this catalog entry matches a certain name and type.
     *
     * @param string $name
     * @param string $type
     *
     * @return bool TRUE if it's a match, FALSE if not
     */
    public function matches(string $name, string $type): bool
    {
        return $this->name == $name && $this->type == $type;
    }

    /**
     * Retrieves the catalog entry's URL according to a specific region and URL type
     *
     * @param string $region
     * @param string $urlType
     *
     * @return string
     */
    public function getEndpointUrl(string $region, string $urlType): string
    {
        foreach ($this->endpoints as $endpoint) {
            if ($endpoint->supportsRegion($region) && $endpoint->supportsUrlType($urlType)) {
                return $endpoint->getUrl($urlType);
            }
        }

        return "";
    }
}


1		<?php declare(strict_types=1);
2
3		namespace OpenStack\Identity\v2\Models;
4
5		use OpenStack\Common\Resource\Alias;
6		use OpenStack\Common\Resource\OperatorResource;
7
8		/**
9		* Represents an Identity v2 Catalog Entry.
10		*
11		* @package OpenStack\Identity\v2\Models
12		*/
13		class Entry extends OperatorResource
14		{
15		/** @var string */
16		public $name;
17
18		/** @var string */
19		public $type;
20
21		/** @var []Endpoint */
22		public $endpoints = [];
23
24		/**
25		* @var array
26		*/
27		protected $aliases = [];
28
29		/**
30		* @inheritdoc
31	1	*/
32		protected function getAliases()
33	1	{
34		$aliases = parent::getAliases();
35		$aliases['endpoints'] = new Alias('endpoints', Endpoint::class, true);
36		return $aliases;
		0 ignored issues – show Bug Best Practice introduced 2017-10-20 07:30 UTC by Report Bug Copy Issue Report The return type of `return $aliases;` (`array<,OpenStack\Common\Resource\Alias>`) is incompatible with the return type of the parent method `OpenStack\Common\Resourc...actResource::getAliases` of type `OpenStack\Common\Resource\Alias[]`. 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...
37		}
38
39		/**
40		* Indicates whether this catalog entry matches a certain name and type.
41		*
42		* @param string $name
43		* @param string $type
44	2	*
45		* @return bool TRUE if it's a match, FALSE if not
46	2	*/
47	1	public function matches(string $name, string $type): bool
48	1	{
49		return $this->name == $name && $this->type == $type;
50	1	}
51
52	1	/**
53		* Retrieves the catalog entry's URL according to a specific region and URL type
54		*
55		* @param string $region
56		* @param string $urlType
57		*
58		* @return string
59		*/
60		public function getEndpointUrl(string $region, string $urlType): string
61		{
62		foreach ($this->endpoints as $endpoint) {
63		if ($endpoint->supportsRegion($region) && $endpoint->supportsUrlType($urlType)) {
64		return $endpoint->getUrl($urlType);
65		}
66		}
67
68		return "";
69		}
70		}
71

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#159)

Entry A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

3 Methods

Duplication Side-by-Side

Filter issues like