3brs / sylius-order-comments-plugin
Order comments plugin for Sylius
Package info
github.com/3BRS/sylius-order-comments-plugin
Language:JavaScript
Type:sylius-plugin
pkg:composer/3brs/sylius-order-comments-plugin
Requires
- php: >=8.2
- sylius/sylius: ^2.0
Requires (Dev)
- behat/behat: ^3.22
- behat/mink: ^1.11
- friends-of-behat/mink-browserkit-driver: ^1.6
- friends-of-behat/mink-debug-extension: ^2.1
- friends-of-behat/mink-extension: ^2.7
- friends-of-behat/page-object-extension: ^0.3
- friends-of-behat/suite-settings-extension: ^1.1
- friends-of-behat/symfony-extension: ^2.5
- friends-of-behat/variadic-extension: ^1.5
- nyholm/psr7: ^1.8
- php-http/discovery: ^1.20
- phpstan/phpstan: ^1.10
- phpstan/phpstan-doctrine: ^1.3
- phpstan/phpstan-symfony: ^1.3
- phpstan/phpstan-webmozart-assert: ^1.2
- phpunit/phpunit: ^10.0|^11.0
- polishsymfonycommunity/symfony-mocker-container: ^1.0.8
- symfony/browser-kit: ^6.4|^7.4
- symfony/debug-bundle: ^6.4|^7.4
- symfony/doctrine-bridge: ^6.4|^7.4
- symfony/doctrine-messenger: ^6.4|^7.4
- symfony/dotenv: ^6.4|^7.4
- symfony/form: ^6.4|^7.4
- symfony/framework-bundle: ^6.4|^7.4
- symfony/http-foundation: ^6.4|^7.4
- symfony/http-kernel: ^6.4|^7.4
- symfony/intl: ^6.4|^7.4
- symfony/mailer: ^6.4|^7.4
- symfony/maker-bundle: ^1.60
- symfony/messenger: ^6.4|^7.4
- symfony/property-access: ^6.4|^7.4
- symfony/property-info: ^6.4|^7.4
- symfony/security-bundle: ^6.4|^7.4
- symfony/web-profiler-bundle: ^6.4|^7.4
- symfony/webpack-encore-bundle: ^2.0
Conflicts
- api-platform/core: <2.7.13
- api-platform/json-schema: <4.2.0
- api-platform/metadata: <4.2.0
- api-platform/state: <4.2.0
- api-platform/symfony: <4.1.0
- babdev/pagerfanta-bundle: <3.6.1
- doctrine/collections: <1.7.0
- doctrine/data-fixtures: <1.7.0
- doctrine/dbal: <2.13.3
- doctrine/doctrine-bundle: <2.13.1
- doctrine/doctrine-migrations-bundle: <3.4.0
- doctrine/orm: <2.20.10
- friendsofsymfony/rest-bundle: <3.1.0
- jms/serializer-bundle: <4.2.0
- knplabs/knp-menu: <3.3.0
- knplabs/knp-menu-bundle: <3.4.1
- lexik/jwt-authentication-bundle: <2.12
- masterminds/html5: <2.7.5
- payum/core: <1.7.3
- phpstan/phpstan-doctrine: <1.3.60
- polishsymfonycommunity/symfony-mocker-container: <1.0.6
- sylius/resource-bundle: <1.14.1
- sylius/sylius: <2.0.17
- symfony/css-selector: <4.4.24
- symfony/doctrine-bridge: <6.4.5
- symfony/error-handler: >=8.0
- 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|>=6.4.0 <6.4.10
- symfony/mime: <5.4.0
- symfony/var-exporter: >=8.0
- symfony/web-link: <5.3.0
- twig/twig: <2.14.7
- webmozart/assert: <1.11.0
- willdurand/negotiation: <3.0
This package is auto-updated.
Last update: 2026-04-26 09:27:13 UTC
README
Create notes and send emails from the Sylius admin order detail page.
Features
- Create notes on order details
- Send personalized email to the addressee of the order
Requirements
| Package | Version |
|---|---|
| PHP | >=8.2 |
| Sylius | ^2.0 |
This branch (
2.2) supports Sylius 2.0, 2.1, and 2.2 on PHP 8.2/8.3. For Sylius 1.12–1.14, use branch1.14. For Sylius 1.10–1.11, use branch1.11. For Sylius 1.7–1.9, use branch1.9.
Installation
-
Run
composer require 3brs/sylius-order-comments-plugin. -
Add plugin class to your
config/bundles.php:return [ // ... ThreeBRS\OrderCommentsPlugin\ThreeBRSOrderCommentsPlugin::class => ['all' => true], ];
-
Import plugin config in
config/packages/_sylius.yaml:imports: # ... - { resource: "@ThreeBRSOrderCommentsPlugin/config/config.yml" }
-
Add routing to
config/routes/sylius_admin.yaml:threebrs_order_comments_plugin: resource: "@ThreeBRSOrderCommentsPlugin/config/routing.yml" prefix: /admin
-
Create and run doctrine database migrations. If you are upgrading from the
mangoweb-sylius/sylius-order-comments-pluginpackage, generate a migration that renames the tablemangoweb_order_messagetothreebrs_order_message.
The order comments form and message list are automatically added to the admin order show page via Twig Hooks. No template overrides needed.
Usage
- Comment can be written from the order detail page.
- If "Send to customer" is checked, an email is sent to the customer's email address.
Development
make run # Start Docker, install deps, build assets, set up DB make tests # Run PHPStan, PHPUnit, Behat make fixtures # Reset DB and load sample data make bash # Enter PHP container
License
This library is under the MIT license.