Environments::getDomain() - Code Metrics - Inspection of "Restructures library to break down the Client clas..." - typhonius/acquia-php-sdk-v2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#34)

by Adam
created 2019-12-04 10:31 UTC
Environments::getDomain() A

↳ Parent: Environments
Complexity

Conditions	1
Paths	1
Size

Total Lines	6
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	4
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
<?php

namespace AcquiaCloudApi\Endpoints;

use AcquiaCloudApi\Connector\ClientInterface;
use AcquiaCloudApi\Response\EnvironmentResponse;
use AcquiaCloudApi\Response\EnvironmentsResponse;
use AcquiaCloudApi\Response\DatabasesResponse;
use AcquiaCloudApi\Response\CronsResponse;
use AcquiaCloudApi\Response\CronResponse;
use AcquiaCloudApi\Response\CertificatesResponse;
use AcquiaCloudApi\Response\CertificateResponse;
use AcquiaCloudApi\Response\BackupsResponse;
use AcquiaCloudApi\Response\BackupResponse;
use AcquiaCloudApi\Response\DomainsResponse;
use AcquiaCloudApi\Response\DomainResponse;
use AcquiaCloudApi\Response\InsightsResponse;
use AcquiaCloudApi\Response\ServersResponse;
use AcquiaCloudApi\Response\OperationResponse;
use AcquiaCloudApi\Response\LogstreamResponse;
use AcquiaCloudApi\Response\LogForwardingDestinationsResponse;
use AcquiaCloudApi\Response\LogForwardingDestinationResponse;

/**
 * Class Client
 * @package AcquiaCloudApi\CloudApi
 */
class Environments implements CloudApi
{

    /** @var ClientInterface The API client. */
    protected $client;

    /**
     * Client constructor.
     *
     * @param ClientInterface $client
     */
    public function __construct(ClientInterface $client)
    {
        $this->client = $client;
    }

