spinupwp / spinupwp-php-sdk
The official SpinupWP PHP SDK
Installs: 2 432
Dependents: 1
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 0
Open Issues: 1
Requires
- php: >=7.4
- ext-json: *
- guzzlehttp/guzzle: ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.2
- mockery/mockery: ^1.4
- phpstan/phpstan: ^0.12.99
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-10-23 16:23:45 UTC
README
The SpinupWP PHP SDK provides an expressive interface for interacting with SpinupWP's API. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses.
Installation
To get started, require the package via Composer:
composer require spinupwp/spinupwp-php-sdk
Usage
You can create an instance of the SpinupWP client like so:
$spinupwp = new SpinupWp\SpinupWp('API_TOKEN');
Servers
// Return a collection of servers $servers = $spinupwp->servers->list(); // Return a single server $server = $spinupwp->servers->get($serverId); // Create and return a new server $server = $spinupwp->servers->create([]); // Delete a server $eventId = $spinupwp->servers->delete($serverId, $deleteOnProvider); // Reboot a server $eventId = $spinupwp->servers->reboot($serverId); // Restart the Nginx service on a server $eventId = $spinupwp->servers->restartNginx($serverId); // Restart all versions of the PHP-FPM service installed on a server $eventId = $spinupwp->servers->restartPhp($serverId); // Restart the MySQL or MariaDB service on a server $eventId = $spinupwp->servers->restartMysql($serverId);
On a Server
instance you may also call:
// Return a collection of this server's sites $sites = $server->sites(); // Delete the current server $server->delete($deleteOnProvider); // Reboot the current server $server->reboot(); // Restart the Nginx service on the current server $server->restartNginx(); // Restart all versions of the PHP-FPM service installed on the current server $server->restartPhp(); // Restart the MySQL or MariaDB service on the current server $server->restartMysql();
Sites
// Return a collection of sites $sites = $spinupwp->sites->list(); // Return a single site $site = $spinupwp->sites->get($siteId); // Create and return a new site $site = $spinupwp->sites->create($serverId, []); // Delete a site $eventId = $spinupwp->sites->delete($siteId); // Run a git deployment $eventId = $spinupwp->sites->gitDeploy($siteId); // Purge a site's page cache $eventId = $spinupwp->sites->purgePageCache($siteId); // Purge a site's object cache $eventId = $spinupwp->sites->purgeObjectCache($siteId); // Reset a site's file permissions $eventId = $spinupwp->sites->correctFilePermissions($siteId);
On a Site
instance you may also call:
// Delete the current site $site->delete(); // Run a git deployment $site->gitDeploy(); // Purge a site's page cache $site->purgePageCache(); // Purge a site's object cache $site->purgeObjectCache(); // Reset a site's file permissions $site->correctFilePermissions();
Events
// Return a collection of events $events = $spinupwp->events->list(); // Return a single event $event = $spinupwp->events->get($eventId);
Resource Collections
When retrieving a list of resources, an instance of ResourceCollection
is returned. This class handles fetching large lists of resources without having to paginate results and perform subsequent requests manually.
$servers = $spinupwp->servers->list(); // Return an array of all servers $servers->toArray(); // Return the total number of servers $servers->count(); // Lazily iterate over all servers foreach ($servers as $server) { // Do something with $server }
License
SpinupWP PHP SDK is open-sourced software licensed under the MIT license.