README

介绍

此PHP扩展作为IGDB API接口查询的包装器。它包含一个查询构建器，您可以添加搜索条件。

您必须拥有IGDB账户才能使用API。您可以在https://api.igdb.com/注册新账户。

项目: (https://gitlab.com/s1njar/igdb/)

安装

运行composer以引入此包

composer require s1njar/igdb

用法

注意 参数（url、apikey、endpoint）是必需的。

默认工作流程

//Create new SearchBuilder object.
$searchBuilder = new SearchBuilder($apiKey);

//Add the endpoint to be requested.
$searchBuilder = $searchBuilder->addEndpoint('games');

//Add the fields you want to return.
$searchBuilder = $searchBuilder->addFields(['id', 'name']);

//Add multiple filters to refine the search.
$searchBuilder = $searchBuilder->addFilter('rating', '=', '75');

//Add multiple filters to refine multi filter search.
$searchBuilder = $searchBuilder->addFilter('platforms', '=', (1,2,3));

//Add a limit.
$searchBuilder = $searchBuilder->addLimit('10');

//Add an offset.
$searchBuilder = $searchBuilder->addOffset('0');

//Add an order.
$searchBuilder = $searchBuilder->addOrder('popularity', 'desc');

//Trigger the search. It returns an Response object.
$searchBuilder = $searchBuilder->search();

//Decode the response from the server and return an array of objects.
$response = $searchBuilder->get();

通过id请求。

//Create new SearchBuilder object.
$searchBuilder = new SearchBuilder($apiKey);

//Add endpoint and search by id.
$response = $searchBuilder
    ->addEndpoint('games')
    ->searchById(1, ['name', 'id'])
    ->get();

通过搜索请求

//Create new SearchBuilder object.
$searchBuilder = new SearchBuilder($apiKey);

//Add endpoint, fields and search needle.
$response = $searchBuilder
    ->addEndpoint('games')
    ->addFields(['id'])
    ->addSearch('witcher')
    ->search()
    ->get();

响应格式

数据以Json格式返回并转换为PHP对象的数组。

示例响应

[
    0 => {
        'id' => '1',
        'name' => 'Witcher'
    },
    1 => {
        'id' => '2',
        'name' => 'Fallout'
    }
]

运行单元测试

在您的环境中安装phpunit并运行

$ phpunit

IGDB API

• 获取IGDB账户凭证

致谢

• s1njar

许可

MIT许可（MIT）。