README

ReportingCloud PHP 封装

这是 ReportingCloud Web API 的官方 PHP 封装。由 Text Control GmbH 编写并支持。

了解更多关于 ReportingCloud 的信息

• ReportingCloud 网站

• ReportingCloud 门户 - 现在注册

• ReportingCloud Web API 文档

• ReportingCloud PHP 封装 Packagist 页面

• ReportingCloud PHP 封装 GitHub 页面

• ReportingCloud PHP 封装支持

最低要求

ReportingCloud PHP 封装需要 PHP 5.6 或更高版本。有两个技术原因

• PHP 5.6 之前的所有版本都已达到 生命周期的结束，因此不应在生产环境中使用。

• 依赖项 zendframework/zend-filter 和 zendframework/zend-validator 需要 PHP 5.6 或更高版本。

如果您的应用程序在旧环境中运行，强烈建议您升级到更新的 PHP 版本。

如果您无法或不愿意更新您的 PHP 安装，您可以直接通过访问 Web API 来使用 ReportingCloud，而无需使用此封装。在这种情况下，建议您使用 curl 扩展来调用 API。

使用 Composer 安装

在您的项目中安装 ReportingCloud PHP 封装的推荐方法是使用 Composer

composer require textcontrol/txtextcontrol-reportingcloud:^1.0

安装后，您需要需要 Composer 的自动加载器

require 'vendor/autoload.php';

然后您可以使用 Composer 更新 ReportingCloud PHP 封装

composer update

并且为了最佳自动加载性能，相应地执行

composer dump-autoload --optimize

演示和单元测试的 API 密钥

ReportingCloud PHP 封装附带了一些示例应用程序（请参阅目录 /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 时，请通过构造函数或使用 setApiKey($apiKey) 方法设置 API 密钥。有关示例，请参阅 /demo/instantiation.php。

入门指南

如上所述，ReportingCloud PHP 封装附带了一些示例应用程序（请参阅目录 /demo）。这些示例应用程序经过良好注释，旨在演示 ReportingCloud 的所有部分。

我们目前正在为ReportingCloud PHP包装器编写全面的技术文档，这些文档将在准备好后发布在/doc目录中。在此期间，请查阅Text Control 博客，其中包含许多关于ReportingCloud的文章。

获取支持

ReportingCloud Web API的官方PHP包装器由Text Control GmbH支持。若要与ReportingCloud支持部门的PHP团队开始对话，请通过创建工单，并在部门选择列表中选择ReportingCloud。