Resource::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

Resource::getAlias() A

↳ Parent: Resource

Complexity

Conditions	2
Paths	2

Size

Total Lines	23
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	23
rs	9.0856
cc	2
eloc	18
nc	2
nop	0

<?php declare(strict_types=1);

namespace OpenStack\Metric\v1\Gnocchi\Models;

use OpenStack\Common\Resource\Alias;
use OpenStack\Common\Resource\OperatorResource;
use OpenStack\Common\Resource\Retrievable;
use OpenStack\Metric\v1\Gnocchi\Api;

/**
 * @property Api $api
 */
class Resource extends OperatorResource implements Retrievable
{
    const RESOURCE_TYPE_GENERIC = 'generic';
    const RESOURCE_TYPE_CEPH_ACCOUNT = 'ceph_account';
    const RESOURCE_TYPE_HOST = 'host';
    const RESOURCE_TYPE_HOST_DISK = 'host_disk';
    const RESOURCE_TYPE_HOST_NETWORK_INTERFACE = 'host_network_interface';
    const RESOURCE_TYPE_IDENTITY = 'identity';
    const RESOURCE_TYPE_IMAGE = 'image';
    const RESOURCE_TYPE_INSTANCE = 'instance';
    const RESOURCE_TYPE_INSTANCE_DISK = 'instance_disk';
    const RESOURCE_TYPE_INSTANCE_NETWORK_INTERFACE = 'instance_network_interface';
    const RESOURCE_TYPE_IPMI = 'ipmi';
    const RESOURCE_TYPE_NETWORK = 'network';
    const RESOURCE_TYPE_STACK = 'stack';
    const RESOURCE_TYPE_SWIFT_ACCOUNT = 'swift_account';
    const RESOURCE_TYPE_VOLUME = 'volume';

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        if (!$alias->hasAliases(self::class)) {
            $alias
                ->add(self::class, 'created_by_user_id', 'createdByUserId')
                ->add(self::class, 'started_at', 'startedAt')
                ->add(self::class, 'display_name', 'displayName')
                ->add(self::class, 'revision_end', 'revisionEnd')
                ->add(self::class, 'user_id', 'userId')
                ->add(self::class, 'created_by_project_id', 'createdByProjectId')
                ->add(self::class, 'image_ref', 'imageRef')
                ->add(self::class, 'flavor_id', 'flavorId')
                ->add(self::class, 'server_group', 'serverGroup')
                ->add(self::class, 'original_resource_id', 'originalResourceId')
                ->add(self::class, 'revision_start', 'revisionStart')
                ->add(self::class, 'project_id', 'projectId')
                ->add(self::class, 'ended_at', 'endedAt');
        }

