README

This is a fork for compatibility php5 + php7

ReportingCloud PHP Wrapper

This is the official PHP wrapper for ReportingCloud Web API. It is authored and supported by Text Control GmbH.

Learn more about ReportingCloud at:

• ReportingCloud web site

• ReportingCloud portal - sign up here

• ReportingCloud Web API documentation

• ReportingCloud PHP wrapper Packagist page

• ReportingCloud PHP wrapper GitHub page

• ReportingCloud PHP wrapper support

Minimum Requirements

The ReportingCloud PHP wrapper requires PHP 5.6 or newer. There are two technical reasons for this:

• All versions of PHP prior to PHP 5.6 have reached end-of-life and should thus not be used in a production environment.

• The dependencies zendframework/zend-filter and zendframework/zend-validator require PHP 5.6 or newer.

If your application is running in an older environment, it is highly advisable to update to a more current version of PHP.

If you are unable or unwilling to update your PHP installation, it is possible to use ReportingCloud by directly accessing the Web API without using this wrapper. In such cases, it is advisable to use the curl extension to make the API calls.

Install Using Composer

The recommended way to install the ReportingCloud PHP wrapper in your project is using Composer:

composer require textcontrol/txtextcontrol-reportingcloud:^1.0

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

You can then later update the ReportingCloud PHP wrapper using Composer:

composer update

and for best auto-loading performance consequently execute:

composer dump-autoload --optimize

API Key for Demos and Unit Tests

The ReportingCloud PHP wrapper ships with a number of sample applications (see directory /demo) and phpunit tests (see directory /test). The scripts in each of these directories require an API key for ReportingCloud in order to be executed. So that the API key is not made inadvertently publicly available via a public GIT repository, you will first need to specify it. There are two ways in which you can do this:

Using PHP Constants:

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

Using Environmental Variables (For Example in .bashrc)

export REPORTING_CLOUD_API_KEY='your-api-key'

Note, these instructions apply only to the demo scripts and phpunit tests. When you use ReportingCloud in your application, set the API key in your constructor or by using the setApiKey($apiKey) methods. For an example, see /demo/instantiation.php.

Getting Started

As mentioned above, the ReportingCloud PHP wrapper ships with a number of sample applications (see directory /demo). These samples applications, which are well commented, have been written to demonstrate all parts of ReportingCloud.

We are currently working on comprehensive documentation for the ReportingCloud PHP wrapper, which will be published in the /doc directory, as and when it becomes available. In the meantime, please review the Text Control Blog, which contains many articles about ReportingCloud.

Getting Support

The official PHP wrapper for ReportingCloud Web API is supported by Text Control GmbH. To start a conversation with the PHP people in the ReportingCloud Support Department, please create a ticket, selecting ReportingCloud from the department selection list.