PHP wrapper for ReportingCloud Web API. Authored and supported by Text Control GmbH.
PHP Shell
Latest commit 38cbd69 Oct 27, 2016 @jonathanmaron jonathanmaron Updated documentation

README.md

Logo

ReportingCloud PHP Wrapper

Build Status Scrutinizer Code Quality Latest Stable Version composer.lock available

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

Learn more about ReportingCloud at:

Install using Composer

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

composer require textcontrol/txtextcontrol-reportingcloud

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

Username and password for demos and unittests

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 a username and password for ReportingCloud in order to be executed. So that your username and password are not made inadvertently publicly available via a public GIT repository, you will first need to specify them. There are two ways in which you can do this:

Using PHP constants:

define('REPORTING_CLOUD_USERNAME', 'your-username');
define('REPORTING_CLOUD_PASSWORD', 'your-password');

Using environmental variables (for example in .bashrc)

export REPORTING_CLOUD_USERNAME='your-username'
export REPORTING_CLOUD_PASSWORD='your-password'

Note, these instructions apply only to the sample applications and phpunit tests. When you use ReportingCloud in your application, set the username and password in your constructor or using the setUsername($username) and setPassword($password) methods. For an example of this case, 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 /docs directory, as and when it becomes available. In the meantime, please review the Text Control Blog , which contains many articles about ReportingCloud.