Read from the package's own PHP files at the commit 11592554ed5b: its namespaces, classes, interfaces and enums, their public constants, properties and methods with their PHPDoc, and the options its factories take. Nothing of it is run.
IgdbFactoryclass"igdb": options client_id and client_secret (required: a Twitch application's), api, token_url, images.
5 options · 1 method
IgdbProviderclassIGDB, Twitch's games database: an application token got from Twitch with the client credentials and kept until it expires; search and a game's record by Apicalypse queries; a game found by its IGDB number or by its Steam or GOG number (external_games); its identifiers on the stores.
6 methods · 1 constant
Omniplay\Igdb
IgdbFactory class
final class IgdbFactory extends ProviderFactory IgdbFactory.php:13
"igdb": options client_id and client_secret (required: a Twitch application's), api, token_url, images.
Options
| Option | Default | |
|---|---|---|
api | 'https://api.igdb.com/v4' | |
token_url | 'https://id.twitch.tv/oauth2/token' | |
images | 'https://images.igdb.com/igdb/image/upload' | |
client_id | required | |
client_secret | required |
IgdbFactory::__construct()
public function __construct(readonly ?HttpClientInterface $http = null)IgdbProvider class
final class IgdbProvider implements ProviderInterface, SearchInterface, CatalogueInterface IgdbProvider.php:29
IGDB, Twitch's games database: an application token got from Twitch with the client credentials and kept until it expires; search and a game's record by Apicalypse queries; a game found by its IGDB number or by its Steam or GOG number (external_games); its identifiers on the stores.
const SOURCES = [1 => 'steam', 5 => 'gog', 26 => 'epic', 30 => 'itch']IGDB's external game sources: the store each number belongs to.
IgdbProvider::__construct()
public function __construct(readonly JsonClient $json, readonly string $clientId, readonly string $clientSecret, readonly string $api = 'https://api.igdb.com/v4', readonly string $tokenUrl = 'https://id.twitch.tv/oauth2/token', readonly string $images = 'https://images.igdb.com/igdb/image/upload')IgdbProvider::getName()
public function getName(): stringIgdbProvider::getTitle()
public function getTitle(): stringIgdbProvider::capabilities()
public function capabilities(): CapabilitiesIgdbProvider::search()
public function search(Query $query): arrayIgdbProvider::game()
public function game(GameRef $ref, ?string $language = null, ?string $country = null): ?Game