3brs/sylius-analytics-plugin

Analytics tracking plugin for Sylius front store and product views.

dev-main 2025-07-09 10:20 UTC

Requires

• php: ^8.2
• sylius/sylius: 2.0.*

Requires (Dev)

• behat/behat: ^v3.19.0
• dmore/behat-chrome-extension: ^1.4.0
• dmore/chrome-mink-driver: ^2.9.3
• doctrine/annotations: ^2.0.2
• friends-of-behat/mink: ^v1.11.0
• friends-of-behat/mink-browserkit-driver: ^v1.6.2
• friends-of-behat/mink-debug-extension: ^v2.1.0
• friends-of-behat/mink-extension: ^v2.7.5
• friends-of-behat/page-object-extension: ^v0.3.2
• friends-of-behat/suite-settings-extension: ^v1.1.0
• friends-of-behat/symfony-extension: v2.6.0
• friends-of-behat/variadic-extension: ^v1.6.0
• php-http/message-factory: ^1.1.0
• phpstan/phpstan: ^2.1.10
• phpstan/phpstan-doctrine: ^2.0.2
• phpstan/phpstan-strict-rules: ^2.0.4
• phpstan/phpstan-symfony: ^2.0.3
• phpstan/phpstan-webmozart-assert: ^2.0.0
• phpunit/phpunit: ^11.1 || ^12.0.10
• polishsymfonycommunity/symfony-mocker-container: ^v1.0.8
• rector/rector: ^2.0.10
• sylius-labs/coding-standard: ^v4.4.0
• sylius/sylius-rector: ^v3.0.0
• symfony/browser-kit: ^6.4|^7.1
• symfony/css-selector: ^6.4|^7.1
• symfony/debug-bundle: ^6.4|^7.1
• symfony/doctrine-bridge: ^6.4|^7.1
• symfony/dotenv: ^6.4|^7.1
• symfony/framework-bundle: ^6.4|^7.1
• symfony/http-foundation: ^6.4|^7.1
• symfony/http-kernel: ^6.4|^7.1
• symfony/intl: ^6.4|^7.1
• symfony/mime: ^6.4|^7.1
• symfony/web-link: ^6.4|^7.1
• symfony/web-profiler-bundle: ^6.4|^7.1
• symplify/easy-coding-standard: ^12.0

Conflicts

• api-platform/core: <2.7.13
• api-platform/symfony: <v4.1.0
• babdev/pagerfanta-bundle: <3.6.1
• doctrine/collections: <1.7.0
• doctrine/data-fixtures: <1.5.1
• doctrine/dbal: <2.13.3
• doctrine/doctrine-bundle: <2.8.0
• friendsofsymfony/rest-bundle: <3.1.0
• jms/serializer-bundle: <4.2.0
• knplabs/knp-menu: <3.3.0
• lexik/jwt-authentication-bundle: <2.12
• masterminds/html5: <2.7.5
• payum/core: <1.7.3
• polishsymfonycommunity/symfony-mocker-container: <1.0.6
• sylius/resource-bundle: <1.10.0
• sylius/sylius: <2.0.6
• symfony/css-selector: <4.4.24
• symfony/framework-bundle: >=5.4.0 <=5.4.20|>=6.0.0 <=6.0.16|>=6.1.0 <=6.1.8|>=6.2.0 <=6.2.2|6.2.8
• symfony/mime: <5.4.0
• symfony/web-link: <5.3.0
• symplify/easy-coding-standard: <10.2.0|12.5.10
• twig/twig: <2.14.7
• webmozart/assert: <1.11.0
• willdurand/negotiation: <3.0

MIT

• sylius
• sylius-plugin

README

Sylius Analytics Plugin

Features

• Asynchronously logs visits to all frontend pages (excluding admin)
• Tracks visitor data: channel, full URL, route name, customer, session ID, IP address, user agent, and timestamp
• Displays:
  • Most requested pages in the last X days (configurable)
  • Request counts on product detail pages
  • Full log of requests with filtering capabilities inside the admin panel
• Built on top of Symfony Messenger for asynchronous processing

Installation

1. Run composer require 3brs/sylius-analytics-plugin.

2. Register ThreeBRS\SyliusAnalyticsPlugin\ThreeBRSSyliusAnalyticsPlugin::class => ['all' => true], in your config/bundles.php.

3. Import the plugin's routing files in config/routes.yaml:

   threebrs_statistics_plugin_routing_file:
       resource: "@ThreeBRSSyliusAnalyticsPlugin/config/routes.yaml"
       prefix: '%sylius_admin.path_name%'

4. Messenger Transport Configuration

   This plugin uses Symfony Messenger to log requests.

   Default Behavior (Synchronous)

   • By default, the plugin uses synchronous processing via the sync:// DSN. This means that log messages are processed immediately, without requiring any queue or worker. This is ideal for development and testing environments.

   • To enable this mode, set the following in your .env:

   THREEBRS_MESSENGER_TRANSPORT_LOG_VISIT_DSN=sync://

   • For better performance in production or staging environments, you can configure the plugin to log requests asynchronously using a queue (e.g., Doctrine transport)

   THREEBRS_MESSENGER_TRANSPORT_LOG_VISIT_DSN=doctrine://default

   • After setting this, you must run the Messenger worker to process the queued log messages:

   bin/console messenger:consume log_visit -vv

   • Only use this mode if your project supports background workers and a transport like Doctrine, Redis, etc.

5. Configure how many past days are considered when calculating the “Most Visited Pages” in the admin dashboard by setting the following parameter:

   parameters:
       threebrs_analytics_plugin.request_log_days: 7 # Change as needed

6. Generate and run Doctrine migrations:

   bin/console doctrine:migrations:diff 
   bin/console doctrine:migrations:migrate

7. Optional: Enable UTF-8 support in routing for better slug handling (diacritics, etc.):

   # config/packages/routing.yaml
   framework:
       router:
           utf8: true

Usage

The plugin will automatically log requests on:

• Homepage
• Product detail pages
• Category pages
• Cart pages
• Other shop pages

You can view the statistics inside the admin panel under the Analytics section.
Log processing is handled via Symfony Messenger, either synchronously (by default) or asynchronously if a queue is configured.

Development

Usage

• Develop your plugin logic inside /src
• See bin/ for useful dev tools

Testing

After making changes, make sure tests and checks pass:

composer install
bin/phpstan.sh
bin/ecs.sh

License

This library is under the MIT license.

Credits

Developed by 3BRS