README

This package provides Github Jobs API support for the Jobs Common project.

Installation

To install, use composer:

composer require jobapis/jobs-github

Create a Query object and add all the parameters you'd like via the constructor.

// Add parameters to the query via the constructor
$query = new JobApis\Jobs\Client\Queries\GithubQuery([
    'search' => 'engineering'
]);

Or via the "set" method. All of the parameters documented in the API's documentation can be added.

// Add parameters via the set() method
$query->set('location', 'Chicago, IL');

You can even chain them if you'd like.

// Add parameters via the set() method
$query->set('page', '2')
    ->set('full_time', 'true');

Then inject the query object into the provider.

// Instantiating provider with a query object
$client = new JobApis\Jobs\Client\Provider\GithubProvider($query);

And call the "getJobs" method to retrieve results.

// Get a Collection of Jobs
$jobs = $client->getJobs();

This will return a Collection of Job objects.

$ ./vendor/bin/phpunit