hounddog / hd-api-client
Zend Framework 2 Module that provides base api functionalities
dev-master
2014-06-24 13:19 UTC
Requires
- php: >=5.3.3
- zendframework/zend-eventmanager: 2.*
- zendframework/zend-filter: 2.*
- zendframework/zend-http: 2.*
- zendframework/zend-modulemanager: 2.*
- zendframework/zend-servicemanager: 2.*
Requires (Dev)
- phpunit/phpunit: 3.7.*
- satooshi/php-coveralls: >=0.6.0
- squizlabs/php_codesniffer: 1.4.*
This package is not auto-updated.
Last update: 2024-11-05 02:28:14 UTC
README
Introduction
HdClientApi is a connector for variuous Api based Modules (e.g. Github, Twitter, Instagramm etc) based on Zend Framework 2 .
Installation
Main Setup
- Clone this project into your
./vendor/
directory and enable it in yourapplication.config.php
file.
Usage
Basic Usage
Here is short example on how to use
$client = $serviceManager->get('EdpGithub\Client');
$repos = $client->api('user')->repos('hounddog');
This would fetch all the Repositories for the user Hounddog
Authentication
To use functionality which needs Authentication you have to first authenticate
$client = $serviceManager->get('EdpGithub\Client');
$client->authenticate('url_token', 'access_token');
$repos = $client->api('current_user')->repos();
You can also listen to the Event 'EdpGithub\Client', 'api'
$em->attach('EdpGithub\Client', 'api', function($e) use ($sm) {
$client = $e->getTarget();
$client->authenticate('url_token', $token /* your access_token here */);
} );
Documentation
Please refer to the Wiki for a more detailed Documentation