ikwattro / github-event
Github API 公共事件到 PHP 对象映射器
1.0.10
2015-06-29 21:30 UTC
Requires
- php: ~5.4
- symfony/config: ~2.6
- symfony/dependency-injection: ~2.6
- symfony/yaml: ~2.6
Requires (Dev)
- phpspec/phpspec: ~2.1
- phpunit/phpunit: ~4.0
README
Github API 公共事件到 PHP 对象
将 Github API 公共事件 转换为 PHP 对象
安装
在您的 composer.json
中需要此库
composer require ikwattro/github-event
用法
构建 EventHandler
应用需要通过工厂构造函数进行构建,目前不需要这种工厂设计,但目的是为了未来的扩展性。
use Ikwattro\GithubEvent\EventHandler; $eventHandler = EventHandler::create() ->build();
传递事件
库的主要功能是 handleEvent
方法,该方法接受一个数组格式的 GithubEvent(json_decoded)作为参数。
传递后,您将收到对应事件的 PHP 对象实例。
$events = json_decode('events.json', true); foreach ($events as $e) { $event = $eventHandler->handleEvent($e); }
处理事件
事件对象可能包含当前事件之外的信息,例如,一个 CreateEvent
将包含事件的载荷,以及相关的 Repository 对象、RepositoryOwner 等。
请参考源代码以了解每个事件中包含的内容。
当前支持的事件
- WatchEvent
- IssuesEvent
- IssueCommentEvent
- CreateEvent
- PushEvent
- ForkEvent
- PullRequestEvent
许可证
此库采用 MIT 许可证授权