marcreichel/igdb-laravel

A Laravel wrapper for version 4 of the IGDB API (Apicalypse) including webhook handling

4.3.0 2024-07-01 09:48 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ~6.0|~7.0
• illuminate/support: ^9.0|^10.0|^11.0
• nesbot/carbon: ^2.53.1|^3.0

Requires (Dev)

• larastan/larastan: ^2.9.2
• laravel/pint: ^1.13
• nunomaduro/collision: ^5.3|^6.1|^7.0|^8.0
• orchestra/testbench: ^6.23|^7.0|^8.0|^9.0
• pestphp/pest: ^2
• pestphp/pest-plugin-type-coverage: ^2.8.3
• phpunit/phpunit: ^9.5.4 || ^10.0.0
• roave/security-advisories: dev-latest

MIT

• Marc Reichel

• wrapper
• laravel
• api-wrapper
• igdb
• apicalypse
• igdb-api

README

This is a Laravel wrapper for version 4 of the IGDB API (Apicalypse) including webhook handling.

Basic installation

You can install this package via composer using:

composer require marcreichel/igdb-laravel

The package will automatically register its service provider.

To publish the config file to config/igdb.php run:

php artisan igdb:publish

This is the default content of the config file:

return [
    /*
     * These are the credentials you got from https://dev.twitch.tv/console/apps
     */
    'credentials' => [
        'client_id' => env('TWITCH_CLIENT_ID', ''),
        'client_secret' => env('TWITCH_CLIENT_SECRET', ''),
    ],

    /*
     * This package caches queries automatically (for 1 hour per default).
     * Here you can set how long each query should be cached (in seconds).
     *
     * To turn cache off set this value to 0
     */
    'cache_lifetime' => env('IGDB_CACHE_LIFETIME', 3600),

    /*
     * Path where the webhooks should be handled.
     */
    'webhook_path' => 'igdb-webhook/handle',

    /*
     * The webhook secret.
     *
     * This needs to be a string of your choice in order to use the webhook
     * functionality.
     */
    'webhook_secret' => env('IGDB_WEBHOOK_SECRET', null),
];

Documentation

You will find the full documentation on the dedicated documentation site.

Testing

Run the tests with:

composer test

Contribution

Pull requests are welcome :)