README

Sylius Sales Reports

A simple plugin to have sales reports in Sylius

Compatibility

Sylius Version	PHP Version
1.12	8.1 - 8.2 - 8.3
1.13	8.1 - 8.2 - 8.3
1.14	8.1 - 8.2 - 8.3

Installation

If you want to use our recipes, you can configure your composer.json by running:

composer config --no-plugins --json extra.symfony.endpoint '["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]'

composer require monsieurbiz/sylius-sales-reports-plugin

Change your config/bundles.php file to add the line for the plugin :

<?php

return [
    //..
    MonsieurBiz\SyliusSalesReportsPlugin\MonsieurBizSyliusSalesReportsPlugin::class => ['all' => true],
];

Finally import the routes in config/routes/monsieurbiz_sylius_sales_reports_plugin.yaml :

monsieurbiz_sales_reports_plugin:
    resource: "@MonsieurBizSyliusSalesReportsPlugin/Resources/config/routing.yaml"

Reports

All reports columns are sortable by clicking on it.

If you want to change order or payments states used in the reports, you can configure it in the config/packages/monsieurbiz_sylius_sales_reports_plugin.yaml file:

parameters:
    monsieurbiz.sales_reports.order_states:
        - …
    monsieurbiz.sales_reports.payment_states:
        - …

(FYI, is it possible to use !php/const to use constants in the config file)

Global sales report

Average sales report

Product report

Product variant report

Option report

Option value report

Add your custom reports !

An event is available to add your custom reports, see CustomReportEvent class in the plugin.

Contributing

You can open an issue or a Pull Request if you want! 😘
Thank you!

monsieurbiz / sylius-sales-reports-plugin

Maintainers

Details