hounddog/hd-api-client

Zend Framework 2 Module that provides base api functionalities

dev-master 2014-06-24 13:19 UTC

This package is not auto-updated.

Last update: 2020-09-14 06:45:38 UTC


README

Latest Stable Version Latest Unstable Version Build Status Code Coverage Scrutinizer Code Quality

Introduction

HdClientApi is a connector for variuous Api based Modules (e.g. Github, Twitter, Instagramm etc) based on Zend Framework 2 .

Installation

Main Setup

  1. Clone this project into your ./vendor/ directory and enable it in your application.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