README

This package provides Indeed Jobs API support for the Jobs Common Project.

Installation

To install, use composer:

composer require jobapis/jobs-indeed

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\IndeedQuery([
    'publisher' => YOUR_PUBLISHER_ID
]);

Or via the "set" method. All of the parameters documented in Indeed's documentation can be added.

// Add parameters via the set() method
$query->set('q', 'engineering');

You can even chain them if you'd like.

// Add parameters via the set() method
$query->set('l', 'Chicago, IL')
    ->set('highlight', '1')
    ->set('latlong', '1');

Then inject the query object into the provider.

// Instantiating an IndeedProvider with a query object
$client = new JobApis\Jobs\Client\Provider\IndeedProvider($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.

To run all tests except for actual API calls

$ ./vendor/bin/phpunit

To run all tests including actual API calls

$ PUBLISHER=<YOUR PUBLISHER ID> ./vendor/bin/phpunit