⚠️ Notice

https://fabdb.net is shutting down.

Flesh and Blood (fabdb.net) API library

A library to communicate with the fabdb.net API.

Installation

This library can be installed via composer.

composer require memuya/fabdb-php-sdk

Usage

The quickest way to get started is to use the Client through the FleshAndBlood class. FleshAndBlood is a wrapper to easily call all endpoints the fabdb.com API has to offer.

A new instance can be created by creating a Client object.

use Memuya\Fab\Client;

$client = new Client;

You can then pass the client to the FleshAndBlood instance.

use Memuya\Fab\FleshAndBlood;

$fab = new FleshAndBlood($client);

Note that you can use the Client object directly to have more control. See examples below for more information.

Formatter

You can change the response format by passing a Formatter to the client. By default, JsonFormatter is used. This is used to also populate the Accept request header.

Please note that the API does not seem to honor anything but JSON in the Accept header. This means only JsonFormatter should be used.

List of formatters:

new \Memuya\Fab\Formatter\JsonFormatter; // Accept: application/json
new \Memuya\Fab\Formatter\XmlFormatter; // Accept: application/xml
new \Memuya\Fab\Formatter\CsvFormatter; // Accept: text/csv

You can use a formatter via the contructor or the setter method:

// Via the contructor.
$client = new Client(new JsonFormatter);

// Via the setter.
$client->setFormatter(new JsonFormatter);

List of Cards

Returns a paginated list of cards. The list of cards can be filtered down using the CardsConfig object. See below example for all filtering options. All filtering options are optional. If a filter is not valid, an InvalidCardConfigException exception in thrown. For a full list of options please see the API documentation.

FleshAndBlood object example:

use Memuya\Fab\Enums\Set;
use Memuya\Fab\Enums\Pitch;
use Memuya\Fab\Enums\Rarity;
use Memuya\Fab\Enums\HeroClass;
use Memuya\Fab\Exceptions\InvalidCardConfigException;

try {
    $fab->getCards([
        'page' => 1,
        'per_page' => 10,
        'keywords' => 'search terms',
        'cost' => '1',
        'pitch' => Pitch::One,
        'class' => HeroClass::Brute,
        'rarity' => Rarity::Common,
        'set' => Set::WelcomeToRathe,
    ]);
} catch (InvalidCardConfigException $ex) {
    // Handle exception...
}

Client object example:

use Memuya\Fab\Enums\Set;
use Memuya\Fab\Enums\Pitch;
use Memuya\Fab\Enums\Rarity;
use Memuya\Fab\Enums\HeroClass;
use Memuya\Fab\Endpoints\Cards\CardsConfig;
use Memuya\Fab\Endpoints\Cards\CardsEndpoint;
use Memuya\Fab\Exceptions\InvalidCardConfigException;

try {
    $cards = $client->sendRequest(
        new CardsEndpoint(
            new CardsConfig([
                'page' => 1,
                'per_page' => 10,
                'keywords' => 'search terms',
                'cost' => '1',
                'pitch' => Pitch::One,
                'class' => HeroClass::Brute,
                'rarity' => Rarity::Common,
                'set' => Set::WelcomeToRathe,
            ])
        )
    );
} catch (InvalidCardConfigException $ex) {
    // Handle exception...
}

Return a Card

Search for a card using its identifier.

FleshAndBlood object example:

$fab->getCard('ARC000');

Client object example:

use Memuya\Fab\Endpoints\Card\CardConfig;
use Memuya\Fab\Endpoints\Card\CardEndpoint;

$client->sendRequest(
    new CardEndpoint(
        new CardConfig(['identifier' => 'ARC000'])
    )
);

Decks

Return information on a given deck.

FleshAndBlood object example:

$fab->getDeck('deck-slug');

Client object example:

use Memuya\Fab\Endpoints\Deck\DeckConfig;
use Memuya\Fab\Endpoints\Deck\DeckEndpoint;

$client->sendRequest(
    new DeckEndpoint(
        new DeckConfig(['slug' => 'deck-slug'])
    )
);