chadicus / marvel-api-client

A PHP Client for use with the Marvel API

Marvel API Client

A PHP client for use with the Marvel API.

Requirements

The Marvel API Client requires PHP 7.0 (or later).

Composer

To add the library as a local, per-project dependency use Composer! Simply add a dependency on chadicus/marvel-api-client to your project's composer.json file such as:

composer require chadicus/marvel-api-client

Examples

Examples of use can be found here

Basic Usage

<?php

require_once __DIR__ . '/vendor/autoload.php';

use Chadicus\Marvel\Api\Client;

$publicApiKey = 'YOUR PUBLIC API KEY';
$privateApiKey = 'YOUR PRIVATE API KEY';

$client = new Client($privateApiKey, $publicApiKey);

$dataWrapper = $client->get('characters', 1009351);

//Text to display for attribution requirements
$attributionText = $dataWrapper->getAttributionText();

$character = $dataWrapper->getData()->getResults()[0];

echo "{$character->getName()}\n";
echo "{$character->getDescription()}\n";

foreach ($character->getEvents()->getItems() as $event) {
    echo "\t{$event->getName()}\n";
}

Community

Contact

Developers may be contacted at:

• Pull Requests
• Issues

Project Build

With a checkout of the code get Composer in your PATH and run:

composer install
./vendor/bin/phpunit

With Great Power Comes Great Responsibility.

When using the marvel-api-client you must follow Marvel's Rules of Attribution

marvel-api-client's Issues

Update coveralls dependency

satooshi/php-coveralls has become php-coveralls/php-coveralls. The dev dependencies should be updated accordingly.

Duplicate Code

see https://scrutinizer-ci.com/g/chadicus/marvel-api-client/inspections/fbc9a6dc-a14d-4647-8981-26f0cf0a25c9/code-structure/class/Chadicus%5CMarvel%5CApi%5CEntities%5CDate#inspectioncomment-1131708941

PHP 7

Please update composer.json to allow installation for PHP 7

Custom phpdocumentor template

Create a custom template using Marvel artwork.

Add PHP 7.2 to travis-ci build

Travis-CI now allows PHP 7.2 builds. It should be added to the .travis-ci.yml file.

Cannot Search for Series or Stories

Hello,

I am having an issue using the client->search() function to retrieve stories or series.

protected function getItems(Character $character, $itemType)
{
    $comicWrapper = $this->client->search($itemType, [
        'characters' => $character->id,
        'limit'      => 40
    ]);
    return $comicWrapper->getData()->getResults();
}

Expected Behavior

if $itemType = 'comics this function returns an array or comics
if $itemType = 'events this function returns an array or events
if $itemType = 'stories' this function returns an array or stories
if $itemType = 'series' this function returns an array or series

Actual Behavior

if $itemType = 'comics this function returns an array or comics
if $itemType = 'events this function returns an array or events

if $itemType = 'stories' && $itemType = 'series' produce the following error:

PHP Fatal error:  Uncaught Symfony\Component\Debug\Exception\FatalThrowableError: Type error: Argument 1 passed to Chadicus\Marvel\Api\Entities\AbstractEntity::fromArray() must be of the type array, null given in /home/tim/ContinuumTest/vendor/chadicus/marvel-api-client/src/Entities/AbstractEntity.php:109
Stack trace:
#0 [internal function]: Chadicus\Marvel\Api\Entities\AbstractEntity::fromArray(NULL)

#1 /home/tim/ContinuumTest/vendor/dominionenterprises/filter/src/Filterer.php(166): call_user_func_array('\\Chadicus\\Marve...', Array)

#2 /home/tim/ContinuumTest/vendor/chadicus/marvel-api-client/src/Filterer.php(53): DominionEnterprises\Filterer::filter(Array, Array, Array)

#3 /home/tim/ContinuumTest/vendor/chadicus/marvel-api-client/src/Entities/AbstractEntity.php(29): Chadicus\Marvel\Api\Filterer::filter(Array, Array, Array)

#4 /home/tim/ContinuumTest/vendor/chadicus/marvel-api-client/src/Entities/AbstractEntity.php(96): Chadicus\Marvel\Api\Entities\AbstractEntity->__construct(Array)

#5 [internal function]: Chadicus\Marvel\Ap in /home/tim/ContinuumTest/vendor/chadicus/marvel-api-client/src/Entities/AbstractEntity.php on line 109

Implement skip($offset) method

Implement a skip() method which would set a starting offset for the collection. It could return itself or a clone of itself with an absolute limit

/**
 * Return a collection with the given $offset
 *
 * @param integer $offset
 *
 * @return Collection
 */
public function skip($offset)
{
}

Duplicate Code

see https://scrutinizer-ci.com/g/chadicus/marvel-api-client/inspections/fbc9a6dc-a14d-4647-8981-26f0cf0a25c9/issues/files/src/Entities/Url.php?status=new&orderField=path&order=asc#inspectioncomment-1131708945

Duplicate Code

see https://scrutinizer-ci.com/g/chadicus/marvel-api-client/inspections/1c16be20-e950-434e-9ce1-e57da382b078/issues/files/src/Entities/Price.php?status=new&orderField=path&order=asc#inspectioncomment-1117064256

Laravel 5.1 wrapper ?

Implement Collection::take($limit)

Implement a take() method which would set an absolute limit in the collection. It could return itself or a clone of itself with an absolute limit

/**
 * Return a collection limited to $limit number of items
 *
 * @param integer $limit
 *
 * @return Collection
 */
public function take($limit)
{
}

limit & offset filters overriden ?

Hi, I'm using your lib to pull comics for a serie and I can't seem to be able to paginate results,
passing 'limit' & 'offset' keys to the "filters" array when creating a new Collection object always returns all of comics and not the ones included in the limits.
could you help me out please ?
Thanks for providing this lib though.