README

PHP Cloudstack Client

This package makes it simple to integrate the Cloudstack API in your PHP applications.

Requirements

The following versions of PHP are supported:

PHP 7.1 or higher

Support for PHP 5.x has been dropped

In favour of stricter type hinting and return types we stopped supporting older PHP versions in new releases.

Please note: General support for PHP 5.x will be ending soon, check the PHP documentation for more information about PHP version support.

If you still require support for PHP 5.x or HHVM you can use the ~0.2 releases of this package.

Installation

Use composer require to add the client to your composer.json file, please check the Composer documentation for more information about Composer.

$ composer require pcextreme/cloudstack

Usage

There are various ways to interact with the Cloudstack API using this package. The easiest and preferred way is to call the Cloudstack 'commands' directly as a method on the client.

Internally the client resolves the command using the __call magic method. The command will be automatically resolved and the provided options are verified. Also when everything goes as expected the API response is automatically parsed.

The client uses an API list mapping stored in the cache folder do determine if an API command exists and all required parameters are provided. This list is generated using Cloudstack's listApis command.

<?php

include(__DIR__.'/vendor/autoload.php');

use PCextreme\Cloudstack\Client;

$client = new Client([
    'urlApi'    => 'https://api.auroracompute.eu/ams',
    'apiKey'    => 'YOUR-API-KEY',
    'secretKey' => 'YOUR-SECRET-KEY',
]);

var_dump($client->listAccounts(['name' => 'admin', 'listall' => 'true']));

Directly calling the command method

Its also possible to bypass the __call magic method and call the command method directly.

<?php

// Using an existing client instance.

$client->command('listAccounts', ['name' => 'admin', 'listall' => 'true']);

Manually accessing the API

If for some reason the cache/api_list.php is removed, outdated or gets corrupted you can access the API directly by building a request manually. This bypasses all previously mentioned checks but still parses the response.

<?php

// Using an existing client instance.

$command = 'listAccounts';
$options = ['name' => 'admin', 'listall' => 'true'];

$method  = $client->getCommandMethod($command);
$url     = $client->getCommandUrl($command, $options);
$request = $client->getRequest($method, $url, $options);

$accounts = $client->getResponse($request);

Updating the API list

You can update or regenerate the provided API list using the bin/cloudstack CLI.

$ php bin/cloudstack api:list

You can also get a list of available CLI commands.

$ php bin/cloudstack

Contributing

This package is open-source and welcomes issues and pull requests from anyone. Before opening pull requests, please read our short Contribution Guide.

Credits

License

The MIT License (MIT). Please see License File for more information.

pcextreme / cloudstack

Maintainers

Details