thelia / easy-order-manager-module
EasyOrderManager module for Thelia
Installs: 648
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 8
Forks: 5
Open Issues: 0
Language:HTML
Type:thelia-module
Requires
- thelia/installer: ~1.1
README
Add a short description here. You can also add a screenshot if needed.
Installation
Manually
- Copy the module into
<thelia_root>/local/modules/
directory and be sure that the name of the module is EasyOrderManager. - Activate it in your thelia administration panel
Composer
Add it in your main thelia composer.json file
composer require your-vendor/easy-order-manager-module
Usage
Once activated, you will see a new menu link in Thelia's Back Office. This new page allows you to easly manage all orders thanks to filters and search bars. This module uses Datables.
Events
You can use 2 events to add filters to this module :
BeforeFilterEvent::ORDER_MANAGER_BEFORE_FILTER
TemplateFieldEvent::ORDER_MANAGER_TEMPLATE_FIELD
In BeforeFilterEvent you have access to the order query and request.
In TemplateFieldEvent you can use the function addTemplateField(fieldName, templateName)
to add a template with your new filter in it. You just need to add js-filter-element
class to your filter input.
You can use one event to add or remove column to this module :
TemplateColumnDefinitionEvent::ORDER_MANAGER_TEMPLATE_COLUMN_DEFINITION
In TemplateColumnDefinitionEvent you can use the function addColumnDefinition(template, index)
to add a new column to the dataTable.
//Example : <?php //*** class EasyOrderManagerListener implements EventSubscriberInterface { public function addFieldsToTemplate( TemplateFieldEvent $event) { $event->addTemplateField('item_to_filter','item_to_filter_template_name.html'); } public function addFilterOnQuery( BeforeFilterEvent $event) { $filters =$event->getRequest()->get('filter'); $search = $event->getQuery(); if ("" !== $filters['item_to_filter']) { //update $search to filter with the data in $filters['item_to_filter'] } } public function updateColumnDefinition( TemplateColumnDefinitionEvent $event) { $event->removeColumnDefinition('invoice_date'); $event->addColumnDefinition([ 'name' => 'id_column', 'targets' => 6, //index of column 'title' => 'title_column', 'orderable' => false, // /!\ orderable is not manageable for the moment always set false 'className' => "text-center",// class applied to the column 'render' => "defaultRender", // name of the js function when render data 'parseOrderData'=> function(Order $order){ //return the data wich will be used in the render function } ],6); // /!\ targets and the index param must be the same. } public static function getSubscribedEvents() { return [ BeforeFilterEvent::ORDER_MANAGER_BEFORE_FILTER => ['addFilterOnQuery'], TemplateFieldEvent::ORDER_MANAGER_TEMPLATE_FIELD => ['addFieldsToTemplate'], TemplateColumnDefinitionEvent::ORDER_MANAGER_TEMPLATE_COLUMN_DEFINITION => ['updateColumnDefinition'], ]; } //... }
You can use this function to render the data in JS :