USAGE.md

ReportingCloud Laminas Module

Install Using Composer

Install the ReportingCloud Laminas module in your project is using Composer:

composer require textcontrol/textcontrol-reportingcloud-laminas-module:^3.0

After installing, you need to copy the configuration file:

/vendor/textcontrol/textcontrol-reportingcloud-laminas-module/config/reportingcloud.local.php.dist

to your Laminas application:

/config/autoload/reportingcloud.local.php

Note: The .dist prefix has been removed.

Then, add your ReportingCloud credentials to the configuration file:

return [
    'reportingcloud' => [
        'credentials' => [
            'api_key' => 'your-api-key'
        ],
    ],
];

Once you have done this, you are ready to enable the module in your application's module configuration file.

In the file /config/modules.config.php, add the line:

'TextControl\Laminas\ReportingCloud',

Your /config/modules.config.php file should look something like this:

return [
    'Laminas\Router',
    'Laminas\Validator',
    'TextControl\Laminas\ReportingCloud',
    'Application',
];

You are now ready to use Reporting Cloud in your Laminas application.

Usage in Laminas

The ReportingCloud Laminas module registers a Service in the Service Manager under the key ReportingCloud.

It is therefore available in Factories as follows:

use Interop\Container\ContainerInterface;
use Laminas\ServiceManager\Factory\FactoryInterface;

class Factory implements FactoryInterface
{
    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null)
    {
        $reportingCloud = $container->get('ReportingCloud');

        // instantiate and return your object here
        
    }
}

Controller Plugin

For easy access in Controllers, the following Controller plugin is available:

$this->reportingCloud();    // returns a \TextControl\ReportingCloud\ReportingCloud instance

View Helper

For easy access in Views, the following View helper is available:

$this->reportingCloud();    // returns a \TextControl\ReportingCloud\ReportingCloud instance

Migration from Zend Framework 3 to Laminas

Please refer to What Happened to the Zend Framework 3 Module for ReportingCloud Web API?, if you are migrating from Zend Framework 3 to Laminas.

Getting Support

The official Laminas module 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.