Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.03 KB

README.md

File metadata and controls

77 lines (52 loc) · 3.03 KB

Marvel API Client

Build Status Code Quality Code Coverage

Latest Stable Version Latest Unstable Version License

Total Downloads Daily Downloads Monthly Downloads

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

Gitter

Contact

Developers may be contacted at:

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