diversen/simple-php-github-api

simple php github api

About

Very simple github API for PHP using OAuth. 37 LOC for the API class. And a curl helper class with 84 LOC., _(*1)

Install simple-php-github-api

php composer.phar require diversen/simple-php-github-api:

Or if you have placed composer.phar in your path as composer, _(*2)

composer require diversen/simple-php-github-api

Brief explantion.

There is really only tree methods you can do. Let us see those three methods first. (Further below is an complete example using the built-in server for easy testing)., _(*3)

1) Generate an access URL to github.com, _(*4)

~~~.php $access_config = array ( 'redirect_uri' => GITHUB_CALLBACK_URL, 'client_id' => GITHUB_ID, 'state' => md5(uniqid()), 'scope' => 'user' );, _(*5)

$api = new githubapi(); $url = $api->getAccessUrl($access_config); echo "Github Login";, _(*6)

2) Callback from github.com

~~~.php
$access_config = array (
    'redirect_uri' => GITHUB_CALLBACK_URL,
    'client_id' => GITHUB_ID,
    'client_secret' => GITHUB_SECRET
);

$api = new githubapi();
$res = $api->setAccessToken($access_config);

if ($res) {
    // OK
    This is where we will call the api
    header("Location: /api_call.php");
} else {
    // Not OK. echo errors
    echo "Could not get access token. Errors: <br />";
    print_r($api->errors);
}

3) API call, _(*7)

For full listing see: https://developer.github.com/v3/, _(*8)

~~~.php // We have a access token and we can now call the api: $api = new githubapi();, _(*9)

// Simple call - API get current users credentials // This can also be done without scope, _(*10)

// example // $command = '/user', // $request = 'GET', 'POST' or 'PATCH' or 'DELETE' etc. Se API: // $post = variables to POST array, _(*11)

$command = "/user"; $res = $api->apiCall($command, $request = null, $post = null); if (!$res) { print_r($api->errors); die; } else { print_r($res); } ~~~, _(*12)

Full example

Example you can run right away using the built-in PHP-server., _(*13)

Make a github app

Log into github.com, _(*14)

Register a new application at https://github.com/settings/developers, _(*15)

You will see something like this:, _(*16)

, _(*17)

Create your app., _(*18)

Enter base_dir of the simple-php-github-api:, _(*19)

cd vendor/diversen/simple-php-github-api

Configuration

cp example/config.php-dist example/config.php

Edit config, _(*20)

Set config in example/config.php according to above settings and the screenshot above., _(*21)

Run test-server with example:, _(*22)

php -S localhost:8080 -t example/

More github API info

For full listing of all API calls check:, _(*23)

https://developer.github.com/v3/, _(*24)

Scope:, _(*25)

https://developer.github.com/v3/oauth/#scopes, _(*26)

I have not tested many calls - but you should be able to use all. E.g. POST, or PATCH, DELETE., _(*27)

Support

Create an issue, and Let me hear if it does not work out for you., _(*28)