ComicVine API

Author: Grzegorz Gajda grz.gajda@outlook.com

Update v1.1.1

Arguments for filters etc. didn't work when string has space character. With version 1.1.1, it is fixed. Also 98% of code has coverage (directory tests).

Update v1.1.0

If you don't want to use CURLConnection class, I added built-in integration with guzzlehttp/guzzle package. Since version 1.1.0, default provider for HTTP connection is GuzzleConnection class.

Basic usage

First, we need to create instance of RegisterKey object to verify our key. We can use ComicVine static class to make that object.

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

Next, we need register key and connection to ComicVine class. By default, method register use built-in CURLConnection class to make connections. Then, you haven't to write second argument.

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

After registering, we can creating query to ComicVine API. But by default, response will be in XML format. We can change response format by creating instance of ResponseFormat class.

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

and then using query (we want to find url to Batman):

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

Now, variable $response keep our JSON response from ComicVine API.

Requests

List of implemented resources:

Calling each one of get method creating a new instance of ControllerQuery class. ControllerQuery class allows us to:

/*
 * 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() 

Extending

Looking on current state of package, you can write your own Connection class (must implement interface Connection) and ResponseFormat (must implement interface ResponseFormat). We can use new Connection class in ComicVine::register() method and new ResponseFormat class in setFormat method.

License

The package is open-sourced software licensed under the MIT license