SiteInstances::get() - Code Metrics - Inspection of "CLI-1540: Added Multiple endpoints in Codebases an..." - typhonius/acquia-php-sdk-v2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 62dee2...4b8e5c )

by Dane

created 2025-07-25 16:13 UTC

SiteInstances::get() A

↳ Parent: SiteInstances

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace AcquiaCloudApi\Endpoints;

use AcquiaCloudApi\Response\BackupResponse;
use AcquiaCloudApi\Response\BackupsResponse;
use AcquiaCloudApi\Response\DomainResponse;
use AcquiaCloudApi\Response\DomainsResponse;
use AcquiaCloudApi\Response\OperationResponse;
use AcquiaCloudApi\Response\SiteInstanceResponse;
use AcquiaCloudApi\Response\SiteInstanceDatabaseResponse;

/**
 * Class SiteInstances
 *
 * @package AcquiaCloudApi\CloudApi
 */
class SiteInstances extends CloudApiBase
{
    /**
     * Returns details about a specific site instance.
     */
    public function get(string $siteId, string $environmentId): SiteInstanceResponse
    {
        return new SiteInstanceResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId"
            )
        );
    }

    /**
     * Returns database details for a site instance.
     */
    public function getDatabase(string $siteId, string $environmentId): SiteInstanceDatabaseResponse
    {
        return new SiteInstanceDatabaseResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/database"
            )
        );
    }

    /**
     * Copies database from source environment to target environment.
     */
    public function copyDatabase(string $siteId, string $environmentId, string $sourceEnvironmentId): OperationResponse
    {
        $options = [
            'json' => [
                'source' => $sourceEnvironmentId,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
                'post',
                "/api/site-instances/$siteId.$environmentId/database",
                $options
            )
        );
    }

    /**
     * Returns a list of database backups for a site instance.
     *
     * @return BackupsResponse<BackupResponse>
     */
    public function getDatabaseBackups(string $siteId, string $environmentId): BackupsResponse
    {
        return new BackupsResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/database/backups"
            )
        );
    }

    /**
     * Creates a database backup for a site instance.
     */
    public function createDatabaseBackup(string $siteId, string $environmentId): OperationResponse
    {
        return new OperationResponse(
            $this->client->request(
                'post',
                "/api/site-instances/$siteId.$environmentId/database/backups"
            )
        );
    }

    /**
     * Returns details about a specific database backup.
     */
    public function getDatabaseBackup(string $siteId, string $environmentId, string $backupId): BackupResponse
    {
        return new BackupResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/database/backups/$backupId"
            )
        );
    }

    /**
     * Downloads a database backup.
     */
    public function downloadDatabaseBackup(string $siteId, string $environmentId, string $backupId): OperationResponse
    {
        return new OperationResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/database/backups/$backupId/actions/download"
            )
        );
    }

    /**
     * Restores a database backup.
     */
    public function restoreDatabaseBackup(string $siteId, string $environmentId, string $backupId): OperationResponse
    {
        return new OperationResponse(
            $this->client->request(
                'post',
                "/api/site-instances/$siteId.$environmentId/database/backups/$backupId/actions/restore"
            )
        );
    }

    /**
     * Returns a list of domains for a site instance.
     *
     * @return DomainsResponse<DomainResponse>
     */
    public function getDomains(string $siteId, string $environmentId): DomainsResponse
    {
        return new DomainsResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/domains"
            )
        );
    }

    /**
     * Returns details about a specific domain for a site instance.
     */
    public function getDomain(string $siteId, string $environmentId, string $domainName): DomainResponse
    {
        return new DomainResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/domains/$domainName"
            )
        );
    }

    /**
     * Returns the status of a specific domain for a site instance.
     */
    public function getDomainStatus(string $siteId, string $environmentId, string $domainName): DomainResponse
    {
        return new DomainResponse(
            $this->client->request(
                'get',
                "/api/site-instances/$siteId.$environmentId/domains/$domainName/status"
            )
        );
    }

    /**
     * Copies files from source environment to target environment.
     */
    public function copyFiles(string $siteId, string $environmentId, string $sourceEnvironmentId): OperationResponse
    {
        $options = [
            'json' => [
                'source' => $sourceEnvironmentId,
            ],
        ];

        return new OperationResponse(
            $this->client->request(
                'post',
                "/api/site-instances/$siteId.$environmentId/files",
                $options
            )
        );
    }
}


