jobbrander / jobs-github
This package is abandoned and no longer maintained.
The author suggests using the jobapis/jobs-github package instead.
Making it simple to integrate your application with Github Jobs API.
1.0.0
2016-09-08 01:47 UTC
Requires
- php: >=5.5.0
- jobapis/jobs-common: ^2.0.0
Requires (Dev)
- mockery/mockery: >=0.9.4
- phpunit/php-code-coverage: ~2.0
- phpunit/phpunit: >=4.6
- squizlabs/php_codesniffer: ~2.0
This package is not auto-updated.
Last update: 2022-02-01 12:50:14 UTC
README
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.