Service::getLoadbalancer() - 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

Service::getLoadbalancer() A

↳ Parent: Service

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php declare(strict_types=1);

namespace OpenStack\Networking\v2;

use OpenStack\Common\Service\AbstractService;
use OpenStack\Networking\v2\Models\Loadbalancer;
use OpenStack\Networking\v2\Models\LoadbalancerHealthmonitor;
use OpenStack\Networking\v2\Models\LoadbalancerListener;
use OpenStack\Networking\v2\Models\LoadbalancerMember;
use OpenStack\Networking\v2\Models\LoadbalancerPool;
use OpenStack\Networking\v2\Models\Network;
use OpenStack\Networking\v2\Models\Pool;
use OpenStack\Networking\v2\Models\Port;
use OpenStack\Networking\v2\Models\Quota;
use OpenStack\Networking\v2\Models\Subnet;

/**
 * Network v2 service for OpenStack.
 *
 * @property \OpenStack\Networking\v2\Api $api
 */
class Service extends AbstractService
{
    /**
     * Create a new network resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postNetwork}
     *
     * @return Network
     */
    public function createNetwork(array $options): Network
    {
        return $this->model(Network::class)->create($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.
    }
}
    }

    /**
     * Create a new network resources.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postNetworks}
     *
     * @return array
     */
    public function createNetworks(array $options): array
    {
        return $this->model(Network::class)->bulkCreate($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.
    }
}
    }

    /**
     * Retrieve a network object without calling the remote API. Any values provided in the array will populate the
     * empty object, allowing you greater control without the expense of network transactions. To call the remote API
     * and have the response populate the object, call {@see Network::retrieve}.
     *
     * @param string $id
     *
     * @return Network
     */
    public function getNetwork(string $id): Network
    {
        return $this->model(Network::class, ['id' => $id]);
    }

    /**
     * List networks.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::getNetworks}
     *
     * @return \Generator
     */
    public function listNetworks(array $options = []): \Generator
    {
        return $this->model(Network::class)->enumerate($this->api->getNetworks(), $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.
    }
}
    }

    /**
     * Create a new subnet resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postSubnet}
     *
     * @return Subnet
     */
    public function createSubnet(array $options): Subnet
    {
        return $this->model(Subnet::class)->create($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.
    }
}
    }

    /**
     * Create a new subnet resources.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postSubnets}
     *
     * @return []Subnet

     */
    public function createSubnets(array $options): array
    {
        return $this->model(Subnet::class)->bulkCreate($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.
    }
}
    }

    /**
     * Retrieve a subnet object without calling the remote API. Any values provided in the array will populate the
     * empty object, allowing you greater control without the expense of network transactions. To call the remote API
     * and have the response populate the object, call {@see Subnet::retrieve}.
     *
     * @param string $id
     *
     * @return Subnet
     */
    public function getSubnet(string $id): Subnet
    {
        return $this->model(Subnet::class, ['id' => $id]);
    }

    /**
     * List subnets.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::getSubnets}
     *
     * @return \Generator
     */
    public function listSubnets(array $options = []): \Generator
    {
        return $this->model(Subnet::class)->enumerate($this->api->getSubnets(), $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.
    }
}
    }

    /**
     * Create a new port resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postSinglePort}
     *
     * @return Port
     */
    public function createPort(array $options): Port
    {
        return $this->model(Port::class)->create($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.
    }
}
    }

    /**
     * Create new port resources.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postMultiplePorts}
     *
     * @return []Port

     */
    public function createPorts(array $options): array
    {
        return $this->model(Port::class)->bulkCreate($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.
    }
}
    }

    /**
     * Retrieve a subnet object without calling the remote API. Any values provided in the array will populate the
     * empty object, allowing you greater control without the expense of network transactions. To call the remote API
     * and have the response populate the object, call {@see Port::retrieve}.
     *
     * @param string $id
     *
     * @return Port
     */
    public function getPort(string $id): Port
    {
        return $this->model(Port::class, ['id' => $id]);
    }

    /**
     * List ports.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::getPorts}
     *
     * @return \Generator
     */
    public function listPorts(array $options = []): \Generator
    {
        return $this->model(Port::class)->enumerate($this->api->getPorts(), $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.
    }
}
    }

    /**
     * Lists quotas for projects with non-default quota values.
     *
     * @return \Generator
     */
    public function listQuotas(): \Generator
    {
        return $this->model(Quota::class)->enumerate($this->api->getQuotas(), []);
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.
    }
}
    }

    /**
     * Lists quotas for a project.
     *
     * Retrieve a quota object without calling the remote API. Any values provided in the array will populate the
     * empty object, allowing you greater control without the expense of network transactions. To call the remote API
     * and have the response populate the object, call {@see Quota::retrieve}.
     *
     * @param string $tenantId
     *
     * @return Quota
     */
    public function getQuota(string $tenantId): Quota
    {
        return $this->model(Quota::class, ['tenantId' => $tenantId]);
    }

    /**
     * Lists default quotas for a project
     *
     * @param string $tenantId
     *
     * @return Quota
     */
    public function getDefaultQuota(string $tenantId): Quota
    {
        $quota = $this->model(Quota::class, ['tenantId' => $tenantId]);
        $quota->populateFromResponse($this->execute($this->api->getQuotaDefault(), ['tenantId' => $tenantId]));

        return $quota;
    }

    /**
     * Lists loadbalancers for projects
     *
     * @return \Generator
     */
    public function listLoadbalancers(): \Generator
    {
        return $this->model(Loadbalancer::class)->enumerate($this->api->getLoadbalancers());
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.
    }
}
    }

    /**
     * Retrieve an instance of a Loadbalancer object
     *
     * @param string $id
     *
     * @return Loadbalancer
     */
    public function getLoadbalancer(string $id): Loadbalancer
    {
        return $this->model(Loadbalancer::class, ['id' => $id]);
    }

    /**
     * Create a new loadbalancer resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postLoadbalancer}
     *
     * @return Loadbalancer
     */
    public function createLoadbalancer(array $options): Loadbalancer
    {
        return $this->model(Loadbalancer::class)->create($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.
    }
}
    }

    /**
     * Lists loadbalancer listeners
     *
     * @return \Generator
     */
    public function listLoadbalancerListeners(): \Generator
    {
        return $this->model(LoadbalancerListener::class)->enumerate($this->api->getLoadbalancerListeners());
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.
    }
}
    }

    /**
     * Retrieve an instance of a loadbalancer listener object
     *
     * @param string $id
     *
     * @return LoadbalancerListener
     */
    public function getLoadbalancerListener(string $id): LoadbalancerListener
    {
        return $this->model(LoadbalancerListener::class, ['id' => $id]);
    }

    /**
     * Create a new loadbalancer Listener resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postLoadbalancerListener}
     *
     * @return LoadbalancerListener
     */
    public function createLoadbalancerListener(array $options): LoadbalancerListener
    {
        return $this->model(LoadbalancerListener::class)->create($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.
    }
}
    }

    /**
     * Lists loadbalancer pools
     *
     * @return \Generator
     */
    public function listLoadbalancerPools(): \Generator
    {
        return $this->model(LoadbalancerPool::class)->enumerate($this->api->getLoadbalancerPools());
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.
    }
}
    }

    /**
     * Retrieve an instance of a loadbalancer Pool object
     *
     * @param string $id
     *
     * @return LoadbalancerPool
     */
    public function getLoadbalancerPool(string $id): LoadbalancerPool
    {
        return $this->model(LoadbalancerPool::class, ['id' => $id]);
    }

    /**
     * Create a new loadbalancer Pool resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postLoadbalancerPool}
     *
     * @return LoadbalancerPool
     */
    public function createLoadbalancerPool(array $options): LoadbalancerPool
    {
        return $this->model(LoadbalancerPool::class)->create($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.
    }
}
    }

    /**
     * Lists loadbalancer members
     *
     * @return \Generator
     */
    public function listLoadbalancerMembers(string $pool_id): \Generator
    {
        return $this->model(LoadbalancerPool::class, ['poolId' => $pool_id])->enumerate($this->api->getLoadbalancerMembers());
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.
    }
}
    }

    /**
     * Retrieve an instance of a loadbalancer Member object
     *
     * @param string $pool_id
     * @param string $id
     *
     * @return LoadbalancerMember
     */
    public function getLoadbalancerMember(string $pool_id, string $id): LoadbalancerMember
    {
        return $this->model(LoadbalancerMember::class, ['poolId' => $pool_id, 'id' => $id]);
    }

    /**
     * Create a new loadbalancer member resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postLoadbalancerMember}
     *
     * @return LoadbalancerMember
     */
    public function createLoadbalancerMember(array $options): LoadbalancerMember
    {
        return $this->model(LoadbalancerMember::class)->create($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.
    }
}
    }

    /**
     * Lists loadbalancer healthmonitors
     *
     * @return \Generator
     */
    public function listLoadbalancerHealthmonitors(): \Generator
    {
        return $this->model(LoadbalancerHealthmonitor::class)->enumerate($this->api->getLoadbalancerHealthmonitors());
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.
    }
}
    }

    /**
     * Retrieve an instance of a loadbalancer healthmonitor object
     *
     * @param string $id
     *
     * @return LoadbalancerHealthmonitor
     */
    public function getLoadbalancerHealthmonitor(string $id): LoadbalancerHealthmonitor
    {
        return $this->model(LoadbalancerHealthmonitor::class, ['id' => $id]);
    }

    /**
     * Create a new loadbalancer healthmonitor resource.
     *
     * @param array $options {@see \OpenStack\Networking\v2\Api::postLoadbalancerHealthmonitor}
     *
     * @return LoadbalancerHealthmonitor
     */
    public function createLoadbalancerHealthmonitor(array $options): LoadbalancerHealthmonitor
    {
        return $this->model(LoadbalancerHealthmonitor::class)->create($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.
    }
}
    }
}


