AcquiaCloudApi\Endpoints\Domains

Complexity

Total Complexity

8

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	delete()	0	4	1
A	getAll()	0	6	1
A	create()	0	11	1
A	get()	0	6	1
A	purge()	0	13	1
A	metrics()	0	6	1
A	status()	0	6	1
A	clearDomainCache()	0	6	1

<?php

namespace AcquiaCloudApi\Endpoints;

use AcquiaCloudApi\Response\DomainsResponse;
use AcquiaCloudApi\Response\DomainResponse;
use AcquiaCloudApi\Response\OperationResponse;
use AcquiaCloudApi\Response\MetricsResponse;
use AcquiaCloudApi\Response\MetricResponse;

/**
 * Class Domains
 *
 * @package AcquiaCloudApi\CloudApi
 */
class Domains extends CloudApiBase implements CloudApiInterface
{

    /**
     * Shows all domains on an environment.
     *
     * @param  string $environmentUuid
     * @return DomainsResponse<DomainResponse>
     */
    public function getAll($environmentUuid): DomainsResponse
    {
        return new DomainsResponse(
            $this->client->request(

It seems like $this->client->request('get', '/environments/'.$environmentUuid.'/domains') can also be of type AcquiaCloudApi\Connector\StreamInterface; however, parameter $domains of AcquiaCloudApi\Response\DomainsResponse::__construct() does only seem to accept array<mixed,object>, maybe add an additional type check?

                'get',
                "/environments/${environmentUuid}/domains"
            )
        );
    }

    /**
     * Return details about a domain.
     *
     * @param  string $environmentUuid
     * @param  string $domain
     * @return DomainResponse
     */
    public function get($environmentUuid, $domain): DomainResponse
    {
        return new DomainResponse(
            $this->client->request(
                'get',
                "/environments/${environmentUuid}/domains/${domain}"
            )
        );
    }

    /**
     * Adds a domain to an environment.
     *
     * @param  string $environmentUuid
     * @param  string $hostname
     * @return OperationResponse
     */
    public function create($environmentUuid, $hostname): OperationResponse
    {

        $options = [
            'json' => [
                'hostname' => $hostname,
            ],
        ];

        return new OperationResponse(
            $this->client->request('post', "/environments/${environmentUuid}/domains", $options)
        );
    }

    /**
     * Deletes a domain from an environment.
     *
     * @param  string $environmentUuid
     * @param  string $domain
     * @return OperationResponse
     */
    public function delete($environmentUuid, $domain): OperationResponse
    {
        return new OperationResponse(
            $this->client->request('delete', "/environments/${environmentUuid}/domains/${domain}")
        );
    }

    /**
     * Purges cache for selected domains in an environment.
     *
     * @param  string        $environmentUuid
     * @param  array<string> $domains
     * @return OperationResponse
     */
    public function purge($environmentUuid, array $domains): OperationResponse
    {
        $options = [
            'json' => [
                'domains' => $domains,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
                'post',
                "/environments/${environmentUuid}/actions/clear-caches",
                $options
            )
        );
    }

    /**
     * Purges cache for a single domain in an environment.
     *
     * @param  string        $environmentUuid
     * @param  string        $domain
     * @return OperationResponse
     */
    public function clearDomainCache($environmentUuid, $domain): OperationResponse
    {
        return new OperationResponse(
            $this->client->request(
                'post',
                "/environments/${environmentUuid}/domains/${domain}/actions/clear-caches"
            )
        );
    }

    /**
     * Retrieves the scan data for a domain name that is part of this environment.
     *
     * @param  string $environmentUuid
     * @param  string $domain
     * @return MetricsResponse<MetricResponse>
     */
    public function metrics($environmentUuid, $domain): MetricsResponse
    {
        return new MetricsResponse(
            $this->client->request(

It seems like $this->client->request('get', '/environments/'.$environmentUuid.'/domains/'.$domain.'/metrics/uptime') can also be of type AcquiaCloudApi\Connector\StreamInterface; however, parameter $metrics of AcquiaCloudApi\Response\MetricsResponse::__construct() does only seem to accept array<mixed,object>, maybe add an additional type check?

                'get',
                "/environments/${environmentUuid}/domains/${domain}/metrics/uptime"
            )
        );
    }

    /**
     * Returns details about the domain.
     *
     * @param  string $environmentUuid
     * @param  string $domain
     * @return DomainResponse
     */
    public function status($environmentUuid, $domain): DomainResponse
    {
        return new DomainResponse(
            $this->client->request(
                'get',
                "/environments/${environmentUuid}/domains/${domain}/status"
            )
        );
    }
}