2017 © Pedro Peláez
 

library comicvine-api

PHP class wrapper providing a simple and flexible methods to using ComicVine API.

image

grzgajda/comicvine-api

PHP class wrapper providing a simple and flexible methods to using ComicVine API.

  • Tuesday, November 10, 2015
  • by grz-gajda
  • Repository
  • 3 Watchers
  • 5 Stars
  • 31 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 4 Versions
  • 7 % Grown

The README.md

ComicVine API

Scrutinizer Build Status Coveralls Packagist Packagist, (*1)

Author: Grzegorz Gajda grz.gajda@outlook.com, (*2)

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)., (*3)

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., (*4)

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., (*5)

$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., (*6)

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., (*7)

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

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

$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., (*9)

Requests

List of implemented resources:, (*10)

URL method implemented?
/character none false
/characters getCharacters true
/chat none false
/chats getChats true
/concept none false
/concepts getConcepts true
/episode none false
/episodes getEpisodes true
/issue none false
/issues getIssues true
/location none false
/locations getLocations true
/movie none false
/movies getMovies true
/object none false
/objects getObjects true
/origin none false
/origins getOrigins true
/person none false
/people getPeople true
/power none false
/powers getPowers true
/promo none false
/promos getPromos true
/publisher none false
/publishers getPublishers true
/series none false
/series_list getSeriesList true
/search getSearch false
/story_arc none false
/story_arcs getStoryArcs true
/team none false
/teams getTeams true
/video none false
/videos getVideos false
/video_type none false
/video_types getVideoTypes true
/volume none false
/volumes getVolumes true

Calling each one of get method creating a new instance of ControllerQuery class. ControllerQuery class allows us to:, (*11)

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

License

The package is open-sourced software licensed under the MIT license, (*13)

The Versions

10/11 2015

dev-master

9999999-dev

PHP class wrapper providing a simple and flexible methods to using ComicVine API.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar grz-gajda

comics comicbooks comicvine comicvine-api grzegorz gajda

10/11 2015

v1.0.0

1.0.0.0

PHP class wrapper providing a simple and flexible methods to using ComicVine API.

  Sources   Download

MIT

The Development Requires

by Avatar grz-gajda

comics comicbooks comicvine comicvine-api grzegorz gajda

10/11 2015

v1.1.0

1.1.0.0

PHP class wrapper providing a simple and flexible methods to using ComicVine API.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar grz-gajda

comics comicbooks comicvine comicvine-api grzegorz gajda

10/11 2015

v1.1.5

1.1.5.0

PHP class wrapper providing a simple and flexible methods to using ComicVine API.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar grz-gajda

comics comicbooks comicvine comicvine-api grzegorz gajda