Skip to content

Commit 02c256e

Browse files
jbrooksukgithub-actions[bot]
jbrooksuk
authored and
github-actions[bot]
committed
Update facade docblocks
1 parent 777b254 commit 02c256e

File tree

1 file changed

+99
-99
lines changed

1 file changed

+99
-99
lines changed

‎src/Facades/Forge.php

+99-99
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,99 @@
1010
* @method static \Laravel\Forge\Forge setTimeout(int $timeout)
1111
* @method static int getTimeout()
1212
* @method static \Laravel\Forge\Resources\User user()
13-
* @method static mixed get(string $uri)
14-
* @method static mixed post(string $uri, array $payload = [])
15-
* @method static mixed put(string $uri, array $payload = [])
16-
* @method static mixed delete(string $uri, array $payload = [])
17-
* @method static mixed retry(int $timeout, callable $callback, int $sleep = 5)
13+
* @method static \Laravel\Forge\Resources\BackupConfiguration[] backupConfigurations(string $serverId)
14+
* @method static \Laravel\Forge\Resources\BackupConfiguration backupConfiguration(string $serverId, string $backupConfigurationId)
15+
* @method static \Laravel\Forge\Resources\BackupConfiguration createBackupConfiguration(string $serverId, array $data)
16+
* @method static \Laravel\Forge\Resources\BackupConfiguration updateBackupConfiguration(int $serverId, int $backupConfigurationId, array $data)
17+
* @method static void deleteBackupConfiguration(string $serverId, string $backupConfigurationId)
18+
* @method static void restoreBackup(string $serverId, string $backupConfigurationId, string $backupId)
19+
* @method static void deleteBackup(string $serverId, string $backupConfigurationId, string $backupId)
20+
* @method static \Laravel\Forge\Resources\Certificate[] certificates(int $serverId, int $siteId)
21+
* @method static \Laravel\Forge\Resources\Certificate certificate(int $serverId, int $siteId, int $certificateId)
22+
* @method static \Laravel\Forge\Resources\Certificate createCertificate(int $serverId, int $siteId, array $data, bool $wait = true)
23+
* @method static void deleteCertificate(int $serverId, int $siteId, int $certificateId)
24+
* @method static string getCertificateSigningRequest(int $serverId, int $siteId, int $certificateId)
25+
* @method static void installCertificate(int $serverId, int $siteId, int $certificateId, array $data, bool $wait = true)
26+
* @method static void activateCertificate(int $serverId, int $siteId, int $certificateId, bool $wait = true)
27+
* @method static \Laravel\Forge\Resources\Certificate obtainLetsEncryptCertificate(int $serverId, int $siteId, array $data, bool $wait = true)
28+
* @method static \Laravel\Forge\Resources\Credential[] credentials()
29+
* @method static \Laravel\Forge\Resources\Daemon[] daemons(int $serverId)
30+
* @method static \Laravel\Forge\Resources\Daemon daemon(int $serverId, int $daemonId)
31+
* @method static \Laravel\Forge\Resources\Daemon createDaemon(int $serverId, array $data, bool $wait = true)
32+
* @method static void restartDaemon(int $serverId, int $daemonId, bool $wait = true)
33+
* @method static void deleteDaemon(int $serverId, int $daemonId)
34+
* @method static \Laravel\Forge\Resources\Database[] databases(int $serverId)
35+
* @method static \Laravel\Forge\Resources\Database database(int $serverId, int $databaseId)
36+
* @method static \Laravel\Forge\Resources\Database createDatabase(int $serverId, array $data, bool $wait = true)
37+
* @method static \Laravel\Forge\Resources\Database updateDatabase(int $serverId, int $databaseId, array $data)
38+
* @method static void deleteDatabase(int $serverId, int $databaseId)
39+
* @method static void syncDatabases(int $serverId)
40+
* @method static \Laravel\Forge\Resources\DatabaseUser[] databaseUsers(int $serverId)
41+
* @method static \Laravel\Forge\Resources\DatabaseUser databaseUser(int $serverId, int $userId)
42+
* @method static \Laravel\Forge\Resources\DatabaseUser createDatabaseUser(int $serverId, array $data, bool $wait = true)
43+
* @method static \Laravel\Forge\Resources\DatabaseUser updateDatabaseUser(int $serverId, int $userId, array $data)
44+
* @method static void deleteDatabaseUser(int $serverId, int $userId)
45+
* @method static \Laravel\Forge\Resources\FirewallRule[] firewallRules(int $serverId)
46+
* @method static \Laravel\Forge\Resources\FirewallRule firewallRule(int $serverId, int $ruleId)
47+
* @method static \Laravel\Forge\Resources\FirewallRule createFirewallRule(int $serverId, array $data, bool $wait = true)
48+
* @method static void deleteFirewallRule(int $serverId, int $ruleId)
1849
* @method static \Laravel\Forge\Resources\Job[] jobs(int $serverId)
1950
* @method static \Laravel\Forge\Resources\Job job(int $serverId, int $jobId)
2051
* @method static \Laravel\Forge\Resources\Job createJob(int $serverId, array $data, bool $wait = true)
2152
* @method static void deleteJob(int $serverId, int $jobId)
53+
* @method static \Laravel\Forge\Resources\Monitor[] monitors(int $serverId)
54+
* @method static \Laravel\Forge\Resources\Monitor monitor(int $serverId, int $monitorId)
55+
* @method static \Laravel\Forge\Resources\Monitor createMonitor(int $serverId, array $data)
56+
* @method static void deleteMonitor(int $serverId, int $monitorId)
57+
* @method static \Laravel\Forge\Resources\NginxTemplate[] nginxTemplates(int $serverId)
58+
* @method static \Laravel\Forge\Resources\NginxTemplate nginxTemplate(int $serverId, int $templateId)
59+
* @method static \Laravel\Forge\Resources\NginxTemplate nginxDefaultTemplate(int $serverId)
60+
* @method static \Laravel\Forge\Resources\NginxTemplate createNginxTemplate(int $serverId, array $data, bool $wait = true)
61+
* @method static \Laravel\Forge\Resources\NginxTemplate updateNginxTemplate(int $serverId, int $templateId, array $data)
62+
* @method static void deleteNginxTemplate(int $serverId, int $templateId)
63+
* @method static \Laravel\Forge\Resources\Recipe[] recipes()
64+
* @method static \Laravel\Forge\Resources\Recipe recipe(string $recipeId)
65+
* @method static \Laravel\Forge\Resources\Recipe createRecipe(array $data)
66+
* @method static \Laravel\Forge\Resources\Recipe updateRecipe(string $recipeId, array $data)
67+
* @method static void deleteRecipe(string $recipeId)
68+
* @method static void runRecipe(string $recipeId, array $data)
69+
* @method static \Laravel\Forge\Resources\RedirectRule[] redirectRules(int $serverId, int $siteId)
70+
* @method static \Laravel\Forge\Resources\RedirectRule redirectRule(int $serverId, int $siteId, int $ruleId)
71+
* @method static \Laravel\Forge\Resources\RedirectRule createRedirectRule(int $serverId, int $siteId, array $data, bool $wait = true)
72+
* @method static void deleteRedirectRule(int $serverId, int $siteId, int $ruleId)
73+
* @method static \Laravel\Forge\Resources\SecurityRule[] securityRules(int $serverId, int $siteId)
74+
* @method static \Laravel\Forge\Resources\SecurityRule securityRule(int $serverId, int $siteId, int $ruleId)
75+
* @method static \Laravel\Forge\Resources\SecurityRule createSecurityRule(int $serverId, int $siteId, array $data, bool $wait = true)
76+
* @method static void deleteSecurityRule(int $serverId, int $siteId, int $ruleId)
77+
* @method static \Laravel\Forge\Resources\Server[] servers()
78+
* @method static \Laravel\Forge\Resources\Server server(string $serverId)
79+
* @method static \Laravel\Forge\Resources\Server createServer(array $data, bool $wait = false, int $timeout = 900)
80+
* @method static \Laravel\Forge\Resources\Server updateServer(string $serverId, array $data)
81+
* @method static void deleteServer(string $serverId)
82+
* @method static void revokeAccessToServer(string $serverId)
83+
* @method static void reconnectToServer(string $serverId)
84+
* @method static void reactivateToServer(string $serverId)
85+
* @method static void rebootServer(string $serverId)
86+
* @method static void rebootMysql(string $serverId)
87+
* @method static void stopMysql(string $serverId)
88+
* @method static void rebootPostgres(string $serverId)
89+
* @method static void stopPostgres(string $serverId)
90+
* @method static void rebootNginx(string $serverId)
91+
* @method static void stopNginx(string $serverId)
92+
* @method static void rebootPHP(string $serverId, array $data)
93+
* @method static void installBlackfire(string $serverId, array $data)
94+
* @method static void removeBlackfire(string $serverId)
95+
* @method static void installPapertrail(string $serverId, array $data)
96+
* @method static void removePapertrail(string $serverId)
97+
* @method static void enableOPCache(string $serverId)
98+
* @method static void disableOPCache(string $serverId)
99+
* @method static \Laravel\Forge\Resources\PHPVersion[] phpVersions(int $serverId)
100+
* @method static void installPHP(string $serverId, string $version)
101+
* @method static void updatePHP(string $serverId, string $version)
102+
* @method static \Laravel\Forge\Resources\Event[] events(string|null $serverId = null)
103+
* @method static \Laravel\Forge\Resources\SiteCommand executeSiteCommand(int $serverId, int $siteId, array $data)
104+
* @method static \Laravel\Forge\Resources\SiteCommand listCommandHistory(int $serverId, int $siteId)
105+
* @method static \Laravel\Forge\Resources\SiteCommand getSiteCommand(int $serverId, int $siteId, int $commandId)
22106
* @method static \Laravel\Forge\Resources\Site[] sites(int $serverId)
23107
* @method static \Laravel\Forge\Resources\Site site(int $serverId, int $siteId)
24108
* @method static \Laravel\Forge\Resources\Site createSite(int $serverId, array $data, bool $wait = true)
@@ -52,108 +136,24 @@
52136
* @method static void changeSitePHPVersion(int $serverId, int $siteId, string $version)
53137
* @method static void updateNodeBalancingConfiguration(int $serverId, int $siteId, array $data)
54138
* @method static string siteLog(int $serverId, int $siteId)
55-
* @method static \Laravel\Forge\Resources\Server[] servers()
56-
* @method static \Laravel\Forge\Resources\Server server(string $serverId)
57-
* @method static \Laravel\Forge\Resources\Server createServer(array $data, bool $wait = false, int $timeout = 900)
58-
* @method static \Laravel\Forge\Resources\Server updateServer(string $serverId, array $data)
59-
* @method static void deleteServer(string $serverId)
60-
* @method static void revokeAccessToServer(string $serverId)
61-
* @method static void reconnectToServer(string $serverId)
62-
* @method static void reactivateToServer(string $serverId)
63-
* @method static void rebootServer(string $serverId)
64-
* @method static void rebootMysql(string $serverId)
65-
* @method static void stopMysql(string $serverId)
66-
* @method static void rebootPostgres(string $serverId)
67-
* @method static void stopPostgres(string $serverId)
68-
* @method static void rebootNginx(string $serverId)
69-
* @method static void stopNginx(string $serverId)
70-
* @method static void rebootPHP(string $serverId, array $data)
71-
* @method static void installBlackfire(string $serverId, array $data)
72-
* @method static void removeBlackfire(string $serverId)
73-
* @method static void installPapertrail(string $serverId, array $data)
74-
* @method static void removePapertrail(string $serverId)
75-
* @method static void enableOPCache(string $serverId)
76-
* @method static void disableOPCache(string $serverId)
77-
* @method static \Laravel\Forge\Resources\PHPVersion[] phpVersions(int $serverId)
78-
* @method static void installPHP(string $serverId, string $version)
79-
* @method static void updatePHP(string $serverId, string $version)
80-
* @method static \Laravel\Forge\Resources\Event[] events(string|null $serverId = null)
81-
* @method static \Laravel\Forge\Resources\Daemon[] daemons(int $serverId)
82-
* @method static \Laravel\Forge\Resources\Daemon daemon(int $serverId, int $daemonId)
83-
* @method static \Laravel\Forge\Resources\Daemon createDaemon(int $serverId, array $data, bool $wait = true)
84-
* @method static void restartDaemon(int $serverId, int $daemonId, bool $wait = true)
85-
* @method static void deleteDaemon(int $serverId, int $daemonId)
86-
* @method static \Laravel\Forge\Resources\Worker[] workers(int $serverId, int $siteId)
87-
* @method static \Laravel\Forge\Resources\Worker worker(int $serverId, int $siteId, int $workerId)
88-
* @method static \Laravel\Forge\Resources\Worker createWorker(int $serverId, int $siteId, array $data, bool $wait = true)
89-
* @method static void deleteWorker(int $serverId, int $siteId, int $workerId)
90-
* @method static void restartWorker(int $serverId, int $siteId, int $workerId, bool $wait = true)
91139
* @method static \Laravel\Forge\Resources\SSHKey[] keys(int $serverId)
92140
* @method static \Laravel\Forge\Resources\SSHKey sshKey(int $serverId, int $keyId)
93141
* @method static \Laravel\Forge\Resources\SSHKey createSSHKey(int $serverId, array $data, bool $wait = true)
94142
* @method static void deleteSSHKey(int $serverId, int $keyId)
95-
* @method static \Laravel\Forge\Resources\Recipe[] recipes()
96-
* @method static \Laravel\Forge\Resources\Recipe recipe(string $recipeId)
97-
* @method static \Laravel\Forge\Resources\Recipe createRecipe(array $data)
98-
* @method static \Laravel\Forge\Resources\Recipe updateRecipe(string $recipeId, array $data)
99-
* @method static void deleteRecipe(string $recipeId)
100-
* @method static void runRecipe(string $recipeId, array $data)
101-
* @method static \Laravel\Forge\Resources\BackupConfiguration[] backupConfigurations(string $serverId)
102-
* @method static \Laravel\Forge\Resources\BackupConfiguration backupConfiguration(string $serverId, string $backupConfigurationId)
103-
* @method static \Laravel\Forge\Resources\BackupConfiguration createBackupConfiguration(string $serverId, array $data)
104-
* @method static \Laravel\Forge\Resources\BackupConfiguration updateBackupConfiguration(int $serverId, int $backupConfigurationId, array $data)
105-
* @method static void deleteBackupConfiguration(string $serverId, string $backupConfigurationId)
106-
* @method static void restoreBackup(string $serverId, string $backupConfigurationId, string $backupId)
107-
* @method static void deleteBackup(string $serverId, string $backupConfigurationId, string $backupId)
108143
* @method static \Laravel\Forge\Resources\Webhook[] webhooks(int $serverId, int $siteId)
109144
* @method static \Laravel\Forge\Resources\Webhook webhook(int $serverId, int $siteId, int $webhookId)
110145
* @method static \Laravel\Forge\Resources\Webhook createWebhook(int $serverId, int $siteId, array $data)
111146
* @method static void deleteWebhook(int $serverId, int $siteId, int $webhookId)
112-
* @method static \Laravel\Forge\Resources\DatabaseUser[] databaseUsers(int $serverId)
113-
* @method static \Laravel\Forge\Resources\DatabaseUser databaseUser(int $serverId, int $userId)
114-
* @method static \Laravel\Forge\Resources\DatabaseUser createDatabaseUser(int $serverId, array $data, bool $wait = true)
115-
* @method static \Laravel\Forge\Resources\DatabaseUser updateDatabaseUser(int $serverId, int $userId, array $data)
116-
* @method static void deleteDatabaseUser(int $serverId, int $userId)
117-
* @method static \Laravel\Forge\Resources\Credential[] credentials()
118-
* @method static \Laravel\Forge\Resources\Certificate[] certificates(int $serverId, int $siteId)
119-
* @method static \Laravel\Forge\Resources\Certificate certificate(int $serverId, int $siteId, int $certificateId)
120-
* @method static \Laravel\Forge\Resources\Certificate createCertificate(int $serverId, int $siteId, array $data, bool $wait = true)
121-
* @method static void deleteCertificate(int $serverId, int $siteId, int $certificateId)
122-
* @method static string getCertificateSigningRequest(int $serverId, int $siteId, int $certificateId)
123-
* @method static void installCertificate(int $serverId, int $siteId, int $certificateId, array $data, bool $wait = true)
124-
* @method static void activateCertificate(int $serverId, int $siteId, int $certificateId, bool $wait = true)
125-
* @method static \Laravel\Forge\Resources\Certificate obtainLetsEncryptCertificate(int $serverId, int $siteId, array $data, bool $wait = true)
126-
* @method static \Laravel\Forge\Resources\FirewallRule[] firewallRules(int $serverId)
127-
* @method static \Laravel\Forge\Resources\FirewallRule firewallRule(int $serverId, int $ruleId)
128-
* @method static \Laravel\Forge\Resources\FirewallRule createFirewallRule(int $serverId, array $data, bool $wait = true)
129-
* @method static void deleteFirewallRule(int $serverId, int $ruleId)
130-
* @method static \Laravel\Forge\Resources\RedirectRule[] redirectRules(int $serverId, int $siteId)
131-
* @method static \Laravel\Forge\Resources\RedirectRule redirectRule(int $serverId, int $siteId, int $ruleId)
132-
* @method static \Laravel\Forge\Resources\RedirectRule createRedirectRule(int $serverId, int $siteId, array $data, bool $wait = true)
133-
* @method static void deleteRedirectRule(int $serverId, int $siteId, int $ruleId)
134-
* @method static \Laravel\Forge\Resources\SecurityRule[] securityRules(int $serverId, int $siteId)
135-
* @method static \Laravel\Forge\Resources\SecurityRule securityRule(int $serverId, int $siteId, int $ruleId)
136-
* @method static \Laravel\Forge\Resources\SecurityRule createSecurityRule(int $serverId, int $siteId, array $data, bool $wait = true)
137-
* @method static void deleteSecurityRule(int $serverId, int $siteId, int $ruleId)
138-
* @method static \Laravel\Forge\Resources\Database[] databases(int $serverId)
139-
* @method static \Laravel\Forge\Resources\Database database(int $serverId, int $databaseId)
140-
* @method static \Laravel\Forge\Resources\Database createDatabase(int $serverId, array $data, bool $wait = true)
141-
* @method static \Laravel\Forge\Resources\Database updateDatabase(int $serverId, int $databaseId, array $data)
142-
* @method static void deleteDatabase(int $serverId, int $databaseId)
143-
* @method static void syncDatabases(int $serverId)
144-
* @method static \Laravel\Forge\Resources\Monitor[] monitors(int $serverId)
145-
* @method static \Laravel\Forge\Resources\Monitor monitor(int $serverId, int $monitorId)
146-
* @method static \Laravel\Forge\Resources\Monitor createMonitor(int $serverId, array $data)
147-
* @method static void deleteMonitor(int $serverId, int $monitorId)
148-
* @method static \Laravel\Forge\Resources\NginxTemplate[] nginxTemplates(int $serverId)
149-
* @method static \Laravel\Forge\Resources\NginxTemplate nginxTemplate(int $serverId, int $templateId)
150-
* @method static \Laravel\Forge\Resources\NginxTemplate nginxDefaultTemplate(int $serverId)
151-
* @method static \Laravel\Forge\Resources\NginxTemplate createNginxTemplate(int $serverId, array $data, bool $wait = true)
152-
* @method static \Laravel\Forge\Resources\NginxTemplate updateNginxTemplate(int $serverId, int $templateId, array $data)
153-
* @method static void deleteNginxTemplate(int $serverId, int $templateId)
154-
* @method static \Laravel\Forge\Resources\SiteCommand executeSiteCommand(int $serverId, int $siteId, array $data)
155-
* @method static \Laravel\Forge\Resources\SiteCommand listCommandHistory(int $serverId, int $siteId)
156-
* @method static \Laravel\Forge\Resources\SiteCommand getSiteCommand(int $serverId, int $siteId, int $commandId)
147+
* @method static \Laravel\Forge\Resources\Worker[] workers(int $serverId, int $siteId)
148+
* @method static \Laravel\Forge\Resources\Worker worker(int $serverId, int $siteId, int $workerId)
149+
* @method static \Laravel\Forge\Resources\Worker createWorker(int $serverId, int $siteId, array $data, bool $wait = true)
150+
* @method static void deleteWorker(int $serverId, int $siteId, int $workerId)
151+
* @method static void restartWorker(int $serverId, int $siteId, int $workerId, bool $wait = true)
152+
* @method static mixed get(string $uri)
153+
* @method static mixed post(string $uri, array $payload = [])
154+
* @method static mixed put(string $uri, array $payload = [])
155+
* @method static mixed delete(string $uri, array $payload = [])
156+
* @method static mixed retry(int $timeout, callable $callback, int $sleep = 5)
157157
*
158158
* @see \Laravel\Forge\Forge
159159
*/

0 commit comments

Comments
 (0)