Datagrid Choice Filter Contains/With Wildcard

Hi there.

I’m trying to set up a datagrid choice filter for one of my columns, I’ve had no issues doing this in the past, but what I want to do differently this time is not match the string exactly, but match with a wildcard. I have the following filter:

YAML

filters: status: type: choice data_name: o.status options: field_options: multiple: true choices: Shopping: Shopping 'Finished.Completed': Completed 'Finished.Failed': Failed

1 2 3 4 5 6 7 8 9 10 11

filters:                 status:                     type: choice                     data_name: o.status                     options:                         field_options:                             multiple: true                             choices:                                 Shopping: Shopping                                 'Finished.Completed': Completed                                 'Finished.Failed': Failed

Which works fine for any status of ‘Finished.Completed’ or ‘Finished.Failed’ as these can match my status exactly. The issue comes with the ‘Shopping’ status, which can be ‘Shopping.Ongoing’ or ‘Shopping.Checkout’. Basically I want to match anything that starts with ‘Shopping’.

I’ve tried various things but the documentation is really lacking for the choice filters. Any tips on how to achieve this? Do I need to write a custom filter?

Thanks,
Simon

Topic

[Mike KudelyaParticipant]

Hi,

Yes, you can create new custom filter, for example (If you didn’t create our custom bundle, create it and extend from FilterBundle):

Create custom Custom/Bundle/FilterBundle/Filter/SelectLikeFilter.php:

PHP

<?php namespace Custom\Bundle\FilterBundle\Filter; use Oro\Bundle\FilterBundle\Datasource\FilterDatasourceAdapterInterface; use Oro\Bundle\FilterBundle\Filter\ChoiceFilter; class SelectLikeFilter extends ChoiceFilter { /** * {@inheritdoc} */ public function apply(FilterDatasourceAdapterInterface $ds, $data) { $data = $this->parseData($data); if (!$data) { return false; } $values = $data['value']; $parameterName = $ds->generateParameterName($this->getName()); $exprOrX = $ds->getQueryBuilder()->expr()->orX(); foreach ($values as $value) { $uniqueParameter = $parameterName.md5($value); $exprOrX->add( $ds->expr()->like($this->get(FilterUtility::DATA_NAME_KEY), $uniqueParameter, true) ); $ds->setParameter($uniqueParameter, $value); } $this->applyFilterToClause( $ds, $exprOrX ); return true; } }

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

<?php   namespace Custom\Bundle\FilterBundle\Filter;   use Oro\Bundle\FilterBundle\Datasource\FilterDatasourceAdapterInterface; use Oro\Bundle\FilterBundle\Filter\ChoiceFilter;   class SelectLikeFilter extends ChoiceFilter {     /**      * {@inheritdoc}      */     public function apply(FilterDatasourceAdapterInterface $ds, $data)     {         $data = $this->parseData($data);         if (!$data) {             return false;         }         $values = $data['value'];         $parameterName = $ds->generateParameterName($this->getName());         $exprOrX = $ds->getQueryBuilder()->expr()->orX();         foreach ($values as $value) {             $uniqueParameter = $parameterName.md5($value);             $exprOrX->add(                 $ds->expr()->like($this->get(FilterUtility::DATA_NAME_KEY), $uniqueParameter, true)             );             $ds->setParameter($uniqueParameter, $value);         }         $this->applyFilterToClause(             $ds,             $exprOrX         );         return true;     } }

Register it in Custom/Bundle/FilterBundle/Resources/config/services.yml:

PHP

parameters: custom_filter.select_like_filter.class: Custom\Bundle\FilterBundle\Filter\SelectLikeFilter services: custom_filter.select_like_filter: class: %custom_filter.select_like_filter.class% arguments: - '@form.factory' - '@oro_filter.filter_utility' tags: - { name: oro_filter.extension.orm_filter.filter, type: select-like }

1 2 3 4 5 6 7 8 9 10 11 12

parameters:     custom_filter.select_like_filter.class:          Custom\Bundle\FilterBundle\Filter\SelectLikeFilter   services:       custom_filter.select_like_filter:         class: %custom_filter.select_like_filter.class%         arguments:             - '@form.factory'             - '@oro_filter.filter_utility'         tags:             - { name: oro_filter.extension.orm_filter.filter, type: select-like }

