insidenothing/php-github-api

GitHub API v3 client

2.9.0 2018-07-23 07:41 UTC

Requires

• php: ^5.6 || ^7.0
• php-http/cache-plugin: ^1.4
• php-http/client-common: ^1.6
• php-http/client-implementation: ^1.0
• php-http/discovery: ^1.0
• php-http/httplug: ^1.1
• psr/cache: ^1.0
• psr/http-message: ^1.0

Requires (Dev)

• cache/array-adapter: ^0.4
• guzzlehttp/psr7: ^1.2
• php-http/guzzle6-adapter: ^1.0
• php-http/mock-client: ^1.0
• phpunit/phpunit: ^5.5 || ^6.0
• sllh/php-cs-fixer-styleci-bridge: ^1.3

MIT

• Thibault Duplessis
• KnpLabs Team

• api
• github
• gist
• gh

README

A simple Object Oriented wrapper for GitHub API, written with PHP5.

Uses GitHub API v3 & supports GitHub API v4. The object API (v3) is very similar to the RESTful API.

Features

• Light and fast thanks to lazy loading of API classes
• Extensively tested and documented

Requirements

• PHP >= 5.6
• A HTTP client
• A PSR-7 implementation
• (optional) PHPUnit to run tests.

Install

Via Composer:

$ composer require knplabs/github-api php-http/guzzle6-adapter

Why php-http/guzzle6-adapter? We are decoupled from any HTTP messaging client with help by HTTPlug. Read about clients in our docs.

Using Laravel?

Laravel GitHub by Graham Campbell might interest you.

Basic usage of php-github-api client

<?php

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';

$client = new \Github\Client();
$repositories = $client->api('user')->repositories('ornicar');

From $client object, you can access to all GitHub.

Cache usage

This example uses the PSR6 cache pool redis-adapter. See http://www.php-cache.com/ for alternatives.

<?php

// This file is generated by Composer
require_once __DIR__ . '/vendor/autoload.php';

use Cache\Adapter\Redis\RedisCachePool;

$client = new \Redis();
$client->connect('127.0.0.1', 6379);
// Create a PSR6 cache pool
$pool = new RedisCachePool($client);

$client = new \Github\Client();
$client->addCache($pool);

// Do some request

// Stop using cache
$client->removeCache();

Using cache, the client will get cached responses if resources haven't changed since last time, without reaching the X-Rate-Limit imposed by github.

Documentation

See the doc directory for more detailed documentation.

License

php-github-api is licensed under the MIT License - see the LICENSE file for details

Credits

Sponsored by

Contributors

• Thanks to Thibault Duplessis aka. ornicar for his first version of this library.
• Thanks to Joseph Bielawski aka. stloyd for his contributions and support.
• Thanks to noloh for his contribution on the Object API.
• Thanks to bshaffer for his contribution on the Repo API.
• Thanks to Rolf van de Krol for his countless contributions.
• Thanks to Nicolas Pastorino for his contribution on the Pull Request API.
• Thanks to Edoardo Rivello for his contribution on the Gists API.
• Thanks to Miguel Piedrafita for his contribution to the v4 & Apps API.

Thanks to GitHub for the high quality API and documentation.