        return $alias;
    }

    public function retrieve()
    {
        $response = $this->execute($this->api->getResource(), ['type' => $this->type, 'id' => $this->id]);
        $this->populateFromResponse($response);
    }

    /**
     * @param string $metric
     *
     * @return Metric
     */
    public function getMetric(string $metric): Metric
    {
        $response = $this->execute(
            $this->api->getResourceMetric(),
            [
                'resourceId' => $this->id,
                'metric'     => $metric,
                'type'       => $this->type,
            ]
        );
        $metric = $this->model(Metric::class)->populateFromResponse($response);

        return $metric;
    }

    /**
     * @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getResourceMetricMeasures}
     *
     * @return array
     */
    public function getMetricMeasures(array $options = []): array
    {
        $options = array_merge(
            $options,
            [
                'resourceId' => $this->id,
                'type'       => $this->type,
            ]
        );

        $response = $this->execute($this->api->getResourceMetricMeasures(), $options);

        return \GuzzleHttp\json_decode($response->getBody());
    }

    /**
     * @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getResourceMetrics}
     *
     * @return \Generator
     */
    public function listResourceMetrics(array $options = []): \Generator
    {
        $options['resourceId'] = $this->id;

        return $this->model(Metric::class)->enumerate($this->api->getResourceMetrics(), $options);
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\Metric\v1\Gnocchi\Models;
4
5			use OpenStack\Common\Resource\Alias;
6			use OpenStack\Common\Resource\OperatorResource;
7			use OpenStack\Common\Resource\Retrievable;
8			use OpenStack\Metric\v1\Gnocchi\Api;
9
10			/**
11			* @property Api $api
12			*/
13			class Resource extends OperatorResource implements Retrievable
14			{
15			const RESOURCE_TYPE_GENERIC = 'generic';
16			const RESOURCE_TYPE_CEPH_ACCOUNT = 'ceph_account';
17			const RESOURCE_TYPE_HOST = 'host';
18			const RESOURCE_TYPE_HOST_DISK = 'host_disk';
19			const RESOURCE_TYPE_HOST_NETWORK_INTERFACE = 'host_network_interface';
20			const RESOURCE_TYPE_IDENTITY = 'identity';
21			const RESOURCE_TYPE_IMAGE = 'image';
22			const RESOURCE_TYPE_INSTANCE = 'instance';
23			const RESOURCE_TYPE_INSTANCE_DISK = 'instance_disk';
24			const RESOURCE_TYPE_INSTANCE_NETWORK_INTERFACE = 'instance_network_interface';
25			const RESOURCE_TYPE_IPMI = 'ipmi';
26			const RESOURCE_TYPE_NETWORK = 'network';
27			const RESOURCE_TYPE_STACK = 'stack';
28			const RESOURCE_TYPE_SWIFT_ACCOUNT = 'swift_account';
29			const RESOURCE_TYPE_VOLUME = 'volume';
30
31			/** @var string */
32			public $createdByUserId;
33
34			/** @var string */
35			public $startedAt;
36
37			/** @var string */
38			public $displayName;
39
40			/** @var string */
41			public $revisionEnd;
42
43			/** @var string */
44			public $userId;
45
46			/** @var string */
47			public $createdByProjectId;
48
49			/** @var string */
50			public $id;
51
52			/** @var array */
53			public $metrics;
54
55			/** @var string */
56			public $host;
57
58			/** @var string */
59			public $imageRef;
60
61			/** @var string */
62			public $flavorId;
63
64			/** @var string */
65			public $serverGroup;
66
67			/** @var string */
68			public $originalResourceId;
69
70			/** @var string */
71			public $revisionStart;
72
73			/** @var string */
74			public $projectId;
75
76			/** @var string */
77			public $type;
78
79			/** @var string */
80			public $endedAt;
81
82			/**
83			* @inheritdoc
84			*/
85			protected static function getAlias(): Alias
86			{
87			$alias = parent::getAlias();
88
89			if (!$alias->hasAliases(self::class)) {
90			$alias
91			->add(self::class, 'created_by_user_id', 'createdByUserId')
92			->add(self::class, 'started_at', 'startedAt')
93			->add(self::class, 'display_name', 'displayName')
94			->add(self::class, 'revision_end', 'revisionEnd')
95			->add(self::class, 'user_id', 'userId')
96			->add(self::class, 'created_by_project_id', 'createdByProjectId')
97			->add(self::class, 'image_ref', 'imageRef')
98			->add(self::class, 'flavor_id', 'flavorId')
99			->add(self::class, 'server_group', 'serverGroup')
100			->add(self::class, 'original_resource_id', 'originalResourceId')
101			->add(self::class, 'revision_start', 'revisionStart')
102			->add(self::class, 'project_id', 'projectId')
103			->add(self::class, 'ended_at', 'endedAt');
104			}
105
106			return $alias;
107			}
108
109			public function retrieve()
110			{
111			$response = $this->execute($this->api->getResource(), ['type' => $this->type, 'id' => $this->id]);
112			$this->populateFromResponse($response);
113			}
114
115			/**
116			* @param string $metric
117			*
118			* @return Metric
119			*/
120			public function getMetric(string $metric): Metric
121			{
122			$response = $this->execute(
123			$this->api->getResourceMetric(),
124			[
125			'resourceId' => $this->id,
126			'metric' => $metric,
127			'type' => $this->type,
128			]
129			);
130			$metric = $this->model(Metric::class)->populateFromResponse($response);
131
132			return $metric;
133			}
134
135			/**
136			* @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getResourceMetricMeasures}
137			*
138			* @return array
139			*/
140			public function getMetricMeasures(array $options = []): array
141			{
142			$options = array_merge(
143			$options,
144			[
145			'resourceId' => $this->id,
146			'type' => $this->type,
147			]
148			);
149
150			$response = $this->execute($this->api->getResourceMetricMeasures(), $options);
151
152			return \GuzzleHttp\json_decode($response->getBody());
153			}
154
155			/**
156			* @param array $options {@see \OpenStack\Metric\v1\Gnocchi\Api::getResourceMetrics}
157			*
158			* @return \Generator
159			*/
160			public function listResourceMetrics(array $options = []): \Generator
161			{
162			$options['resourceId'] = $this->id;
163
164			return $this->model(Metric::class)->enumerate($this->api->getResourceMetrics(), $options);
			0 ignored issues – show Bug introduced 2017-07-27 13:35 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 `enumerate()` 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\VolumeAttachment`, `OpenStack\BlockStorage\v2\Models\VolumeType`, `OpenStack\Common\Resource\OperatorResource`, `OpenStack\Compute\v2\Models\AvailabilityZone`, `OpenStack\Compute\v2\Models\Flavor`, `OpenStack\Compute\v2\Models\Host`, `OpenStack\Compute\v2\Models\Hypervisor`, `OpenStack\Compute\v2\Models\HypervisorStatistic`, `OpenStack\Compute\v2\Models\Image`, `OpenStack\Compute\v2\Models\Keypair`, `OpenStack\Compute\v2\Models\QuotaSet`, `OpenStack\Compute\v2\Models\Server`, `OpenStack\Identity\v2\Models\Catalog`, `OpenStack\Identity\v2\Models\Endpoint`, `OpenStack\Identity\v2\Models\Entry`, `OpenStack\Identity\v2\Models\Tenant`, `OpenStack\Identity\v2\Models\Token`, `OpenStack\Identity\v3\Models\Assignment`, `OpenStack\Identity\v3\Models\Catalog`, `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\Metric\v1\Gnocchi\Models\Metric`, `OpenStack\Metric\v1\Gnocchi\Models\Resource`, `OpenStack\Metric\v1\Gnocchi\Models\ResourceType`, `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\InterfaceAttachment`, `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\LoadBalancerStat`, `OpenStack\Networking\v2\Models\LoadBalancerStatus`, `OpenStack\Networking\v2\Models\Network`, `OpenStack\Networking\v2\Models\Port`, `OpenStack\Networking\v2\Models\Quota`, `OpenStack\Networking\v2\Models\Subnet`, `OpenStack\ObjectStore\v1\Models\Account`, `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...
165			}
166			}
167

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#159)

Resource::getAlias() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like