jobapis/jobs-github

使您的应用程序集成 Github Jobs API 变得简单。

1.0.0 2016-09-08 01:47 UTC

This package is auto-updated.

Last update: 2024-08-29 04:40:16 UTC


README

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

本包为 Github Jobs API 提供对 Jobs Common 项目的支持。

安装

要安装,请使用 composer

composer require jobapis/jobs-github

用法

创建一个查询对象,并通过构造函数添加所有您想添加的参数。

// Add parameters to the query via the constructor
$query = new JobApis\Jobs\Client\Queries\GithubQuery([
    'search' => 'engineering'
]);

或者通过 "set" 方法。API 文档中所有文档化的参数都可以添加。

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

如果您愿意,甚至可以链式调用它们。

// Add parameters via the set() method
$query->set('page', '2')
    ->set('full_time', 'true');

然后将查询对象注入到提供者中。

// Instantiating provider with a query object
$client = new JobApis\Jobs\Client\Provider\GithubProvider($query);

然后调用 "getJobs" 方法来检索结果。

// Get a Collection of Jobs
$jobs = $client->getJobs();

这将返回一个 Collection 对象的 Job 集合。

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息,请参阅 CONTRIBUTING

致谢

许可

Apache 2.0。有关更多信息,请参阅 许可文件