    /**
     * Shows all databases in an environment.
     *
     * @param string $environmentUuid
     * @return DatabasesResponse
     */
    public function getDatabases($environmentUuid)
    {
        return new DatabasesResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/databases"
            )
        );
    }

    /**
     * Copies a database from an environment to an environment.
     *
     * @param string $environmentFromUuid
     * @param string $dbName
     * @param string $environmentToUuid
     * @return OperationResponse
     */
    public function databaseCopy($environmentFromUuid, $dbName, $environmentToUuid)
    {
        $options = [
            'form_params' => [
                'name' => $dbName,
                'source' => $environmentFromUuid,
            ],
        ];

        return new OperationResponse(
            $this->client->request('post', "/environments/${environmentToUuid}/databases", $options)
            /** @scrutinizer ignore-type */ $this->client->request('post', "/environments/${environmentToUuid}/databases", $options)
        );
    }

    /**
     * Backup a database.
     *
     * @param string $environmentUuid
     * @param string $dbName
     * @return OperationResponse
     */
    public function createDatabaseBackup($environmentUuid, $dbName)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/databases/${dbName}/backups"
            )
        );
    }

    /**
     * Shows all database backups in an environment.
     *
     * @param string $environmentUuid
     * @param string $dbName
     * @return BackupsResponse
     */
    public function getDatabaseBackups($environmentUuid, $dbName)
    {
        return new BackupsResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/databases/${dbName}/backups"
            )
        );
    }

    /**
     * Gets information about a database backup.
     *
     * @param string $environmentUuid
     * @param string $dbName
     * @param int    $backupId
     * @return BackupResponse
     */
    public function getDatabaseBackup($environmentUuid, $dbName, $backupId)
    {
        return new BackupResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/databases/${dbName}/backups/${backupId}"
            )
        );
    }

    /**
     * Restores a database backup to a database in an environment.
     *
     * @param string $environmentUuid
     * @param string $dbName
     * @param int    $backupId
     * @return OperationResponse
     */
    public function restoreDatabaseBackup($environmentUuid, $dbName, $backupId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/databases/${dbName}/backups/${backupId}/actions/restore"
            )
        );
    }

    /**
     * Copies files from an environment to another environment.
     *
     * @param string $environmentUuidFrom
     * @param string $environmentUuidTo
     * @return OperationResponse
     */
    public function copyFiles($environmentUuidFrom, $environmentUuidTo)
    {
        $options = [
            'form_params' => [
                'source' => $environmentUuidFrom,
            ],
        ];

        return new OperationResponse(
            $this->client->request('post', "/environments/${environmentUuidTo}/files", $options)
            /** @scrutinizer ignore-type */ $this->client->request('post', "/environments/${environmentUuidTo}/files", $options)
        );
    }

    /**
     * Deploys a code branch/tag to an environment.
     *
     * @param string $environmentUuid
     * @param string $branch
     * @return OperationResponse
     */
    public function switchCode($environmentUuid, $branch)
    {

        $options = [
            'form_params' => [
                'branch' => $branch,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/code/actions/switch",
                $options
            )
        );
    }

    /**
     * Deploys code from one environment to another environment.
     *
     * @param string $environmentFromUuid
     * @param string $environmentToUuid
     * @param string $commitMessage
     */
    public function deployCode($environmentFromUuid, $environmentToUuid, $commitMessage = null)
    {

        $options = [
            'form_params' => [
                'source' => $environmentFromUuid,
                'message' => $commitMessage,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentToUuid}/code",
                $options
            )
        );
    }

    /**
     * Shows all domains on an environment.
     *
     * @param string $environmentUuid
     * @return DomainsResponse
     */
    public function getDomains($environmentUuid)
    {
        return new DomainsResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/domains"
            )
        );
    }

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

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

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

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

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

    /**
     * Purges varnish for selected domains in an environment.
     *
     * @param string $environmentUuid
     * @param array  $domains
     * @return OperationResponse
     */
    public function purgeVarnishCache($environmentUuid, array $domains)
    {

        $options = [
            'form_params' => [
                'domains' => $domains,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/domains/actions/clear-varnish",
                $options
            )
        );
    }

    /**
     * Gets information about an environment.
     *
     * @param string $environmentUuid
     * @return EnvironmentResponse
     */
    public function getEnvironment($environmentUuid)
    {
        return new EnvironmentResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}"
            )
        );
    }

    /**
     * Modifies configuration settings for an environment.
     *
     * @param string $environmentUuid
     * @param array $config
     * @return OperationResponse
     */
    public function modifyEnvironment($environmentUuid, array $config)
    {

        $options = [
          'form_params' => $config,
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'put',
                "/environments/${environmentUuid}",
                $options
            )
        );
    }

    /**
     * Renames an environment.
     *
     * @param string $environmentUuid
     * @param string $label
     * @return OperationResponse
     */
    public function renameEnvironment($environmentUuid, $label)
    {

        $options = [
            'form_params' => [
                'label' => $label,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/actions/change-label",
                $options
            )
        );
    }

    /**
     * Show all servers associated with an environment.
     *
     * @param string $environmentUuid
     * @return ServersResponse
     */
    public function getServers($environmentUuid)
    {
        return new ServersResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/servers"
            )
        );
    }

    /**
     * Enable livedev mode for an environment.
     *
     * @param string $environmentUuid
     * @return OperationResponse
     */
    public function enableLiveDev($environmentUuid)
    {
        return new OperationResponse(
            $this->client->request('post', "/environments/${environmentUuid}/livedev/actions/enable")
            /** @scrutinizer ignore-type */ $this->client->request('post', "/environments/${environmentUuid}/livedev/actions/enable")
        );
    }

    /**
     * Disable livedev mode for an environment.
     *
     * @param string $environmentUuid
     * @return OperationResponse
     */
    public function disableLiveDev($environmentUuid)
    {

        $options = [
            'form_params' => [
                'discard' => 1,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/livedev/actions/disable",
                $options
            )
        );
    }

    /**
     * Enable production mode for an environment.
     *
     * @param string $environmentUuid
     * @return OperationResponse
     */
    public function enableProductionMode($environmentUuid)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/production-mode/actions/enable"
            )
        );
    }

    /**
     * Disable production mode for an environment.
     *
     * @param string $environmentUuid
     * @return OperationResponse
     */
    public function disableProductionMode($environmentUuid)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/production-mode/actions/disable"
            )
        );
    }

    /**
     * Show all cron tasks for an environment.
     *
     * @param string $environmentUuid The environment ID
     * @return CronsResponse
     */
    public function getCrons($environmentUuid)
    {
        return new CronsResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/crons"
            )
        );
    }

    /**
     * Get information about a cron task.
     *
     * @param string $environmentUuid The environment ID
     * @param int    $cronId
     * @return CronResponse
     */
    public function getCron($environmentUuid, $cronId)
    {
        return new CronResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/crons/${cronId}"
            )
        );
    }

    /**
     * Add a cron task.
     *
     * @param string $environmentUuid
     * @param string $command
     * @param string $frequency
     * @param string $label
     * @return OperationResponse
     */
    public function createCron($environmentUuid, $command, $frequency, $label)
    {

        $options = [
            'form_params' => [
                'command' => $command,
                'frequency' => $frequency,
                'label' => $label,
            ],
        ];

        return new OperationResponse(
            $this->client->request('post', "/environments/${environmentUuid}/crons", $options)
            /** @scrutinizer ignore-type */ $this->client->request('post', "/environments/${environmentUuid}/crons", $options)
        );
    }

    /**
     * Delete a cron task.
     *
     * @param string $environmentUuid
     * @param int    $cronId
     * @return OperationResponse
     */
    public function deleteCron($environmentUuid, $cronId)
    {
        return new OperationResponse(
            $this->client->request('delete', "/environments/${environmentUuid}/crons/${cronId}")
            /** @scrutinizer ignore-type */ $this->client->request('delete', "/environments/${environmentUuid}/crons/${cronId}")
        );
    }

    /**
     * Disable a cron task.
     *
     * @param string $environmentUuid
     * @param int    $cronId
     * @return OperationResponse
     */
    public function disableCron($environmentUuid, $cronId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/crons/${cronId}/actions/disable"
            )
        );
    }

    /**
     * Enable a cron task.
     *
     * @param string $environmentUuid
     * @param int    $cronId
     * @return OperationResponse
     */
    public function enableCron($environmentUuid, $cronId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/crons/${cronId}/actions/enable"
            )
        );
    }

    /**
     * Show insights data from a specific environment.
     *
     * @param string $environmentUuid
     * @return InsightsResponse
     */
    public function getInsights($environmentUuid)
    {
        return new InsightsResponse(
            $this->client->request('get', "/environments/${environmentUuid}/insight")
            /** @scrutinizer ignore-type */ $this->client->request('get', "/environments/${environmentUuid}/insight")
        );
    }

    /**
     * Returns logstream WSS stream information.
     *
     * @return LogstreamResponse
     */
    public function getLogstream($environmentUuid)
    {
        return new LogstreamResponse(
            $this->client->request('get', "/environments/${environmentUuid}/logstream")
            /** @scrutinizer ignore-type */ $this->client->request('get', "/environments/${environmentUuid}/logstream")
        );
    }

    /**
     * Returns a list of SSL certificates.
     *
     * @param string $environmentUuid The environment ID
     * @return CertificatesResponse
     */
    public function getSslCertificates($environmentUuid)
    {
        return new CertificatesResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/ssl/certificates"
            )
        );
    }

    /**
     * Returns a specific certificate by certificate ID.
     *
     * @param string $environmentUuid The environment ID
     * @param int    $certificateId
     * @return CertificateResponse
     */
    public function getSslCertificate($environmentUuid, $certificateId)
    {
        return new CertificateResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/ssl/certificates/${certificateId}"
            )
        );
    }

    /**
     * Install an SSL certificate.
     *
     * @param string $envUuid
     * @param string $label
     * @param string $cert
     * @param string $key
     * @param string $ca
     * @param int    $csr
     * @param bool   $legacy
     * @return OperationResponse
     */
    public function createSslCertificate($envUuid, $label, $cert, $key, $ca = null, $csr = null, $legacy = false)
    public function createSslCertificate($envUuid, $label, $cert, $key, $ca = null, $csr = null, /** @scrutinizer ignore-unused */ $legacy = false)
    {

        $options = [
            'form_params' => [
                'label' => $label,
                'certificate' => $cert,
                'private_key' => $key,
            ],
        ];

        if ($ca) {
            $options['form_params']['ca_certificates'] = $ca;
        }
        if ($csr) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $options['form_params']['csr_id'] = $csr;
        }

        return new OperationResponse(
            $this->client->request('post', "/environments/${envUuid}/ssl/certificates", $options)
            /** @scrutinizer ignore-type */ $this->client->request('post', "/environments/${envUuid}/ssl/certificates", $options)
        );
    }

    /**
     * Delete a specific certificate by ID.
     *
     * @param string $environmentUuid
     * @param int    $certificateId
     * @return OperationResponse
     */
    public function deleteSslCertificate($environmentUuid, $certificateId)
    {
        return new OperationResponse(
            $this->client->request('delete', "/environments/${environmentUuid}/ssl/certificates/${certificateId}")
            /** @scrutinizer ignore-type */ $this->client->request('delete', "/environments/${environmentUuid}/ssl/certificates/${certificateId}")
        );
    }

    /**
     * Deactivates an active SSL certificate.
     *
     * @param string $environmentUuid
     * @param int    $certificateId
     * @return OperationResponse
     */
    public function deactivateSslCertificate($environmentUuid, $certificateId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/ssl/certificate/${certificateId}/actions/deactivate"
            )
        );
    }

    /**
     * Activates an SSL certificate.
     *
     * @param string $environmentUuid
     * @param int    $certificateId
     * @return OperationResponse
     */
    public function activateSslCertificate($environmentUuid, $certificateId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/ssl/certificate/${certificateId}/actions/activate"
            )
        );
    }

   /**
    * Returns a list of log forwarding destinations.
    *
    * @param string $environmentUuid The environment ID
    * @return LogForwardingDestinationsResponse
    */
    public function getLogDestinations($environmentUuid)
    {
        return new LogForwardingDestinationsResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/log-forwarding-destinations"
            )
        );
    }

   /**
    * Returns a specific log forwarding destination.
    *
    * @param string $environmentUuid The environment ID
    * @param int    $destinationId
    * @return LogForwardingDestinationResponse
    */
    public function getLogDestination($environmentUuid, $destinationId)
    {
        return new LogForwardingDestinationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'get',
                "/environments/${environmentUuid}/log-forwarding-destinations/${destinationId}"
            )
        );
    }

   /**
    * Creates a log forwarding destination.
    *
    * @param string $environmentUuid
    * @param string $label
    * @param array  $sources
    * @param string $consumer
    * @param array  $credentials
    * @param string $address
    * @return OperationResponse
    */
    public function createLogDestination($environmentUuid, $label, $sources, $consumer, $credentials, $address)
    {

        $options = [
            'form_params' => [
                'label' => $label,
                'sources' => $sources,
                'consumer' => $consumer,
                'credentials' => $credentials,
                'address' => $address
            ],
        ];

        return new OperationResponse(
            $this->client->request('post', "/environments/${environmentUuid}/log-forwarding-destinations", $options)
            /** @scrutinizer ignore-type */ $this->client->request('post', "/environments/${environmentUuid}/log-forwarding-destinations", $options)
        );
    }

   /**
    * Delete a specific log forwarding destination.
    *
    * @param string $environmentUuid
    * @param int    $destId
    * @return OperationResponse
    */
    public function deleteLogDestination($environmentUuid, $destId)
    {
        return new OperationResponse(
            $this->client->request('delete', "/environments/${environmentUuid}/log-forwarding-destinations/${destId}")
            /** @scrutinizer ignore-type */ $this->client->request('delete', "/environments/${environmentUuid}/log-forwarding-destinations/${destId}")
        );
    }

   /**
    * Disables a log forwarding destination.
    *
    * @param string $environmentUuid
    * @param int    $destId
    * @return OperationResponse
    */
    public function disableLogDestination($environmentUuid, $destId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/log-forwarding-destinations/${destId}/actions/disable"
            )
        );
    }

   /**
    * Disables a log forwarding destination.
    *
    * @param string $environmentUuid
    * @param int    $destId
    * @return OperationResponse
    */
    public function enableLogDestination($environmentUuid, $destId)
    {
        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'post',
                "/environments/${environmentUuid}/log-forwarding-destinations/${destId}/actions/enable"
            )
        );
    }

   /**
    * Updates a log forwarding destination.
    *
    * @param string $environmentUuid
    * @param int    $destId
    * @param string $label
    * @param array  $sources
    * @param string $consumer
    * @param array  $creds
    * @param string $address
    * @return OperationResponse
    */
    public function updateLogDestination($environmentUuid, $destId, $label, $sources, $consumer, $creds, $address)
    {

        $options = [
            'form_params' => [
                'label' => $label,
                'sources' => $sources,
                'consumer' => $consumer,
                'credentials' => $creds,
                'address' => $address
            ],
        ];

        return new OperationResponse(
            $this->client->request(
            /** @scrutinizer ignore-type */ $this->client->request(
                'put',
                "/environments/${environmentUuid}/log-forwarding-destinations/${destId}",
                $options
            )
        );
    }
}

typhonius / acquia-php-sdk-v2

Pull Request — master (#34)

Environments::getDomain() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
