LoadBalancerPool::getAlias() - 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-19 19:53 UTC

LoadBalancerPool::getAlias() A

↳ Parent: LoadBalancerPool

Complexity

Conditions	2
Paths	2

Size

Total Lines	21
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	21
rs	9.3142
cc	2
eloc	16
nc	2
nop	0

<?php declare(strict_types=1);

namespace OpenStack\Networking\v2\Models;

use OpenStack\Common\Resource\Alias;
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 LoadBalancerHealthMonitor[]
     */
    public $healthmonitors;

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

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

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

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

    /**
     * @inheritdoc
     */
    protected static function getAlias(): Alias
    {
        $alias = parent::getAlias();

        if (!$alias->hasAliases(self::class)) {
            $alias
                ->add(self::class, 'tenant_id', 'tenantId')
                ->add(self::class, 'admin_state_up', 'adminStateUp')
                ->add(self::class, 'lb_algorithm', 'lbAlgorithm')
                ->add(self::class, 'session_persistence', 'sessionPersistence')
                ->add(self::class, 'healthmonitor_id', 'healthmonitorId')
                ->add(self::class, 'loadbalancer_id', 'loadbalancerId')
                ->add(self::class, 'operating_status', 'operatingStatus')
                ->add(self::class, 'provisioning_status', 'provisioningStatus')
                ->add(self::class, 'listeners', 'listeners', LoadBalancerListener::class, true)
                ->add(self::class, 'members', 'members', LoadBalancerMember::class, true)
                ->add(self::class, 'healthmonitors', 'healthmonitors', LoadBalancerHealthMonitor::class, true);
        }

        return $alias;
    }

    /**
     * {@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 $memberId
     * @return LoadBalancerMember
     */
    public function getMember(string $memberId): LoadBalancerMember
    {
        return $this->model(LoadBalancerMember::class, ['poolId' => $this->id, 'id' => $memberId]);
    }

    /**
     * Delete a member
     *
     * @param string $memberId
     */
    public function deleteMember(string $memberId)
    {
        $this->model(LoadBalancerMember::class, ['poolId' => $this->id, 'id' => $memberId])->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\Alias;
6			use OpenStack\Common\Resource\Creatable;
7			use OpenStack\Common\Resource\Deletable;
8			use OpenStack\Common\Resource\OperatorResource;
9			use OpenStack\Common\Resource\Retrievable;
10			use OpenStack\Common\Resource\Updateable;
11			use OpenStack\Networking\v2\Api;
12
13			/**
14			* Represents a Neutron v2 LoadBalancer pool
15			*
16			* @property Api $api
17			*/
18			class LoadBalancerPool extends OperatorResource implements Creatable, Retrievable, Updateable, Deletable
19			{
20			/**
21			* @var string
22			*/
23			public $name;
24
25			/**
26			* @var string
27			*/
28			public $description;
29
30			/**
31			* @var string
32			*/
33			public $id;
34
35			/**
36			* @var string
37			*/
38			public $tenantId;
39
40			/**
41			* @var string
42			*/
43			public $protocol;
44
45			/**
46			* @var string
47			*/
48			public $lbAlgorithm;
49
50			/**
51			* @var array
52			*/
53			public $sessionPersistence;
54
55			/**
56			* @var boolean
57			*/
58			public $adminStateUp;
59
60			/**
61			* @var LoadBalancerListener[]
62			*/
63			public $listeners;
64
65			/**
66			* @var LoadBalancerMember[]
67			*/
68			public $members;
69
70			/**
71			* @var LoadBalancerHealthMonitor[]
72			*/
73			public $healthmonitors;
74
75			/**
76			* @var string
77			*/
78			public $healthmonitorId;
79
80			/**
81			* @var string
82			*/
83			public $operatingStatus;
84
85			/**
86			* @var string
87			*/
88			public $provisioningStatus;
89
90			protected $resourcesKey = 'pools';
91			protected $resourceKey = 'pool';
92
93			/**
94			* @inheritdoc
95			*/
96			protected static function getAlias(): Alias
97			{
98			$alias = parent::getAlias();
99
100			if (!$alias->hasAliases(self::class)) {
101			$alias
102			->add(self::class, 'tenant_id', 'tenantId')
103			->add(self::class, 'admin_state_up', 'adminStateUp')
104			->add(self::class, 'lb_algorithm', 'lbAlgorithm')
105			->add(self::class, 'session_persistence', 'sessionPersistence')
106			->add(self::class, 'healthmonitor_id', 'healthmonitorId')
107			->add(self::class, 'loadbalancer_id', 'loadbalancerId')
108			->add(self::class, 'operating_status', 'operatingStatus')
109			->add(self::class, 'provisioning_status', 'provisioningStatus')
110			->add(self::class, 'listeners', 'listeners', LoadBalancerListener::class, true)
111			->add(self::class, 'members', 'members', LoadBalancerMember::class, true)
112			->add(self::class, 'healthmonitors', 'healthmonitors', LoadBalancerHealthMonitor::class, true);
113			}
114
115			return $alias;
116			}
117
118			/**
119			* {@inheritDoc}
120			*/
121			public function create(array $userOptions): Creatable
122			{
123			$response = $this->execute($this->api->postLoadBalancerPool(), $userOptions);
124			return $this->populateFromResponse($response);
125			}
126
127			/**
128			* {@inheritDoc}
129			*/
130			public function retrieve()
131			{
132			$response = $this->execute($this->api->getLoadBalancerPool(), ['id' => (string)$this->id]);
133			$this->populateFromResponse($response);
134			}
135
136			/**
137			* {@inheritDoc}
138			*/
139			public function update()
140			{
141			$response = $this->executeWithState($this->api->putLoadBalancerPool());
142			$this->populateFromResponse($response);
143			}
144
145			/**
146			* {@inheritDoc}
147			*/
148			public function delete()
149			{
150			$this->executeWithState($this->api->deleteLoadBalancerPool());
151			}
152
153			/**
154			* Add a member to this pool
155			*
156			* @param array $userOptions
157			*/
158			public function addMember(array $userOptions = []): LoadBalancerMember
159			{
160			$userOptions = array_merge(['poolId' => $this->id], $userOptions);
161			return $this->model(LoadBalancerMember::class)->create($userOptions);
			0 ignored issues – show Bug introduced 2017-07-23 14:02 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...
162			}
163
164			/**
165			* Get an instance of a member
166			*
167			* @param string $memberId
168			* @return LoadBalancerMember
169			*/
170			public function getMember(string $memberId): LoadBalancerMember
171			{
172			return $this->model(LoadBalancerMember::class, ['poolId' => $this->id, 'id' => $memberId]);
173			}
174
175			/**
176			* Delete a member
177			*
178			* @param string $memberId
179			*/
180			public function deleteMember(string $memberId)
181			{
182			$this->model(LoadBalancerMember::class, ['poolId' => $this->id, 'id' => $memberId])->delete();
			0 ignored issues – show Bug introduced 2017-07-23 14:02 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...
183			}
184
185			/**
186			* Add a healthmonitor to this load balancer pool
187			*
188			* @param array $userOptions
189			* @return LoadBalancerHealthMonitor
190			*/
191			public function addHealthMonitor(array $userOptions = []): LoadBalancerHealthMonitor
192			{
193			$userOptions = array_merge(['poolId' => $this->id], $userOptions);
194			return $this->model(LoadBalancerHealthMonitor::class)->create($userOptions);
			0 ignored issues – show Bug introduced 2017-07-23 14:02 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...
195			}
196			}
197

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#159)

LoadBalancerPool::getAlias() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like