customize.md

Customize php-github-api and testing

Back to the navigation

Inject a new HTTP client instance

php-github-api relies on php-http/discovery to find an installed HTTP client. You may specify a HTTP client yourself by calling \Github\Client::setHttpClient. A HTTP client must implement Http\Client\HttpClient. A list of community provided clients is found here: https://packagist.org/providers/php-http/client-implementation

You can inject a HTTP client through Github\Client#setHttpClient() method:

$client = new Github\Client();
$client->setHttpClient(new Http\Adapter\Guzzle6\Client());

Configure the HTTP client

Wanna change, let's say, the HTTP client User Agent? You need to create a Plugin that modifies the request. Read more about HTTPlug plugins here.

use Http\Client\Common\Plugin;
use Psr\Http\Message\RequestInterface;

class CustomUserAgentPlugin implements Plugin
{
    /**
     * {@inheritdoc}
     */
    public function handleRequest(RequestInterface $request, callable $next, callable $first)
    {
        $request->withHeader('user-agent', 'Foobar');

        return $next($request);
    }
}

$githubClient->addPlugin(new CustomUserAgentPlugin());

Run Test Suite

The code is unit tested, there are also some functional tests. To run tests on your machine, from a CLI, run

$ phpunit