Easily integrate the Github Jobs API into your PHP application
Switch branches/tags
Nothing to show
Clone or download
Latest commit 1461e78 Sep 7, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Finishing up provider, test Sep 8, 2016
tests/src Finishing up provider, test Sep 8, 2016
.gitignore Updating composer Sep 8, 2016
.scrutinizer.yml init Aug 12, 2015
.travis.yml init Aug 12, 2015
CHANGELOG.md Updating changelog, readme Sep 8, 2016
CONTRIBUTING.md Namespacing, updating readme links Sep 8, 2016
LICENSE.md Namespacing, updating readme links Sep 8, 2016
README.md Updating changelog, readme Sep 8, 2016
composer.json Adding query and test Sep 8, 2016
phpunit.xml.dist init Aug 12, 2015

README.md

Github Jobs Client

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

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

Installation

To install, use composer:

composer require jobapis/jobs-github

Usage

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.

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The Apache 2.0. Please see License File for more information.