README

这是一个为了与php5 + php7兼容而创建的分支

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。