Get specific workflow in datagrid

Hello,

I’m using Oro 2.6
With 1.x versions of OroPlatform I was able to create columns for workflow steps in my datagrids like this :

YAML

orderitem-achats-grid: extended_entity_name: Oro\Bundle\MagentoBundle\Entity\OrderItem acl_resource: oro_magento_order_view source: type: orm query: select: - oi.id - oi.sku - oi.name - oi.qty - oi.rowTotal - step.name as row_class_name from: - { table: Oro\Bundle\MagentoBundle\Entity\OrderItem , alias: oi } join: left: - { join: oi.order, alias: o } - { join: oi.workflowStep, alias: step } where: and: - step.name IN ('s_attente', 's_commande')

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

orderitem-achats-grid:         extended_entity_name: Oro\Bundle\MagentoBundle\Entity\OrderItem         acl_resource: oro_magento_order_view         source:             type: orm             query:                 select:                     - oi.id                     - oi.sku                     - oi.name                     - oi.qty                     - oi.rowTotal                     - step.name as row_class_name                   from:                     - { table: Oro\Bundle\MagentoBundle\Entity\OrderItem , alias: oi }                   join:                     left:                         - { join: oi.order, alias: o }                         - { join: oi.workflowStep, alias: step }                   where:                     and:                         - step.name IN ('s_attente', 's_commande')

Since the evolution of WorkflowBundle this code doesn’t work, workflowStep is not defined on the entity.

What is the equivalent in 2.6 version ?
How can I filter on a specific workflow / steps in my datagrid ?

Thank you !

Topic

[Andrey YatsenkoModerator]

Hi Nicolas,

In 2.6 instead of relation from workflow to an entity we have 2 columns at the “oro_workflow_item” table, it’s “entity_class” and “entity_id”.

At the core, we have the listener that can show workflow step buttons for the Datagrid on entities that have a workflow attached, but your case little bit more complex as Datagrid build for OrderItem, but workflow attached to Order entity.
Here is that listener I’m talking about
https://github.com/oroinc/platform/blob/2.6.14/src/Oro/Bundle/WorkflowBundle/Datagrid/WorkflowStepColumnListener.php

You can build your own Datagrid listener based on the above to attach workflow buttons to the OrderItem datagrid.

[nicolas.sinabsParticipant]

Hi Andrey,

Thank you for your response.

My need does not necessarily focus on the action buttons but on the filters I can apply to datagrids (where statement in my example)

For example I want to create a datagrid for open orders (orders with “custom_order_workflow” started), archived orders (orders with “custom_order_workflow” at step “closed”) …

[nicolas.sinabsParticipant]

Hi Andrey,

You were right, the WorkflowStepColumnListener class helped me to solve my problem.
I redefined the applyFilter method :

PHP

protected function applyFilter(DatagridInterface $datagrid, $filter, $repositoryMethod) { $parameters = $datagrid->getParameters(); $filters = $parameters->get('_filter', []); // @Sinabs begin $default = $datagrid->getConfig()->offsetGetByPath('[filters][default]', []); if(array_key_exists($filter, $default) && array_key_exists('value', $default[$filter])) { $filters[$filter] = $default[$filter]; } // @Sinabs end if (array_key_exists($filter, $filters) && array_key_exists('value', $filters[$filter])) { $rootEntity = $datagrid->getConfig()->getOrmQuery()->getRootEntity($this->entityClassResolver); $rootEntityAlias = $datagrid->getConfig()->getOrmQuery()->getRootAlias(); $items = $this->getWorkflowItemRepository() ->$repositoryMethod($rootEntity, (array)$filters[$filter]['value']); /** @var OrmDatasource $datasource */ $datasource = $datagrid->getDatasource(); $qb = $datasource->getQueryBuilder(); $param = $qb->getParameter('filteredWorkflowItemIds'); if ($param === null) { $qb->andWhere($qb->expr()->in($rootEntityAlias, ':filteredWorkflowItemIds')) ->setParameter('filteredWorkflowItemIds', $items); } else { $qb->setParameter('filteredWorkflowItemIds', array_intersect((array)$param->getValue(), $items)); } unset($filters[$filter]); $parameters->set('_filter', $filters); } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

protected function applyFilter(DatagridInterface $datagrid, $filter, $repositoryMethod)     {         $parameters = $datagrid->getParameters();         $filters = $parameters->get('_filter', []);                  // @Sinabs begin         $default = $datagrid->getConfig()->offsetGetByPath('[filters][default]', []);         if(array_key_exists($filter, $default) && array_key_exists('value', $default[$filter])) {             $filters[$filter] = $default[$filter];         }         // @Sinabs end                  if (array_key_exists($filter, $filters) && array_key_exists('value', $filters[$filter])) {             $rootEntity = $datagrid->getConfig()->getOrmQuery()->getRootEntity($this->entityClassResolver);             $rootEntityAlias = $datagrid->getConfig()->getOrmQuery()->getRootAlias();               $items = $this->getWorkflowItemRepository()                 ->$repositoryMethod($rootEntity, (array)$filters[$filter]['value']);               /** @var OrmDatasource $datasource */             $datasource = $datagrid->getDatasource();               $qb = $datasource->getQueryBuilder();             $param = $qb->getParameter('filteredWorkflowItemIds');               if ($param === null) {                 $qb->andWhere($qb->expr()->in($rootEntityAlias, ':filteredWorkflowItemIds'))                     ->setParameter('filteredWorkflowItemIds', $items);             } else {                 $qb->setParameter('filteredWorkflowItemIds', array_intersect((array)$param->getValue(), $items));             }               unset($filters[$filter]);             $parameters->set('_filter', $filters);         }     }

and now I can use the filters like this :

PHP

filters: columns: ... default: workflowStepLabelByWorkflow: { value: 'orderitem_stock' }

1 2 3 4 5 6

filters:             columns:                 ...               default:                 workflowStepLabelByWorkflow: { value: 'orderitem_stock' }

Thank you again for your help !

[Andrey YatsenkoModerator]

Thank you for sharing the solution with the community!

[Author]

Replies