jobbrander/jobs-elance

Making it simple to integrate your application with Elance API.

0.1.0 2015-08-14 14:06 UTC

README

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

This package provides Elance Jobs API support for the JobBrander's Jobs Client.

This package is intended to be used for communicating with the Elance's API after you've secured an access token from your users. To authenticate users and retrieve access tokens, use stevenmaguire/oauth2-elance.

Installation

To install, use composer:

composer require jobbrander/jobs-elance

Usage

Usage is the same as Job Branders's Jobs Client, using \JobBrander\Jobs\Client\Provider\Elance as the provider.

$client = new JobBrander\Jobs\Client\Provider\Elance([
    'token' => 'ELANCE ACCESS TOKEN',
]);

$jobs = $client->setKeyword('designer') // A space-delimited list of keywords to search. If omitted, search returns a list of all jobs.
    ->setCategory(1)               // A positive integer representing a category ID that restricts search results to jobs in the specified category. A list of valid category IDs and associated names is available through the categories method. If the value of catFilter does not correspond to an existing category ID, the method returns an empty result set.
    ->setSubCategory(1)            // A positive integer representing a subcategory ID that restricts search results to jobs in the specified subcategory. A list of valid subcategory IDs and associated names is available through the categories method. If the value of subcatFilter does not correspond to an existing category ID, the method returns an empty result set.
    ->setType('startDate')         // The property by which to sort results. Valid values are: budget, numProposals, startDate, endDate
    ->setSort('asc')               // The sort order of the results (ascending or descending). If this value is specified without sortCol, it is ignored. Valid values are: asc, desc; The default is desc.
    ->setPage(2)                   // The requested page of result sets, numbered beginning from 1. Default is 1. If this number exceeds the value of the response property totalPages, the response will contain zero results.
    ->setCount(25)                 // The number of results requested per page. The default is 20. If more than 25 are requested, only 25 results are included in the response.
    ->getJobs();

The getJobs method 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.