compucie / congressus
用于Congressus API的库。
此包的规范存储库似乎已不存在,因此该包已被冻结。
2.1.1
2024-08-10 14:59 UTC
Requires
- guzzlehttp/guzzle: ^7.8
Requires (Dev)
- phpunit/phpunit: 11
README
基础知识
使用此库所需要的一切就是一个从Congressus获得的API令牌/密钥。使用此令牌来实例化一个Client。您可以使用Client本身或从它派生出一个子类。
Client具有针对Congressus API每个可能调用的方法。您可以直接使用这些方法,或者在其子类的方法中使用它们来创建更复杂的请求。后者是此库最强大的方式,因为您可以创建一个完全满足您需求的类。
发起请求
Client中方法的名称是Congressus API文档中名称的驼峰式版本。例如,API调用列出组成员是通过Client的listGroupMemberships()方法完成的。
路径参数、查询参数和请求体字段作为这些方法的参数传递。在Client中的名称始终与API文档中的名称相同。
示例
// Instatiate an API client with a token stored in environment variable "MyCongressusToken":
$client = new Client(getenv("MyCongressusToken"));
// Request a listing of the next 5 events in order of most to least soon:
$upcomingEvents = $client->listEvents(limit: 5, order: "start:asc");
// Print the events
echo "The next 5 events are:" . PHP_EOL
foreach ($upcomingEvents as $event) {
echo $nextEvent->getName() . PHP_EOL;
}