SecurityGroup::getAliases() - 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:28 UTC

SecurityGroup::getAliases() A

↳ Parent: SecurityGroup

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	0

<?php declare(strict_types=1);

namespace OpenStack\Networking\v2\Extensions\SecurityGroups\Models;

use OpenStack\Common\Resource\Alias;
use OpenStack\Common\Resource\OperatorResource;
use OpenStack\Common\Resource\Creatable;
use OpenStack\Common\Resource\Deletable;
use OpenStack\Common\Resource\Listable;
use OpenStack\Common\Resource\Retrievable;
use OpenStack\Common\Resource\Updateable;

/**
 * Represents a SecurityGroup resource in the Network v2 service
 *
 * @property \OpenStack\Networking\v2\Extensions\SecurityGroups\Api $api
 */
class SecurityGroup extends OperatorResource implements Creatable, Listable, Deletable, Retrievable, Updateable
{
    /**
     * @var string
     */
    public $description;

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

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

    /**
     * @var []SecurityGroupRule
     */
    public $securityGroupRules;

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

    protected $aliases = [
        'tenant_id' => 'tenantId',
    ];

    protected $resourceKey  = 'security_group';
    protected $resourcesKey = 'security_groups';

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

    /**
     * {@inheritDoc}
     */
    public function create(array $userOptions): Creatable
    {
        $response = $this->execute($this->api->postSecurityGroups(), $userOptions);
        return $this->populateFromResponse($response);
    }

    /**
     * {@inheritDoc}
     */
    public function delete()
    {
        $this->executeWithState($this->api->deleteSecurityGroup());
    }

    /**
     * {@inheritDoc}
     */
    public function retrieve()
    {
        $response = $this->executeWithState($this->api->getSecurityGroup());
        $this->populateFromResponse($response);
    }

    public function update()
    {
        $response = $this->executeWithState($this->api->putSecurityGroups());
        $this->populateFromResponse($response);
    }
}


1			<?php declare(strict_types=1);
2
3			namespace OpenStack\Networking\v2\Extensions\SecurityGroups\Models;
4
5			use OpenStack\Common\Resource\Alias;
6			use OpenStack\Common\Resource\OperatorResource;
7			use OpenStack\Common\Resource\Creatable;
8			use OpenStack\Common\Resource\Deletable;
9			use OpenStack\Common\Resource\Listable;
10			use OpenStack\Common\Resource\Retrievable;
11			use OpenStack\Common\Resource\Updateable;
12
13			/**
14			* Represents a SecurityGroup resource in the Network v2 service
15			*
16			* @property \OpenStack\Networking\v2\Extensions\SecurityGroups\Api $api
17			*/
18			class SecurityGroup extends OperatorResource implements Creatable, Listable, Deletable, Retrievable, Updateable
19			{
20			/**
21			* @var string
22			*/
23			public $description;
24
25			/**
26			* @var string
27			*/
28			public $id;
29
30			/**
31			* @var string
32			*/
33			public $name;
34
35			/**
36			* @var []SecurityGroupRule
37			*/
38			public $securityGroupRules;
39
40			/**
41			* @var string
42			*/
43			public $tenantId;
44
45			protected $aliases = [
46			'tenant_id' => 'tenantId',
47			];
48
49			protected $resourceKey = 'security_group';
50			protected $resourcesKey = 'security_groups';
51
52			/**
53			* @inheritdoc
54			*/
55			protected function getAliases()
56			{
57			$aliases = parent::getAliases();
58			$aliases['security_group_rules'] = new Alias('securityGroupRules', SecurityGroupRule::class, true);
59			$aliases['rules'] = new Alias('securityGroupRules', SecurityGroupRule::class, true);
60			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...
61			}
62
63			/**
64			* {@inheritDoc}
65			*/
66			public function create(array $userOptions): Creatable
67			{
68			$response = $this->execute($this->api->postSecurityGroups(), $userOptions);
69			return $this->populateFromResponse($response);
70			}
71
72			/**
73			* {@inheritDoc}
74			*/
75			public function delete()
76			{
77			$this->executeWithState($this->api->deleteSecurityGroup());
78			}
79
80			/**
81			* {@inheritDoc}
82			*/
83			public function retrieve()
84			{
85			$response = $this->executeWithState($this->api->getSecurityGroup());
86			$this->populateFromResponse($response);
87			}
88
89			public function update()
90			{
91			$response = $this->executeWithState($this->api->putSecurityGroups());
92			$this->populateFromResponse($response);
93			}
94			}
95

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#159)

SecurityGroup::getAliases() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like