Description

This plugin add data reports to the Sylius administration interface. It's highly inspired on the old SyliusReportBundle and Report component using it's good architecture.

Now supporting Sylius 1.4+ and Symfony 4.

Premium features!

Do you want advanced features? Take a look at our Report Pro Plugin, an extended version of this one.

Architecture

Basically you have a DataFetcherInterface and RendererInterface interfaces. The first one defines how to fetch the Data according on a configuration provided. And the second one uses the Data returned by the fetcher and returns a rendered view.

Some DataFetchers and Renderers come with this plugin but you can create your own by implementing their interfaces.

Demo

You can see this plugin in action in our Sylius Demo application.

• Frontend: sylius-demo.odiseo.com.ar.
• Administration: sylius-demo.odiseo.com.ar/admin with odiseo: odiseo credentials. Next, you can enter to the reports page.

Installation

1. Run composer require odiseoteam/sylius-report-plugin

2. Enable the plugin in bundles.php but add it before SyliusResourceBundle like follows:

<?php

return [
    // ...
    Odiseo\SyliusReportPlugin\OdiseoSyliusReportPlugin::class => ['all' => true],
    Sylius\Bundle\ResourceBundle\SyliusResourceBundle::class => ['all' => true],
    // ...
];

3. Import the plugin configurations

imports:
    - { resource: "@OdiseoSyliusReportPlugin/Resources/config/config.yml" }

This plugin use DoctrineExtensions to create the different DataFetcher's queries. For example you will need to add the Doctrine DQL functions as follows if you are using Mysql:

doctrine:
    orm:
        # ...
        dql:
            datetime_functions:
                date: DoctrineExtensions\Query\Mysql\Date
                month: DoctrineExtensions\Query\Mysql\Month
                year: DoctrineExtensions\Query\Mysql\Year
            numeric_functions:
                round: DoctrineExtensions\Query\Mysql\Round

4. Add the admin routes

odiseo_sylius_report_plugin_admin:
    resource: "@OdiseoSyliusReportPlugin/Resources/config/routing/admin.yml"
    prefix: /admin

5. Finish the installation updating the database schema and installing assets

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate
php bin/console sylius:theme:assets:install --symlink

Test the plugin

You can follow the instructions to test this plugins in the proper documentation page: Test the plugin.

Credits

This plugin is maintained by Odiseo. Want us to help you with this plugin or any Sylius project? Contact us on team@odiseo.com.ar.