Download the PHP package jobapis/jobs-common without Composer
On this page you can find all versions of the php package jobapis/jobs-common. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jobapis/jobs-common
More information about jobapis/jobs-common
Files in jobapis/jobs-common
Package jobs-common
Short Description Making it simple to integrate your application with job api providers.
License Apache-2.0
Homepage http://jobapis.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package jobs-common
Jobs Common
Standardizing job board API clients
This package makes it makes it easy to integrate job board APIs into your application. Whether you want to aggregate job board data, or supplement your site's job listings with listings from third party providers, or anything else you can dream up, this package (and the api clients listed below) can help.
This package is compliant with PSR-1, PSR-2, PSR-4, and PSR-7. If you notice compliance oversights, please send a patch via pull request.
Requirements
The following versions of PHP are supported.
- PHP 5.5
- PHP 5.6
- PHP 7.0
- HHVM
Usage
This package is not meant to be used on its own, but rather it is used by the providers listed below to access job board APIs and gather results in a standard data format. For details on creating your own job board provider, read on!
Providers
Each job board supported has a provider that must extend this package's AbstractProvider, and implement the declared abstract methods.
The following providers are available:
Official providers
There are many job board services we support officially.
| Gateway | Composer Package | Maintainer |
|---|---|---|
| Authentic Jobs | jobapis/jobs-authenticjobs | Steven Maguire |
| CareerBuilder | jobapis/jobs-careerbuilder | Karl Hughes |
| Careercast | jobapis/jobs-careercast | Karl Hughes |
| Dice | jobapis/jobs-dice | Karl Hughes |
| Elance | jobapis/jobs-elance | Steven Maguire |
| Github Jobs | jobapis/jobs-github | Steven Maguire |
| Govt | jobapis/jobs-govt | Karl Hughes |
| Indeed | jobapis/jobs-indeed | Steven Maguire |
| Jobs2Careers | jobapis/jobs-jobs2careers | Karl Hughes |
| Muse | jobapis/jobs-muse | Karl Hughes |
| JuJu | jobapis/jobs-juju | Karl Hughes |
| SimplyHired | jobapis/jobs-simplyhired | Karl Hughes |
| ZipRecruiter | jobapis/jobs-ziprecruiter | Karl Hughes |
Third party providers
If you would like to support other providers, please make them available as a Composer package, then link to them below.
These providers allow integration with other providers not supported by jobs-common. They may require an older version
so please help them out with a pull request if you notice this.
| Gateway | Composer Package | Maintainer |
|---|---|---|
| Job Crank | yourname/jobs-jobcrank | You! |
Build your own providers
New providers can be created by cloning the layout of an existing package. When choosing a name for your package, please don’t use the joabpis vendor prefix, as this implies that it is officially supported.
You should use your own username as the vendor prefix, and prepend jobs- to the package name to make it clear that your package works with Jobs Common. For example, if your GitHub username were prometheus, and you were implementing the Dice.com job listing API, a good name for your composer package would be prometheus/jobs-dice.
Implementing your own provider
If you are working with a job board service not supported out-of-the-box or by an existing package, it is quite simple to implement your own. Simply extend JobApis\Jobs\Client\Providers\AbstractProvider and JobApis\Jobs\Client\Queries\AbstractQuery and implement the required abstract methods in each:
Each of these abstract methods contain a docblock defining their expectations and typical behavior. Once you have extended these classes, you can simply follow the example above using your new Provider.
Each job object that is created will automatically set source and query based on the criteria passed into the provider. If you would like to customize this source value, your provider must implement a getSource method that returns a string to identify your provider's source.
For an example of each of the concrete classes you'll need to implement, see the /tests/fixtures folder in this repository.
Make your provider official
If you want to transfer your provider to the jobapis GitHub organization and add it to the list of officially supported providers, please open a pull request on the jobapis/jobs-common package. Before new providers will be accepted, they must have 100% unit test code coverage, and follow the conventions and code style used in other Jobs Client providers.
Install
Via Composer
Testing
Contributing
Please see CONTRIBUTING for details.
Credits
License
The Apache 2.0. Please see License File for more information.
