jobapis/jobs-github

Making it simple to integrate your application with Github Jobs API.

Github Jobs Client

, _(*1)

This package provides Github Jobs API support for the Jobs Common project., _(*2)

Installation

To install, use composer:, _(*3)

composer require jobapis/jobs-github

Usage

Create a Query object and add all the parameters you'd like via the constructor., _(*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., _(*5)

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

You can even chain them if you'd like., _(*6)

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

Then inject the query object into the provider., _(*7)

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

And call the "getJobs" method to retrieve results., _(*8)

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

This will return a Collection of Job objects., _(*9)

Testing

bash $ ./vendor/bin/phpunit, _(*10)

Contributing

Please see CONTRIBUTING for details., _(*11)

Credits

• Steven Maguire
• Karl Hughes
• All Contributors

License

The Apache 2.0. Please see License File for more information., _(*12)