PCextreme\Cloudstack\Util\UrlHelpersTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	clientUrl()	0	24	2
A	consoleUrl()	0	43	2

<?php

declare(strict_types=1);

namespace PCextreme\Cloudstack\Util;

use InvalidArgumentException;
use PCextreme\Cloudstack\Exception\ClientException;

trait UrlHelpersTrait
{
    /**
     * Generate Client URL for specified username.
     *
     * @param  string $username
     * @param  string $domainId
     * @return string
     * @throws InvalidArgumentException
     */
    public function clientUrl(string $username, string $domainId) : string
    {
        if (is_null($this->urlClient)) {

The property urlClient does not exist. Did you maybe forget to declare it?

            throw new InvalidArgumentException(
                'Required options not defined: urlClient'
            );
        }

        // Prepare session.
        // Using the SSO (Single Sign On) key we can generate a sessionkey used for the console url.
        $command = 'login';
        $params = [
            'command'   => $command,
            'username'  => $username,
            'domainid'  => $domainId,
            'timestamp' => round(microtime(true) * 1000),
            'response'  => 'json',
        ];

        $method  = $this->getCommandMethod($command);

It seems like getCommandMethod() must be provided by classes using this trait. How about adding it as abstract method to this trait?

$method is not used, you could remove the assignment.

        $query   = $this->enableSso()->getCommandQuery($params);

It seems like enableSso() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this->urlClient.'?loginUrl='.urlencode($query);
    }

    /**
     * Generate Console URL for specified username owning the virtual machine.
     *
     * @param  string $username
     * @param  string $domainId
     * @param  string $virtualMachineId
     * @return string
     * @throws InvalidArgumentException
     */
    public function consoleUrl(string $username, string $domainId, string $virtualMachineId) : string
    {
        if (is_null($this->urlConsole)) {

The property urlConsole does not exist. Did you maybe forget to declare it?

            throw new InvalidArgumentException(
                'Required options not defined: urlConsole'
            );
        }

        // Prepare session.
        // Using the SSO (Single Sign On) key we can generate a sessionkey used for the console url.
        $command = 'login';
        $params = [
            'command'   => $command,
            'username'  => $username,
            'domainid'  => $domainId,
            'timestamp' => round(microtime(true) * 1000),
            'response'  => 'json',
        ];

        $base    = $this->urlApi;

The property urlApi does not exist. Did you maybe forget to declare it?

        $method  = $this->getCommandMethod($command);

It seems like getCommandMethod() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $query   = $this->enableSso()->getCommandQuery($params);

It seems like enableSso() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $url     = $this->appendQuery($base, $query);

It seems like appendQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $request = $this->getRequest($method, $url);

It seems like getRequest() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $login = $this->getResponse($request);

It seems like getResponse() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Prepare a signed request for the Console url.
        // Effectively this will be the console url, it won't be requested at the Cloudstack API.
        $params = [
            'cmd'        => 'access',
            'vm'         => $virtualMachineId,
            'userid'     => $login['loginresponse']['userid'],
            'sessionkey' => $login['loginresponse']['sessionkey'],
            'timestamp'  => round(microtime(true) * 1000),
            'apikey'     => $this->apiKey,

The property apiKey does not exist. Did you maybe forget to declare it?

        ];

        $base = $this->urlConsole;
        $query = $this->getCommandQuery($params);

It seems like getCommandQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this->appendQuery($base, $query);

It seems like appendQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}