Github Jobs PHP API Client

Project Overview

This package provides Github Jobs API
support for the JobBrander’s Jobs Client.

Installation

Use composer: composer require jobapis/jobs-github

Usage

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

1
2
3
4
// 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.

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

You can even chain them if you’d like.

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

Then inject the query object into the provider.

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

And call the “getJobs” method to retrieve results.

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

This will return a Collection of Job objects.

For more detailed usage and documentation, see this project’s readme