theconcepteur/ogame-public-api

Ogame 公共API使用的类

dev-master 2021-07-22 15:09 UTC

This package is auto-updated.

Last update: 2024-09-22 22:21:21 UTC


README

PHP类,用于获取GameForge OGame公共API的信息

安装

composer require theconcepteur/ogame-public-api:dev-master

用法

类构造函数接收3个参数:服务器编号、区域和布尔值,用于激活缓存(强烈推荐!)

use OgamePublicApi\OgamePublicApi;
$og = new OgamePublicApi(179,'fr',true);

API

获取玩家列表(初始化时调用)

$og->getPlayers()

获取联盟列表(初始化时调用)

$og->getAlliances

获取ID为$id的玩家的星球和月球信息

$og->getPlayerData($id)

启用缓存系统后,您可以一次调用获取玩家的数据和其星球及卫星

$og->getPlayer($id)

缓存系统

该类提供内置的缓存系统。存在两种缓存文件类型:xmljson

xml缓存ogame API文件

json缓存内部系统文件

在类初始化时,我们构建联盟和玩家列表,并预先创建player_X.json文件。

当我们调用$og->getPlayerData($id)时,我们写入此调用的xml文件,并更新player_X.json文件中的数据。

这样我们就有了一个包含所有玩家数据的完整文件。

每个API调用都有一个相关的文件,这些文件有不同的缓存过期时间。这个时间在cacheValid函数中相应地配置,根据官方间隔的信息。