Download the PHP package monsieurbiz/sylius-order-history-plugin without Composer
On this page you can find all versions of the php package monsieurbiz/sylius-order-history-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download monsieurbiz/sylius-order-history-plugin
More information about monsieurbiz/sylius-order-history-plugin
Files in monsieurbiz/sylius-order-history-plugin
Package sylius-order-history-plugin
Short Description Add a timeline with all the order events on back-office.
License MIT
Informations about the package sylius-order-history-plugin
Order History for Sylius
This plugin saves order events and allows you to display them in the order history as a timeline. It is based on state machine events.
Installation
Install the plugin via composer:
For the installation without flex, follow these additional steps
Change your config/bundles.php
file to add this line for the plugin declaration:
Copy the plugin configuration files in your config
folder:
Doctrine migration
In order to create dedicated tables for the plugin, don't forget to execute doctrine migration commands:
Getting started
Show any order on the Sylius backend and click on the top right History
button.
How does it work?
This plugin is based on the state machine events. It uses the native Winzou state machine callback system to save named order events when they are triggered.
Callback dedicated notifier service / actions who add different details following context:
\MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryNotifier
is a basic notifier with no particular details except the given ones as parameters.\MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\OrderHistoryWithAddressesDataNotifier
is a notifier dedicated to address events. It adds the billing and shipping address data.\MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\ShipmentOrderHistoryNotifier
is a notifier dedicated to shipment events. It adds the shipment method name and the shipment state.\MonsieurBiz\SyliusOrderHistoryPlugin\Notifier\PaymentOrderHistoryNotifier
is a notifier dedicated to payment events. It adds the payment method name and the payment state.
How to
- Add more details on existing events
- Add custom event in code
- Add custom event in state machine
- Add custom type and label display in history timeline
Contributing
You can find a way to run the plugin without effort in the file DEVELOPMENT.md.
Then you can open an issue or a Pull Request if you want! 😘
Thank you!
License
This plugin is completely free and released under the MIT License.
All versions of sylius-order-history-plugin with dependencies
sylius/sylius Version >=1.9 <1.13
beberlei/doctrineextensions Version ^1.3