README

Install

You can easily install the PushApi_Client using Composer.

In your composer.json file just add the latest stable version of the Client (see versions on Packagist):

{
    "require": {
        "pushapi/client-php": "2.*"
    }
}

Requirements

Have a basic knowledge about what PushApi does and its functionalities
PushApi running on server
PHP >= 5.5

Example Usage

require "vendor/autoload.php";

use \RequestManagers\CurlRequestManager;

$requestManager = new CurlRequestManager("http://my_uri.com/", 8080);
$client = new PushApi_Client("my_app_id", "my_app_name", "my_secret", $requestManager);

try {
    $userId = 1;
	$user = $client->getUser($userId);
	echo $user['result']['email'] . "\n";
} catch (Exception $e) {
	echo "Exception - " . $e->getMessage() . "\n";
}

Request Managers

The Request Managers are objects that implement sending functions that lets the Client to send calls and receive responses. Currently there are two Request Managers but only one can be used for this use because the other one is used for tests:

Dummy Request Manager, it is used in order to get the Client calls, check if it is working correctly and it simulates a request response with the client information.
Curl Request Manager, it uses the PHP Curl method in order to generate/receive the calls to/from the PushApi.
|NEW| - Guzzle Request Manager, it uses Guzzle functionalities in order to generate/receive the calls to/from the PushApi.

Support

If you want to give your opinion, you can send me an email, comment the project directly (if you want to contribute with information or resources) or fork the project and make a pull request.

Also I will be grateful if you want to make a donation, this project hasn't got a death date and it wants to be improved constantly:

##License

The PushApi_Client is released under the MIT public license.

pushapi / client-php

Maintainers

Details