README

作者: Grzegorz Gajda grz.gajda@outlook.com

更新 v1.1.1

当字符串包含空格字符时，过滤等参数的参数没有工作。在版本1.1.1中，这个问题已修复。此外，98%的代码已覆盖（目录 tests）。

更新 v1.1.0

如果您不想使用CURLConnection类，我添加了与guzzlehttp/guzzle包的内置集成。从版本1.1.0开始，HTTP连接的默认提供者是GuzzleConnection类。

基本用法

首先，我们需要创建一个RegisterKey对象的实例以验证我们的密钥。我们可以使用ComicVine静态类来创建该对象。

$apiKey = ComicVine::makeApiKey('YOUR_KEY');

接下来，我们需要将密钥和连接注册到ComicVine类。默认情况下，方法register使用内置的CURLConnection类来建立连接。然后，您不需要第二个参数。

ComicVine::register($instanceOfRegisterKey, $instanceOfConnection = null)

注册后，我们可以创建查询以访问ComicVine API。但默认情况下，响应将以XML格式返回。我们可以通过创建ResponseFormat类的实例来更改响应格式。

$responseFormat = ComicVine::createFormat('json');

然后使用查询（我们想要找到蝙蝠侠的url）

$response = ComicVine::getCharacters()
    ->setFormat($responseFormat)
    ->setFilters(['name' => 'Batman']
    ->setLimit(1)
    ->setFieldList(['api_detail_url'])
    ->getResponse();

现在，变量$response保存了从ComicVine API获得的JSON响应。

请求

实现资源列表

通过调用每个get方法创建一个ControllerQuery类的新实例。 ControllerQuery类允许我们

/*
 * Argument for setFieldList is array containing
 * only names of fields which we want.
 */
$response->setFieldList(['api_detail_url', 'aliases'])
/*
 * Set filters to find resource you want. It needs key => value
 * schema and allows for many filters.
 */
    ->setFilters(['name' => 'Batman', 'aliases' => 'Fatherless'])
/*
 * Allows to sort response. Key is name of field, value is asc or desc
 * only.
 */
    ->setSort(['date_added' => 'asc'])
/*
 * Set how much elements do you want to get. Maximum limit is 100
 * (API restrictions).
 */
    ->setLimit(100)
/*
 * From which position we would want to start getting elements.
 */
    ->setOffset(50)
/*
 * After setting request query (set methods), times to get
 * response. Get response return XML object or JSON string.
 */
    ->getResponse() 

扩展

查看当前包的状态，您可以编写自己的Connection类（必须实现interface Connection）和ResponseFormat（必须实现interface ResponseFormat）。我们可以在ComicVine::register()方法中使用新的Connection类，在setFormat方法中使用新的ResponseFormat类。

许可证

该包是开源软件，遵循MIT许可证。