LoadbalancerPool - Code Metrics - Inspection of "Add LBAAS API Support" - php-opencloud/openstack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#136)

by Frank

created 2017-07-21 15:52 UTC

LoadbalancerPool A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	1
dl	0
loc	148
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	create()	5	1
A	retrieve()	5	1
A	update()	5	1
A	delete()	4	1
A	addMember()	5	1
A	getMember()	4	1
A	deleteMember()	4	1
A	addHealthmonitor()	5	1

<?php declare(strict_types=1);

namespace OpenStack\Networking\v2\Models;

use OpenStack\Common\Resource\Creatable;
use OpenStack\Common\Resource\Deletable;
use OpenStack\Common\Resource\OperatorResource;
use OpenStack\Common\Resource\Retrievable;
use OpenStack\Common\Resource\Updateable;
use OpenStack\Networking\v2\Api;

/**
 * Represents a Neutron v2 Loadbalancer pool
 *
 * @property Api $api
 */
class LoadbalancerPool extends OperatorResource implements Creatable, Retrievable, Updateable, Deletable
{
    /**
     * @var string
     */
    public $name;

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

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

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

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

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

    /**
     * @var array
     */
    public $sessionPersistence;

    /**
     * @var boolean
     */
    public $adminStateUp;

    /**
     * @var []LoadbalancerListener
     */
    public $listeners;

    /**
     * @var []LoadbalancerMember
     */
    public $members;

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

    protected $resourcesKey = 'pools';
    protected $resourceKey = 'pool';

    protected $aliases = [
        'tenant_id'           => 'tenantId',
        'admin_state_up'      => 'adminStateUp',
        'lb_algorithm'        => 'lbAlgorithm',
        'session_persistence' => 'sessionPersistence',
        'healthmonitor_id'    => 'healthmonitorId',
        'loadbalancer_id'     => 'loadbalancerId'
    ];

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

    /**
     * {@inheritDoc}
     */
    public function retrieve()
    {
        $response = $this->execute($this->api->getLoadbalancerPool(), ['id' => (string)$this->id]);
        $this->populateFromResponse($response);
    }

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

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

    /**
     * Add a member to this pool
     *
     * @param array $userOptions
     */
    public function addMember(array $userOptions = []): LoadbalancerMember
    {
        $userOptions = array_merge(['poolId' => $this->id], $userOptions);
        return $this->model(LoadbalancerMember::class)->create($userOptions);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }

    /**
     * Get an instance of a member
     *
     * @param string $member_id
     * @return LoadbalancerMember
     */
    public function getMember(string $member_id): LoadbalancerMember
    {
        return $this->model(LoadbalancerMember::class, ['poolId' => $this->id, 'id' => $member_id]);
    }

    /**
     * Delete a member
     *
     * @param string $member_id
     */
    public function deleteMember(string $member_id)
    {
        $this->model(LoadbalancerMember::class, ['poolId' => $this->id, 'id' => $member_id])->delete();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }

    /**
     * Add a healthmonitor to this load balancer pool
     *
     * @param array $userOptions
     * @return LoadbalancerHealthmonitor
     */
    public function addHealthmonitor(array $userOptions = []): LoadbalancerHealthmonitor
    {
        $userOptions = array_merge(['poolId' => $this->id], $userOptions);
        return $this->model(LoadbalancerHealthmonitor::class)->create($userOptions);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }
}


