webcore/snitcher

Dead Man's Snitch 的简单 API 客户端

v0.1.0 2016-06-09 12:25 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:53:00 UTC


README

Dead Man's Snitch 的简单 API 客户端,受官方 Ruby 客户端 启发

Dependency Status license

安装

通过 Composer

composer require webcore/snitcher

Snitcher 依赖于 HTTPlug HTTP 客户端抽象层。你可以在 HTTPlug 文档中阅读更多关于 HTTPlug 框架与 Symfony bundle 的集成

用法

使用 Guzzle HTTP 客户端的示例

安装依赖项

  • 使用 Guzzle 实现HttpClient适配器

    composer require php-http/guzzle6-adapter
    
  • MessageFactory、StreamFactory 和 UriFactory 的实现

    composer require php-http/message
    

创建所需的工厂

use Http\Adapter\Guzzle6\Client;
use Http\Message\MessageFactory\GuzzleMessageFactory;
use Http\Message\StreamFactory\GuzzleStreamFactory;
use Http\Message\UriFactory\GuzzleUriFactory;

$httpClient = new Client(new GuzzleHttp\Client());
$messageFactory = new GuzzleMessageFactory();
$streamFactory = new GuzzleStreamFactory();
$uriFactory = new GuzzleUriFactory();

创建 Snitcher 实例

use Webcore\Snitcher\Snitcher;
$snitcher = new Snitcher($httpClient, $messageFactory, $streamFactory, $uriFactory);

检查你的一个 snitch

$snitcher->snitch("c2354d53d2");

你还可以在检查时提供一条消息

$snitcher->snitch("c2354d53d2", "Finished in 23.8 seconds.")

如果发生错误,将抛出以下异常之一

InvalidArgumentException
HttpClientException
Exception

示例 composer.json

{
    "name": "some-user/nice-project",
    "require": {
        "webcore/snitcher": "^1.0.0",
        "php-http/guzzle6-adapter": "^1.1.1",
        "php-http/message": "^1.2.0"
    }
}

待办事项

MIT 许可证

版权 (c) 2016, Štefan Peťovský