Skip to content
This repository has been archived by the owner on Sep 10, 2023. It is now read-only.

Laminas Module (formerly Zend Framework 3 Module) for ReportingCloud Web API. Authored and supported by Text Control GmbH.

License

Notifications You must be signed in to change notification settings

TextControl/txtextcontrol-reportingcloud-php-laminas-module

Repository files navigation

Logo

Abandoned Package -- Migrate Now!

As of September 10, 2023, this package is no longer being maintained.

Please update to the new version at https://github.com/TextControl/textcontrol-laminas-reportingcloud.

⚠️ Be sure to review the CHANGELOG.md of the new package.

ReportingCloud Laminas Module

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

Install Using Composer

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

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

After installing, you need to copy the configuration file:

/vendor/textcontrol/txtextcontrol-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:

'TxTextControl\ReportingCloud',

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

return [
    'Laminas\Router',
    'Laminas\Validator',
    'TxTextControl\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 \TxTextControl\ReportingCloud\ReportingCloud instance

View Helper

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

$this->reportingCloud();    // returns a \TxTextControl\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.

About

Laminas Module (formerly Zend Framework 3 Module) for ReportingCloud Web API. Authored and supported by Text Control GmbH.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages