PHP wrapper for ReportingCloud Web API. Authored and supported by Text Control GmbH.
PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
data
demo
doc
src
test
.gitattributes
.gitignore
.scrutinizer.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
composer.json
phpcs.xml
phpunit.xml.dist

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:

Minimum Requirements

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

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

Username and Password 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 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 demo scripts and phpunit tests. When you use ReportingCloud in your application, set credentials in your constructor, using the setApiKey($apiKey) or the setUsername($username) and setPassword($password) 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.