Create js file Custom/Bundle/FilterBundle/Resources/public/js/filter/select-like-filter.js:

JavaScript

define([ './select-filter' ], function(SelectFilter) { 'use strict'; var SelectLikeFilter; SelectLikeFilter = SelectFilter.extend({ /** * Initialize. * * @param {Object} options */ initialize: function(options) { SelectLikeFilter.__super__.initialize.apply(this, arguments); } }); return SelectLikeFilter; });

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

define([     './select-filter' ], function(SelectFilter) {     'use strict';       var SelectLikeFilter;       SelectLikeFilter = SelectFilter.extend({           /**          * Initialize.          *          * @param {Object} options          */         initialize: function(options) {             SelectLikeFilter.__super__.initialize.apply(this, arguments);         }     });       return SelectLikeFilter; });

Register js file in Custom/Bundle/FilterBundle/Resources/config/requirejs.yml:

YAML

paths: 'oro/filter/select-like-filter': 'bundles/orofilter/js/filter/select-like-filter.js'

1 2	paths:          'oro/filter/select-like-filter': 'bundles/orofilter/js/filter/select-like-filter.js'

Don’t forget run these commands:

Shell

app/console oro:assets:install --env=dev --symlink app/console assetic:dump --env=dev app/console oro:requirejs:build --env=dev

1 2 3

app/console oro:assets:install --env=dev --symlink app/console assetic:dump --env=dev app/console oro:requirejs:build --env=dev

Now you ready to change your filter type from choice to select-like and use “Shopping.%”: Shopping options

[archy_boldParticipant]

Brilliant! It works with a couple of modifications to SelectLikeFilter. Just with an extra use for FilterUtility and with wildcards round the $value when setting the query parameter. Thanks!

PHP

<?php namespace Custom\Bundle\OroCrmBundle\Filter; use Oro\Bundle\FilterBundle\Datasource\FilterDatasourceAdapterInterface; use Oro\Bundle\FilterBundle\Filter\ChoiceFilter; use Oro\Bundle\FilterBundle\Filter\FilterUtility; class SelectLikeFilter extends ChoiceFilter { /** * {@inheritdoc} */ public function apply(FilterDatasourceAdapterInterface $ds, $data) { $data = $this->parseData($data); if (!$data) { return false; } $values = $data['value']; $parameterName = $ds->generateParameterName($this->getName()); $exprOrX = $ds->getQueryBuilder()->expr()->orX(); foreach ($values as $value) { $uniqueParameter = $parameterName.md5($value); $exprOrX->add( $ds->expr()->like($this->get(FilterUtility::DATA_NAME_KEY), $uniqueParameter, true) ); $ds->setParameter($uniqueParameter, '%' . $value . '%'); } $this->applyFilterToClause( $ds, $exprOrX ); return true; } }

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 37

<?php namespace Custom\Bundle\OroCrmBundle\Filter; use Oro\Bundle\FilterBundle\Datasource\FilterDatasourceAdapterInterface; use Oro\Bundle\FilterBundle\Filter\ChoiceFilter; use Oro\Bundle\FilterBundle\Filter\FilterUtility; class SelectLikeFilter extends ChoiceFilter {     /**      * {@inheritdoc}      */     public function apply(FilterDatasourceAdapterInterface $ds, $data)     {         $data = $this->parseData($data);         if (!$data) {             return false;         }           $values = $data['value'];         $parameterName = $ds->generateParameterName($this->getName());         $exprOrX = $ds->getQueryBuilder()->expr()->orX();         foreach ($values as $value) {             $uniqueParameter = $parameterName.md5($value);             $exprOrX->add(                 $ds->expr()->like($this->get(FilterUtility::DATA_NAME_KEY), $uniqueParameter, true)             );             $ds->setParameter($uniqueParameter, '%' . $value . '%');         }         $this->applyFilterToClause(             $ds,             $exprOrX         );         return true;     } }

[Author]

Replies