messerli90 / igdb

Laravel PHP Facade/Wrapper for the IGDB API

IGDB (Internet Game Database)

Introduction

This packages provides a nice and easy wrapper around the IGDB API for use in your Laravel application.

In order to use the IGDB API, you must have a account and key. You can register your app at https://api.igdb.com/.

Installation

Add messerli90/igdb to your composer.json.

"messerli90/igdb": "~1.0"

or

composer require messerli90/igdb

Run composer update to pull down the latest version of the package.

Now open up app/config/app.php and add the service provider to your providers array.

'providers' => array(
    Messerli90\IGDB\IGDBServiceProvider::class,
)

Optionally, add the facade to your aliases array

'IGDB' => \Messerli90\IGDB\Facades\IGDB::class,

Configuration

Add the igdb to your config/services.php array. Set cache to a number of minutes to cache responses.

'igdb' => [
    'key' => 'YOUR_IGDB_KEY',
    'url' => 'YOUR_IGDB_URL',
    'cache' => 0
]

Usage

// Get Game by ID
$game = IGDB::getGame(9630);

// Customize / limit the returned fields
$games = IGDB::getGame(9630, ['name', 'release_dates', 'esrb', 'genres'], $limit = 10, $offset = 0, $order = 'release_dates.date:desc');

// Search Games by name
$games = IGDB::searchGames('fallout');

// Get Character by ID
$character = IGDB::getCharacter(4534);

// Search Characters by name
$characters = IGDB::searchCharacters('fisher');

// Get upcoming releases
$releases = IGDB::getReleases($filters = ['filter[platform][eq]=48', 'filter[date][gt]=1500619813000], $fields = ['*'], $limit = 10, $offset = 0, $order = 'date:asc');

// Get Company by ID
$companies = IGDB::getCompany('ubisoft');

// Search Company by name
$company = IGDB::getCompany(7041);

// Get Franchise by ID
$franchise = IGDB::getFranchise(133);

// Search Franchise by name
$franchises = IGDB::searchFranchises('Harry Potter');

// Get Game Mode by Id
$game_mode = IGDB::getGameMode(1);

// Search Game Modes by name
$game_modes = IGDB::searchGameModes('Single Player');

// Get Genre by ID
$genre = IGDB::getGenre(15);

// Search Genres by name
$genres = IGDB::searchGenres('strategy');

// Get Keyword by ID
$keyword = IGDB::getKeyword(121);

// Search Keyword by name
$keywords = IGDB::searchKeywords('sandbox');

// Get Person by ID
$person = IGDB::getPerson(24354);

// Search People by name
$people = IGDB::searchPeople('Delaney');

// Get Platform by ID
$platform = IGDB::getPlatform(49);

// Search Platforms by name
$platforms = IGDB::searchPlatforms('xbox');

// Get Player Perspective by ID
$player_perspective = IGDB::getPlayerPerspective(7);

// Search Player Perspective by name
$player_perspectives = IGDB::searchPlayerPerspectives('Virtual');

// Get Pulse by ID
$pulse = IGDB::getPulse(20707);

// Fetch latest Pulses
$pulses = IGDB::fetchPulses();

// Get Collection / Series by ID
$collection = IGDB::getCollection(3);

// Search Collections / Series by name
$collections = IGDB::searchCollections('fallout');

// Get Theme by ID
$theme = IGDB::getTheme(39);

// Search Themes by name
$themes = IGDB::searchThemes('warfare');

Format of returned data

The returned JSON data is decoded as a PHP object.

Run Unit Test

If you have PHPUnit installed in your environment, run:

$ phpunit

IGDB API

• IGDB API Docs
• Register application and obtain API key

Contributing

Please see CONTRIBUTING for details.

Credits

• Michael Messerli
• k4kuz0

License

The MIT License (MIT). Please see License File for more information.

igdb's Issues

Non-static method should not be called statically

Hi, I have this error

Non-static method Messerli90\IGDB\IGDB::searchGames() should not be called statically

$games = IGDB::searchGames($pQuery);

Laravel?

Hi, what ist Laravel?
Do I need this for my simple php script to use this API?

config

there is no config folder ?

Default searchGame() ordering should be blank, not release date

Hey nice API wrapper!,

I noticed that in the following line of code:

igdb/src/IGDB.php

Line 282 in 8c9ee67

public function searchGames($search, $fields = ['*'], $limit = 10, $offset = 0, $order = 'release_dates.date:desc')

You set the default search ordering to be 'release_dates.date:desc'. 9 times out of 10, I think this produces results you don't want, for example, upon searching "The Witcher 3", I get this:

[ { "id": 2933, "name": "Kingdom Hearts III" }, { "id": 13165, "name": "The Guild 3" }, { "id": 12579, "name": "Danganronpa V3: Killing Harmony" }, { "id": 7333, "name": "Crackdown 3" }, { "id": 18980, "name": "Warhammer 40,000: Dawn of War III" }, { "id": 11806, "name": "Dark Cloud 3" }, { "id": 17583, "name": "SpellForce 3" }, { "id": 13215, "name": "Cossacks 3" }, { "id": 13163, "name": "Syberia 3" }, { "id": 11542, "name": "Shenmue III" } ]

Whereby the real result I clearly wanted is absent, since the game is "too old".

I'd recommend changing it to be "null" since the ordering is not a required parameter, but I'm not sure if that will break your code. (I am currently using my own API wrapper).

Expand igdb class

Hi,

maybe it would be helpful, if the methods [getEndpoint, decodeSingle, decodeMultiple, apiGet] will be declared as protected instead of private, to expand the class by extending from it.

Hi.

I have this error when try to do something
Unresolvable dependency resolving [Parameter #0 [ <required> $key ]] in class Messerli90\IGDB\IGDB