README

弃用包 -- 立即迁移！

截至2023年9月10日，此包不再维护。

请更新到新版本：https://github.com/TextControl/textcontrol-reportingcloud。

⚠️ 请务必查看新包的 CHANGELOG.md。

ReportingCloud PHP SDK

这是 ReportingCloud Web API 的官方 PHP SDK。由 Text Control GmbH 编写和支持。

了解 ReportingCloud 的更多信息

• ReportingCloud 网站

• ReportingCloud 门户 - 现在注册

• ReportingCloud 文档

了解 ReportingCloud PHP SDK 的更多信息

• ReportingCloud PHP SDK GitHub 页面

• ReportingCloud PHP SDK Packagist 页面

• ReportingCloud PHP SDK API 文档

• ReportingCloud PHP SDK 支持

最低要求

从 ReportingCloud PHP SDK 3.0 开始，PHP SDK 需要 PHP 7.4 或 PHP 8.0。

所有低于 7.3 的 PHP 版本都已达到 生命周期的结束，因此，将不会为它们发布进一步的安全更新。如果您在较旧的环境中运行应用程序，强烈建议您更新到更现代的 PHP 版本。

如果您无法或不愿更新 PHP 安装，您可以考虑使用支持 PHP 7.1 的 ReportingCloud PHP SDK 2.0，或支持 PHP 5.6 的 ReportingCloud PHP SDK 1.0。

请注意，这些版本不再维护。

另外，您也可以通过直接访问 Web API 来使用 ReportingCloud。在这种情况下，建议使用 curl 扩展来执行 API 调用。

使用 Composer 安装

使用 Composer 在您的项目中安装 ReportingCloud PHP SDK 3.0

composer require textcontrol/txtextcontrol-reportingcloud:^3.0

安装后，只需包含 Composer 的自动加载器

include_once 'vendor/autoload.php';

现在您可以使用 SDK 了。

演示和单元测试的 API 密钥

ReportingCloud PHP SDK附带了一系列示例应用程序（请参阅目录/demo）和phpunit测试（请参阅目录/test）。每个目录中的脚本都需要 ReportingCloud 的API密钥才能执行。为了避免API密钥意外通过公共GIT仓库公开，您需要首先指定它。您有两种方法可以这样做

使用PHP常量

define('REPORTING_CLOUD_API_KEY', 'your-api-key');

使用环境变量（例如在.bashrc中）

export REPORTING_CLOUD_API_KEY='your-api-key'

注意，这些说明仅适用于示例脚本和phpunit测试。当您在应用程序中使用ReportingCloud时，请在构造函数中设置API密钥或使用setApiKey($apiKey)方法。例如，请参阅/demo/instantiation.php。

入门指南

ReportingCloud PHP 快速入门教程是您在应用程序中使用ReportingCloud PHP SDK的起点。

此外，ReportingCloud PHP SDK附带了一系列示例应用程序（请参阅目录/demo）。这些示例应用程序经过良好注释，旨在展示ReportingCloud的所有部分。

获取支持

ReportingCloud PHP SDK由ReportingCloud Web API制造商Text Control GmbH编写并支持。

尽管我们尽了最大努力创建易于理解的文档、示例应用程序和单元测试，但我们明白有时您可能需要一些技术支持。

如果您对ReportingCloud或PHP SDK有任何疑问，我们愿意帮助您。

请参阅ReportingCloud 文档中的获取支持部分，了解更多关于您可用的支持渠道。