1			<?php declare(strict_types=1);
2
3			namespace OpenStack\Networking\v2\Models;
4
5			use OpenStack\Common\Resource\Creatable;
6			use OpenStack\Common\Resource\Deletable;
7			use OpenStack\Common\Resource\OperatorResource;
8			use OpenStack\Common\Resource\Retrievable;
9			use OpenStack\Common\Resource\Updateable;
10			use OpenStack\Networking\v2\Api;
11
12			/**
13			* Represents a Neutron v2 Loadbalancer pool
14			*
15			* @property Api $api
16			*/
17			class LoadbalancerPool extends OperatorResource implements Creatable, Retrievable, Updateable, Deletable
18			{
19			/**
20			* @var string
21			*/
22			public $name;
23
24			/**
25			* @var string
26			*/
27			public $description;
28
29			/**
30			* @var string
31			*/
32			public $id;
33
34			/**
35			* @var string
36			*/
37			public $tenantId;
38
39			/**
40			* @var string
41			*/
42			public $protocol;
43
44			/**
45			* @var string
46			*/
47			public $lbAlgorithm;
48
49			/**
50			* @var array
51			*/
52			public $sessionPersistence;
53
54			/**
55			* @var boolean
56			*/
57			public $adminStateUp;
58
59			/**
60			* @var []LoadbalancerListener
61			*/
62			public $listeners;
63
64			/**
65			* @var []LoadbalancerMember
66			*/
67			public $members;
68
69			/**
70			* @var string
71			*/
72			public $healthmonitorId;
73
74			protected $resourcesKey = 'pools';
75			protected $resourceKey = 'pool';
76
77			protected $aliases = [
78			'tenant_id' => 'tenantId',
79			'admin_state_up' => 'adminStateUp',
80			'lb_algorithm' => 'lbAlgorithm',
81			'session_persistence' => 'sessionPersistence',
82			'healthmonitor_id' => 'healthmonitorId',
83			'loadbalancer_id' => 'loadbalancerId'
84			];
85
86			/**
87			* {@inheritDoc}
88			*/
89			public function create(array $userOptions): Creatable
90			{
91			$response = $this->execute($this->api->postLoadbalancerPool(), $userOptions);
92			return $this->populateFromResponse($response);
93			}
94
95			/**
96			* {@inheritDoc}
97			*/
98			public function retrieve()
99			{
100			$response = $this->execute($this->api->getLoadbalancerPool(), ['id' => (string)$this->id]);
101			$this->populateFromResponse($response);
102			}
103
104			/**
105			* {@inheritDoc}
106			*/
107			public function update()
108			{
109			$response = $this->executeWithState($this->api->putLoadbalancerPool());
110			$this->populateFromResponse($response);
111			}
112
113			/**
114			* {@inheritDoc}
115			*/
116			public function delete()
117			{
118			$this->executeWithState($this->api->deleteLoadbalancerPool());
119			}
120
121			/**
122			* Add a member to this pool
123			*
124			* @param array $userOptions
125			*/
126			public function addMember(array $userOptions = []): LoadbalancerMember
127			{
128			$userOptions = array_merge(['poolId' => $this->id], $userOptions);
129			return $this->model(LoadbalancerMember::class)->create($userOptions);
			0 ignored issues – show Bug introduced 2017-07-21 15:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OpenStack\Common\Resource\ResourceInterface` as the method `create()` does only exist in the following implementations of said interface: `OpenStack\BlockStorage\v2\Models\Snapshot`, `OpenStack\BlockStorage\v2\Models\Volume`, `OpenStack\BlockStorage\v2\Models\VolumeType`, `OpenStack\Compute\v2\Models\Flavor`, `OpenStack\Compute\v2\Models\Keypair`, `OpenStack\Compute\v2\Models\Server`, `OpenStack\Identity\v3\Models\Credential`, `OpenStack\Identity\v3\Models\Domain`, `OpenStack\Identity\v3\Models\Endpoint`, `OpenStack\Identity\v3\Models\Group`, `OpenStack\Identity\v3\Models\Policy`, `OpenStack\Identity\v3\Models\Project`, `OpenStack\Identity\v3\Models\Role`, `OpenStack\Identity\v3\Models\Service`, `OpenStack\Identity\v3\Models\Token`, `OpenStack\Identity\v3\Models\User`, `OpenStack\Images\v2\Models\Image`, `OpenStack\Images\v2\Models\Member`, `OpenStack\Networking\v2\...ayer3\Models\FloatingIp`, `OpenStack\Networking\v2\...ns\Layer3\Models\Router`, `OpenStack\Networking\v2\...ps\Models\SecurityGroup`, `OpenStack\Networking\v2\...odels\SecurityGroupRule`, `OpenStack\Networking\v2\Models\Loadbalancer`, `OpenStack\Networking\v2\...adbalancerHealthmonitor`, `OpenStack\Networking\v2\...ls\LoadbalancerListener`, `OpenStack\Networking\v2\Models\LoadbalancerMember`, `OpenStack\Networking\v2\Models\LoadbalancerPool`, `OpenStack\Networking\v2\Models\Network`, `OpenStack\Networking\v2\Models\Port`, `OpenStack\Networking\v2\Models\Subnet`, `OpenStack\ObjectStore\v1\Models\Container`, `OpenStack\ObjectStore\v1\Models\Object`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
130			}
131
132			/**
133			* Get an instance of a member
134			*
135			* @param string $member_id
136			* @return LoadbalancerMember
137			*/
138			public function getMember(string $member_id): LoadbalancerMember
139			{
140			return $this->model(LoadbalancerMember::class, ['poolId' => $this->id, 'id' => $member_id]);
141			}
142
143			/**
144			* Delete a member
145			*
146			* @param string $member_id
147			*/
148			public function deleteMember(string $member_id)
149			{
150			$this->model(LoadbalancerMember::class, ['poolId' => $this->id, 'id' => $member_id])->delete();
			0 ignored issues – show Bug introduced 2017-07-21 15:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OpenStack\Common\Resource\ResourceInterface` as the method `delete()` does only exist in the following implementations of said interface: `OpenStack\BlockStorage\v2\Models\QuotaSet`, `OpenStack\BlockStorage\v2\Models\Snapshot`, `OpenStack\BlockStorage\v2\Models\Volume`, `OpenStack\BlockStorage\v2\Models\VolumeType`, `OpenStack\Compute\v2\Models\Flavor`, `OpenStack\Compute\v2\Models\Image`, `OpenStack\Compute\v2\Models\Keypair`, `OpenStack\Compute\v2\Models\QuotaSet`, `OpenStack\Compute\v2\Models\Server`, `OpenStack\Identity\v3\Models\Credential`, `OpenStack\Identity\v3\Models\Domain`, `OpenStack\Identity\v3\Models\Endpoint`, `OpenStack\Identity\v3\Models\Group`, `OpenStack\Identity\v3\Models\Policy`, `OpenStack\Identity\v3\Models\Project`, `OpenStack\Identity\v3\Models\Role`, `OpenStack\Identity\v3\Models\Service`, `OpenStack\Identity\v3\Models\User`, `OpenStack\Images\v2\Models\Image`, `OpenStack\Images\v2\Models\Member`, `OpenStack\Networking\v2\...ayer3\Models\FloatingIp`, `OpenStack\Networking\v2\...ns\Layer3\Models\Router`, `OpenStack\Networking\v2\...ps\Models\SecurityGroup`, `OpenStack\Networking\v2\...odels\SecurityGroupRule`, `OpenStack\Networking\v2\Models\Loadbalancer`, `OpenStack\Networking\v2\...adbalancerHealthmonitor`, `OpenStack\Networking\v2\...ls\LoadbalancerListener`, `OpenStack\Networking\v2\Models\LoadbalancerMember`, `OpenStack\Networking\v2\Models\LoadbalancerPool`, `OpenStack\Networking\v2\Models\Network`, `OpenStack\Networking\v2\Models\Port`, `OpenStack\Networking\v2\Models\Quota`, `OpenStack\Networking\v2\Models\Subnet`, `OpenStack\ObjectStore\v1\Models\Container`, `OpenStack\ObjectStore\v1\Models\Object`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
151			}
152
153			/**
154			* Add a healthmonitor to this load balancer pool
155			*
156			* @param array $userOptions
157			* @return LoadbalancerHealthmonitor
158			*/
159			public function addHealthmonitor(array $userOptions = []): LoadbalancerHealthmonitor
160			{
161			$userOptions = array_merge(['poolId' => $this->id], $userOptions);
162			return $this->model(LoadbalancerHealthmonitor::class)->create($userOptions);
			0 ignored issues – show Bug introduced 2017-07-21 15:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OpenStack\Common\Resource\ResourceInterface` as the method `create()` does only exist in the following implementations of said interface: `OpenStack\BlockStorage\v2\Models\Snapshot`, `OpenStack\BlockStorage\v2\Models\Volume`, `OpenStack\BlockStorage\v2\Models\VolumeType`, `OpenStack\Compute\v2\Models\Flavor`, `OpenStack\Compute\v2\Models\Keypair`, `OpenStack\Compute\v2\Models\Server`, `OpenStack\Identity\v3\Models\Credential`, `OpenStack\Identity\v3\Models\Domain`, `OpenStack\Identity\v3\Models\Endpoint`, `OpenStack\Identity\v3\Models\Group`, `OpenStack\Identity\v3\Models\Policy`, `OpenStack\Identity\v3\Models\Project`, `OpenStack\Identity\v3\Models\Role`, `OpenStack\Identity\v3\Models\Service`, `OpenStack\Identity\v3\Models\Token`, `OpenStack\Identity\v3\Models\User`, `OpenStack\Images\v2\Models\Image`, `OpenStack\Images\v2\Models\Member`, `OpenStack\Networking\v2\...ayer3\Models\FloatingIp`, `OpenStack\Networking\v2\...ns\Layer3\Models\Router`, `OpenStack\Networking\v2\...ps\Models\SecurityGroup`, `OpenStack\Networking\v2\...odels\SecurityGroupRule`, `OpenStack\Networking\v2\Models\Loadbalancer`, `OpenStack\Networking\v2\...adbalancerHealthmonitor`, `OpenStack\Networking\v2\...ls\LoadbalancerListener`, `OpenStack\Networking\v2\Models\LoadbalancerMember`, `OpenStack\Networking\v2\Models\LoadbalancerPool`, `OpenStack\Networking\v2\Models\Network`, `OpenStack\Networking\v2\Models\Port`, `OpenStack\Networking\v2\Models\Subnet`, `OpenStack\ObjectStore\v1\Models\Container`, `OpenStack\ObjectStore\v1\Models\Object`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
163			}
164			}
165

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#136)

LoadbalancerPool A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like