Catalog::getServiceUrl() - Code Metrics - php-opencloud/openstack - Measure and Improve Code Quality continuously with Scrutinizer

Catalog::getServiceUrl() A
last analyzed 2017-12-19 03:52 UTC

↳ Parent: Catalog

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	17
rs	9.2
ccs	0
cts	0
cp	0
cc	4
eloc	9
nc	4
nop	4
crap	20

<?php declare(strict_types=1);

namespace OpenStack\Identity\v3\Models;

use OpenStack\Common\Resource\Alias;
use OpenStack\Common\Resource\OperatorResource;

/**
 * @property \OpenStack\Identity\v3\Api $api
 */
class Catalog extends OperatorResource implements \OpenStack\Common\Auth\Catalog
{
    /** @var []Service */
    public $services;

    /**
     * @inheritdoc
     */
    protected function getAliases(): array
    {
        return parent::getAliases() + [
            'services' => new Alias('services', Service::class, true)
        ];
    }

    public function populateFromArray(array $data): self
    {
        foreach ($data as $service) {
            $this->services[] = $this->model(Service::class, $service);
        }

        return $this;
    }

    /**
     * Retrieve a base URL for a service, according to its catalog name, type, region.
     *
     * @param string $name    The name of the service as it appears in the catalog.
     * @param string $type    The type of the service as it appears in the catalog.
     * @param string $region  The region of the service as it appears in the catalog.
     * @param string $urlType Unused.
     *
     * @return false|string   FALSE if no URL found
     */
    public function getServiceUrl(string $name, string $type, string $region, string $urlType): string
    {
        if (empty($this->services)) {
            throw new \RuntimeException('No services are defined');
        }

        foreach ($this->services as $service) {
            if (false !== ($url = $service->getUrl($name, $type, $region, $urlType))) {
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.
    }
}
                return $url;
            }
        }

        throw new \RuntimeException(sprintf(
            "Endpoint URL could not be found in the catalog for this service.\nName: %s\nType: %s\nRegion: %s\nURL type: %s",
            $name, $type, $region, $urlType
        ));
    }
}


1		<?php declare(strict_types=1);
2
3		namespace OpenStack\Identity\v3\Models;
4
5		use OpenStack\Common\Resource\Alias;
6		use OpenStack\Common\Resource\OperatorResource;
7
8		/**
9		* @property \OpenStack\Identity\v3\Api $api
10		*/
11		class Catalog extends OperatorResource implements \OpenStack\Common\Auth\Catalog
12		{
13		/** @var []Service */
14		public $services;
15	4
16		/**
17	4	* @inheritdoc
18	4	*/
19	4	protected function getAliases(): array
20	4	{
21		return parent::getAliases() + [
22		'services' => new Alias('services', Service::class, true)
23		];
24		}
25
26		public function populateFromArray(array $data): self
27		{
28		foreach ($data as $service) {
29		$this->services[] = $this->model(Service::class, $service);
30		}
31
32	5	return $this;
33		}
34	5
35	1	/**
36		* Retrieve a base URL for a service, according to its catalog name, type, region.
37		*
38	4	* @param string $name The name of the service as it appears in the catalog.
39	4	* @param string $type The type of the service as it appears in the catalog.
40	2	* @param string $region The region of the service as it appears in the catalog.
41		* @param string $urlType Unused.
42	2	*
43		* @return false\|string FALSE if no URL found
44	2	*/
45		public function getServiceUrl(string $name, string $type, string $region, string $urlType): string
46		{
47		if (empty($this->services)) {
48		throw new \RuntimeException('No services are defined');
49		}
50
51		foreach ($this->services as $service) {
52		if (false !== ($url = $service->getUrl($name, $type, $region, $urlType))) {
		0 ignored issues – show Bug introduced 2015-11-23 10:33 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 `getUrl()` does only exist in the following implementations of said interface: `OpenStack\Identity\v2\Models\Endpoint`, `OpenStack\Identity\v3\Models\Service`. 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...
53		return $url;
54		}
55		}
56
57		throw new \RuntimeException(sprintf(
58		"Endpoint URL could not be found in the catalog for this service.\nName: %s\nType: %s\nRegion: %s\nURL type: %s",
59		$name, $type, $region, $urlType
60		));
61		}
62		}
63

php-opencloud / openstack

GitHub Access Token became invalid

Catalog::getServiceUrl() A last analyzed 2017-12-19 03:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Catalog::getServiceUrl() A
last analyzed 2017-12-19 03:52 UTC