Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 2.62 KB

README.md

File metadata and controls

80 lines (55 loc) · 2.62 KB

TheMuse.com Jobs Client

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

This package provides Muse Jobs API support for the JobApis's Jobs Client.

Installation

To install, use composer:

composer require jobapis/jobs-muse

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\MuseQuery([
    'api_key' => YOUR_API_ID // Optional: include your api key
]);

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('category', 'Engineering');

You can even chain them if you'd like.

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

Then inject the query object into the provider.

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