GitHub Access Token became invalid

Pull Request — master (#136)

Service::getLoadbalancer() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php declare(strict_types=1);
2
3		namespace OpenStack\Networking\v2;
4
5		use OpenStack\Common\Service\AbstractService;
6		use OpenStack\Networking\v2\Models\Loadbalancer;
7		use OpenStack\Networking\v2\Models\LoadbalancerHealthmonitor;
8		use OpenStack\Networking\v2\Models\LoadbalancerListener;
9		use OpenStack\Networking\v2\Models\LoadbalancerMember;
10		use OpenStack\Networking\v2\Models\LoadbalancerPool;
11		use OpenStack\Networking\v2\Models\Network;
12		use OpenStack\Networking\v2\Models\Pool;
13		use OpenStack\Networking\v2\Models\Port;
14		use OpenStack\Networking\v2\Models\Quota;
15		use OpenStack\Networking\v2\Models\Subnet;
16
17		/**
18		* Network v2 service for OpenStack.
19		*
20		* @property \OpenStack\Networking\v2\Api $api
21		*/
22		class Service extends AbstractService
23		{
24	1	/**
25		* Create a new network resource.
26	1	*
27		* @param array $options {@see \OpenStack\Networking\v2\Api::postNetwork}
28		*
29		* @return Network
30		*/
31		public function createNetwork(array $options): Network
32		{
33		return $this->model(Network::class)->create($options);
		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...
34		}
35
36	1	/**
37		* Create a new network resources.
38	1	*
39		* @param array $options {@see \OpenStack\Networking\v2\Api::postNetworks}

php-opencloud / openstack

GitHub Access Token became invalid

Pull Request — master (#136)

Service::getLoadbalancer() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like