developermarius/eventim-public-api

Eventim公共API的包装器

dev-main 2024-05-31 11:26 UTC

This package is auto-updated.

Last update: 2024-08-31 00:44:09 UTC


README

这是一个Eventim公共API的简单包装器。它使用PHP编写,提供了一个简单的方式来访问Eventim公共API。
Eventim公共API是一个RESTful API,通过其搜索功能提供对Eventim产品的访问。
在对Eventim公共API进行了一些简单的分析之后,我在gist中记录了一些API组件。您可以在这里找到它。

安装

要安装这个库,您需要在您的系统上安装Composer。如果您还没有安装,您可以从这里下载。

一旦您安装了Composer,您可以在终端运行以下命令来安装库

composer require developermarius/eventim-public-api

使用

初始化

首先,您需要导入EventimClient类并创建一个新实例。

use developermarius\eventim\publicapi\EventimClient;

$client = new EventimClient();

搜索产品

要搜索产品,您可以使用search方法。此方法接受一个可选的EventimSearchQuery对象。如果没有提供查询对象,将使用默认对象。

use developermarius\eventim\publicapi\models\EventimSearchQuery;

$query = EventimSearchQuery::new()->categories(array(
    EventimCategoryType::HUMOR,
    EventimCategoryType::CONCERT
))->cityNames(array(
    'Frankfurt am Main'
));

$response = $client->search($query);

search方法返回一个包含搜索结果的EventimSearchResponse对象。

分页搜索结果

要分页搜索结果,您可以使用paginateSearch方法。此方法接受一个回调函数、一个可选的EventimSearchQuery对象以及可选的请求之间的睡眠时间。

$allProducts = $client->paginateSearch(function($response) {
    // Process each page of results here
}, $query, 2);

限制

请注意,由于Eventim方面的限制,此库无法处理大于102的页码。如果您尝试访问页码大于102,将抛出异常。

贡献

欢迎贡献!请随意提交拉取请求。

许可

此库是开源软件,根据MIT许可授权。