Loadbalancer::retrieve() - 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 20:52 UTC

Loadbalancer::retrieve() A

↳ Parent: Loadbalancer

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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
 *
 * @property Api $api
 */
class Loadbalancer extends OperatorResource implements Creatable, Retrievable, Updateable, Deletable
{
    /**
     * @var string
     */
    public $name;

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

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

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

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

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

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

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

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

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

    protected $resourcesKey = 'loadbalancers';
    protected $resourceKey = 'loadbalancer';

    protected $aliases = [
        'tenant_id'           => 'tenantId',
        'admin_state_up'      => 'adminStateUp',
        'vip_address'         => 'vipAddress',
        'vip_subnet_id'       => 'vipSubnetId',
        'operating_status'    => 'operatingStatus',
        'provisioning_status' => 'provisioningStatus'
    ];

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

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

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

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

    /**
     * Add a listener to this load balancer
     *
     * @param array $userOptions
     * @return LoadbalancerListener
     */
    public function addListener(array $userOptions = []): LoadbalancerListener
    {
        $userOptions = array_merge(['loadbalancerId' => $this->id], $userOptions);
        return $this->model(LoadbalancerListener::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 stats for this loadbalancer
     *
     * @return LoadbalancerStat
     */
    public function getStats(): LoadbalancerStat
    {
        $model = $this->model(LoadbalancerStat::class, ['loadbalancerId' => $this->id]);
        $model->retrieve();
        return $model;
    }

    /**
     * Get the status tree for this loadbalancer
     *
     * @return LoadbalancerStatus
     */
    public function getStatuses(): LoadbalancerStatus
    {
        $model = $this->model(LoadbalancerStatus::class, ['loadbalancerId' => $this->id]);
        $model->retrieve();
        return $model;
    }
}


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
14			*
15			* @property Api $api
16			*/
17			class Loadbalancer 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 boolean
31			*/
32			public $adminStateUp;
33
34			/**
35			* @var string
36			*/
37			public $tenantId;
38
39			/**
40			* @var []LoadbalancerListener
41			*/
42			public $listeners;
43
44			/**
45			* @var string
46			*/
47			public $vipAddress;
48
49			/**
50			* @var string
51			*/
52			public $vipSubnetId;
53
54			/**
55			* @var string
56			*/
57			public $id;
58
59			/**
60			* @var string
61			*/
62			public $operatingStatus;
63
64			/**
65			* @var string
66			*/
67			public $provisioningStatus;
68
69			protected $resourcesKey = 'loadbalancers';
70			protected $resourceKey = 'loadbalancer';
71
72			protected $aliases = [
73			'tenant_id' => 'tenantId',
74			'admin_state_up' => 'adminStateUp',
75			'vip_address' => 'vipAddress',
76			'vip_subnet_id' => 'vipSubnetId',
77			'operating_status' => 'operatingStatus',
78			'provisioning_status' => 'provisioningStatus'
79			];
80
81			/**
82			* {@inheritDoc}
83			*/
84			public function create(array $userOptions): Creatable
85			{
86			$response = $this->execute($this->api->postLoadbalancer(), $userOptions);
87			return $this->populateFromResponse($response);
88			}
89
90			/**
91			* {@inheritDoc}
92			*/
93			public function retrieve()
94			{
95			$response = $this->execute($this->api->getLoadbalancer(), ['id' => (string)$this->id]);
96			$this->populateFromResponse($response);
97			}
98
99			/**
100			* {@inheritDoc}
101			*/
102			public function update()
103			{
104			$response = $this->executeWithState($this->api->putLoadbalancer());
105			$this->populateFromResponse($response);
106			}
107
108			/**
109			* {@inheritDoc}
110			*/
111			public function delete()
112			{
113			$this->executeWithState($this->api->deleteLoadBalancer());
114			}
115
116			/**
117			* Add a listener to this load balancer
118			*
119			* @param array $userOptions
120			* @return LoadbalancerListener
121			*/
122			public function addListener(array $userOptions = []): LoadbalancerListener
123			{
124			$userOptions = array_merge(['loadbalancerId' => $this->id], $userOptions);
125			return $this->model(LoadbalancerListener::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...
126			}
127
128			/**
129			* Get stats for this loadbalancer
130			*
131			* @return LoadbalancerStat
132			*/
133			public function getStats(): LoadbalancerStat
134			{
135			$model = $this->model(LoadbalancerStat::class, ['loadbalancerId' => $this->id]);
136			$model->retrieve();
137			return $model;
138			}
139
140			/**
141			* Get the status tree for this loadbalancer
142			*
143			* @return LoadbalancerStatus
144			*/
145			public function getStatuses(): LoadbalancerStatus
146			{
147			$model = $this->model(LoadbalancerStatus::class, ['loadbalancerId' => $this->id]);
148			$model->retrieve();
149			return $model;
150			}
151			}
152

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#136)

Loadbalancer::retrieve() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like