nekofar/virgool

PHP wrapper for the Virgool API

dev-master / 1.0.x-dev 2019-08-17 22:01 UTC

Requires

• php: >=5.6.0
• ext-json: *
• netresearch/jsonmapper: ^1.5
• php-http/client-implementation: ^1.0
• php-http/discovery: ^1.0
• php-http/httplug: ^1.0
• php-http/message-factory: ^1.0
• psr/http-message: ^1.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.5.0
• escapestudios/symfony2-coding-standard: ^3.8
• guzzlehttp/psr7: ^1.0
• jchook/phpunit-assert-throws: ^1.0
• php-http/curl-client: ^1.0
• php-http/message: ^1.0
• php-http/mock-client: ^1.0
• phpcompatibility/php-compatibility: ^9.2
• phpunit/phpunit: ^8.2
• squizlabs/php_codesniffer: ^3.4
• vlucas/phpdotenv: ^3.4

MIT

• Milad Nekofar

README

Please consider this library is under active development and, it's not ready to use in production.

Virgool PHP API

This is a PHP wrapper for the Virgool API.

Installation

This wrapper relies on HTTPlug, which defines how HTTP message should be sent and received. You can use any library to send HTTP messages that implements php-http/client-implementation.

composer require nekofar/virgool:^1.0@dev

To install with cURL you may run the following command:

composer require nekofar/virgool:^1.0@dev php-http/curl-client:^1.0

Usage

Use your username and password to access your own account.

use \Nekofar\Virgool\Client;

$config = Config::create('username', 'password');
$client = Client::create($config);

try {
    $user = $client->getUser();

    echo 'Name: ' . $user->name . PHP_EOL;
    echo 'User: ' . $user->username . PHP_EOL;

} catche (\Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

Contributing

The test suite is built using PHPUnit. Run the suite of unit tests by running the phpunit command or this composer script.

composer test