1			<?php
2
3			namespace AcquiaCloudApi\Endpoints;
4
5			use AcquiaCloudApi\Response\BackupResponse;
6			use AcquiaCloudApi\Response\BackupsResponse;
7			use AcquiaCloudApi\Response\DomainResponse;
8			use AcquiaCloudApi\Response\DomainsResponse;
9			use AcquiaCloudApi\Response\OperationResponse;
10			use AcquiaCloudApi\Response\SiteInstanceResponse;
11			use AcquiaCloudApi\Response\SiteInstanceDatabaseResponse;
12
13			/**
14			* Class SiteInstances
15			*
16			* @package AcquiaCloudApi\CloudApi
17			*/
18			class SiteInstances extends CloudApiBase
19			{
20			/**
21			* Returns details about a specific site instance.
22			*/
23			public function get(string $siteId, string $environmentId): SiteInstanceResponse
24			{
25			return new SiteInstanceResponse(
26			$this->client->request(
27			'get',
28			"/api/site-instances/$siteId.$environmentId"
29			)
30			);
31			}
32
33			/**
34			* Returns database details for a site instance.
35			*/
36			public function getDatabase(string $siteId, string $environmentId): SiteInstanceDatabaseResponse
37			{
38			return new SiteInstanceDatabaseResponse(
39			$this->client->request(
40			'get',
41			"/api/site-instances/$siteId.$environmentId/database"
42			)
43			);
44			}
45
46			/**
47			* Copies database from source environment to target environment.
48			*/
49			public function copyDatabase(string $siteId, string $environmentId, string $sourceEnvironmentId): OperationResponse
50			{
51			$options = [
52			'json' => [
53			'source' => $sourceEnvironmentId,
54			],
55			];
56
57			return new OperationResponse(
58			$this->client->request(
59			'post',
60			"/api/site-instances/$siteId.$environmentId/database",
61			$options
62			)
63			);
64			}
65
66			/**
67			* Returns a list of database backups for a site instance.
68			*
69			* @return BackupsResponse<BackupResponse>
70			*/
71			public function getDatabaseBackups(string $siteId, string $environmentId): BackupsResponse
72			{
73			return new BackupsResponse(
74			$this->client->request(
75			'get',
76			"/api/site-instances/$siteId.$environmentId/database/backups"
77			)
78			);
79			}
80
81			/**
82			* Creates a database backup for a site instance.
83			*/
84			public function createDatabaseBackup(string $siteId, string $environmentId): OperationResponse
85			{
86			return new OperationResponse(
87			$this->client->request(
88			'post',
89			"/api/site-instances/$siteId.$environmentId/database/backups"
90			)
91			);
92			}
93
94			/**
95			* Returns details about a specific database backup.
96			*/
97			public function getDatabaseBackup(string $siteId, string $environmentId, string $backupId): BackupResponse
98			{
99			return new BackupResponse(
100			$this->client->request(
101			'get',
102			"/api/site-instances/$siteId.$environmentId/database/backups/$backupId"
103			)
104			);
105			}
106
107			/**
108			* Downloads a database backup.
109			*/
110			public function downloadDatabaseBackup(string $siteId, string $environmentId, string $backupId): OperationResponse
111			{
112			return new OperationResponse(
113			$this->client->request(
114			'get',
115			"/api/site-instances/$siteId.$environmentId/database/backups/$backupId/actions/download"
116			)
117			);
118			}
119
120			/**
121			* Restores a database backup.
122			*/
123			public function restoreDatabaseBackup(string $siteId, string $environmentId, string $backupId): OperationResponse
124			{
125			return new OperationResponse(
126			$this->client->request(
127			'post',
128			"/api/site-instances/$siteId.$environmentId/database/backups/$backupId/actions/restore"
129			)
130			);
131			}
132
133			/**
134			* Returns a list of domains for a site instance.
135			*
136			* @return DomainsResponse<DomainResponse>
137			*/
138			public function getDomains(string $siteId, string $environmentId): DomainsResponse
139			{
140			return new DomainsResponse(
141			$this->client->request(
142			'get',
143			"/api/site-instances/$siteId.$environmentId/domains"
144			)
145			);
146			}
147
148			/**
149			* Returns details about a specific domain for a site instance.
150			*/
151			public function getDomain(string $siteId, string $environmentId, string $domainName): DomainResponse
152			{
153			return new DomainResponse(
154			$this->client->request(
155			'get',
156			"/api/site-instances/$siteId.$environmentId/domains/$domainName"
157			)
158			);
159			}
160
161			/**
162			* Returns the status of a specific domain for a site instance.
163			*/
164			public function getDomainStatus(string $siteId, string $environmentId, string $domainName): DomainResponse
165			{
166			return new DomainResponse(
167			$this->client->request(
168			'get',
169			"/api/site-instances/$siteId.$environmentId/domains/$domainName/status"
170			)
171			);
172			}
173
174			/**
175			* Copies files from source environment to target environment.
176			*/
177			public function copyFiles(string $siteId, string $environmentId, string $sourceEnvironmentId): OperationResponse
178			{
179			$options = [
180			'json' => [
181			'source' => $sourceEnvironmentId,
182			],
183			];
184
185			return new OperationResponse(
186			$this->client->request(
187			'post',
188			"/api/site-instances/$siteId.$environmentId/files",
189			$options
190			)
191			);
192			}
193			}
194

typhonius / acquia-php-sdk-v2

Push — master ( 62dee2...4b8e5c )

SiteInstances::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like