jobapis / jobs-govt
Making it simple to integrate your application with the Government Jobs API.
Installs: 3 175
Dependents: 1
Suggesters: 0
Security: 0
Stars: 5
Watchers: 4
Forks: 4
Open Issues: 1
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
README
This package provides Government Jobs API support for the Jobs Common Project.
Installation
To install, use composer:
composer require jobapis/jobs-govt
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\GovtQuery([ 'hl' => '1' ]);
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('query', 'engineering');
You can even chain them if you'd like.
// Add parameters via the set() method $query->set('size', '100') ->set('from', '200');
Note: The government jobs API doesn't support adding location as a parameter, but their keyword or lat_lon parameters can be used for this purpose.
Then inject the query object into the provider.
// Instantiating provider with a query object $client = new JobApis\Jobs\Client\Provider\GovtProvider($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.