How to pass route paramters for the datagrid

Hi,
I’ve created a simple datagrid by following this article
Now I have a problem with datagrids.yml because the view and update needs a custom parameter for the route:
In the symfony-log I get the following error message

Shell

Getting grid data failed. Context: { "exception": "Exception(Symfony\\Component\\Routing\\Exception\\InvalidParameterException): Parameter \"block_name\" for route \"education.classroom.test_update\" must match \"[^/]++\" (\"\" given) to generate a corresponding URL." }

1	Getting grid data failed. Context: { "exception": "Exception(Symfony\\Component\\Routing\\Exception\\InvalidParameterException): Parameter \"block_name\" for route \"education.classroom.test_update\" must match \"[^/]++\" (\"\" given) to generate a corresponding URL." }

datagrids.yml:

YAML

tests-grid: source: acl_resource: education.classroom.test_index type: orm query: select: - t.id - t.name - t.average from: - { table: EducationBundle:Test, alias: t } where: and: - t.block = :blockId bind_parameters: - blockId columns: name: label: Test description: label: Beschreibung: author: label: Erstellt von: properties: id: ~ update_link: type: url route: education.classroom.test_update params: block_name: block_name id: id delete_link: type: url route: education_api_delete_test params: - id actions: update: type: navigate label: Update link: update_link icon: edit acl_resource: education.classroom.test_update delete: type: delete label: Delete link: delete_link icon: trash acl_resource: education.classroom.test_delete

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 38 39 40 41 42 43 44 45 46 47 48 49 50

tests-grid:             source:                 acl_resource: education.classroom.test_index                 type: orm                 query:                     select:                         - t.id                         - t.name                         - t.average                     from:                         - { table: EducationBundle:Test, alias: t }                     where:                         and:                         - t.block = :blockId                 bind_parameters:                     - blockId               columns:                 name:                     label: Test                 description:                     label: Beschreibung:                 author:                     label: Erstellt von:             properties:                 id: ~                 update_link:                     type: url                     route: education.classroom.test_update                     params:                         block_name: block_name                         id: id                 delete_link:                     type: url                     route: education_api_delete_test                     params:                         - id             actions:                 update:                     type:          navigate                     label:         Update                     link:          update_link                     icon:          edit                     acl_resource:  education.classroom.test_update                 delete:                     type:          delete                     label:         Delete                     link:          delete_link                     icon:          trash                     acl_resource:  education.classroom.test_delete

index.html.twig:

{% extends 'OroUIBundle:actions:index.html.twig' %} {% import 'OroUIBundle::macros.html.twig' as UI %} {% set pageTitle = 'Tests'|trans %} {% block navButtons %} {% if is_granted('education.classroom.test_create') %} <div class="btn-group"> {{ UI.addButton({ 'path': path('education.classroom.test_create', {'block_name': block.name}), 'entity_label': 'Test'|trans }) }} </div> {% endif %} {% endblock %} {% block content_datagrid %} {% if gridName is defined %} {% if gridScope is defined %} {% set gridName = oro_datagrid_build_fullname(gridName, gridScope) %} {% endif %} {% set params = {'blockName': block.name, 'blockId': block.id} %} {% set renderParams = { 'enableFullScreenLayout': true, 'enableViews': true, 'showViewsInNavbar': true, 'filtersStateElement': '.filters-state-view-container' } |merge(renderParams|default({})) %} {{ dataGrid.renderGrid(gridName, params, renderParams) }} <script type="text/javascript"> require(['orosync/js/content/grid-builder'], function (GridTagBuilder) { GridTagBuilder.allowTracking({{ gridName|json_encode|raw }}); }); </script> {% endif %} {% endblock content_datagrid %}

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

{% extends 'OroUIBundle:actions:index.html.twig' %} {% import 'OroUIBundle::macros.html.twig' as UI %}   {% set pageTitle = 'Tests'|trans %}   {% block navButtons %}     {% if is_granted('education.classroom.test_create') %}         <div class="btn-group">             {{ UI.addButton({                 'path': path('education.classroom.test_create', {'block_name': block.name}),                 'entity_label': 'Test'|trans             }) }}         </div>     {% endif %} {% endblock %} {% block content_datagrid %}     {% if gridName is defined %}         {% if gridScope is defined %}             {% set gridName = oro_datagrid_build_fullname(gridName, gridScope) %}         {% endif %}         {% set params = {'blockName': block.name, 'blockId': block.id} %}         {% set renderParams = {             'enableFullScreenLayout': true,             'enableViews': true,             'showViewsInNavbar': true,             'filtersStateElement': '.filters-state-view-container'         }             |merge(renderParams|default({})) %}         {{ dataGrid.renderGrid(gridName,  params, renderParams) }}         <script type="text/javascript">             require(['orosync/js/content/grid-builder'], function (GridTagBuilder) {                 GridTagBuilder.allowTracking({{ gridName|json_encode|raw }});             });         </script>     {% endif %} {% endblock content_datagrid %}

I’ve also tried to pass the parameters in a Event Listener but it throws the same error

TestGridListener.php:

PHP

<?php namespace XTAIN\EducationBundle\EventListener; use Oro\Bundle\DataGridBundle\Datagrid\Common\DatagridConfiguration; use Oro\Bundle\DataGridBundle\Datagrid\ParameterBag; use Oro\Bundle\DataGridBundle\Event\BuildBefore; class TestGridListener { /** * @param BuildBefore $event */ public function onBuildBefore(BuildBefore $event) { $datagrid = $event->getDatagrid(); $this->applyFilters($event->getConfig(), $datagrid->getParameters()); } /** * @param DatagridConfiguration $config * @param ParameterBag $parameters */ protected function applyFilters(DatagridConfiguration $config, ParameterBag $parameters) { $blockName = $parameters->get('blockName', []); $blockId = $parameters->get('blockId', []); $datagridParametersUp = $config->offsetGetByPath('[properties][update_link][params]', []); $datagridParametersUp['block_name'] = $blockName; $datagridParametersUp['blockId'] = $blockId; $config->offsetSetByPath('[properties][update_link][params]', $datagridParametersUp); } }

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

<?php   namespace XTAIN\EducationBundle\EventListener;   use Oro\Bundle\DataGridBundle\Datagrid\Common\DatagridConfiguration; use Oro\Bundle\DataGridBundle\Datagrid\ParameterBag; use Oro\Bundle\DataGridBundle\Event\BuildBefore;   class TestGridListener {     /**      * @param BuildBefore $event      */     public function onBuildBefore(BuildBefore $event)     {         $datagrid = $event->getDatagrid();         $this->applyFilters($event->getConfig(), $datagrid->getParameters());     }       /**      * @param DatagridConfiguration $config      * @param ParameterBag $parameters      */     protected function applyFilters(DatagridConfiguration $config, ParameterBag $parameters)     {         $blockName = $parameters->get('blockName', []);         $blockId = $parameters->get('blockId', []);         $datagridParametersUp = $config->offsetGetByPath('[properties][update_link][params]', []);         $datagridParametersUp['block_name'] = $blockName;         $datagridParametersUp['blockId'] = $blockId;         $config->offsetSetByPath('[properties][update_link][params]', $datagridParametersUp);     } }

Topic

[Andrey YatsenkoModerator]

Hi Alexander,

First of all you have some mess in variable names “blockId” in listener vs “id” in datagrid config for route, “block_name” in route parameter but “blockName” in template. It’s hard to read such variable names, do they lead for the same values and it’s a typo or they are for different purpose here?

For the listener to pass the “blockName” to the route from datagrid you can use “direct_params” instead of “params”, as “params” must contains mapping to grid record fields but not the values itself.

You can check how parameters are used in a code https://github.com/oroinc/platform/blob/2.6.1/src/Oro/Bundle/DataGridBundle/Extension/Formatter/Property/UrlProperty.php#L54

And example of a listener that set “direct_params” for the route
https://github.com/oroinc/platform/blob/2.6.1/src/Oro/Bundle/EmailBundle/EventListener/Datagrid/MailboxGridListener.php

Hope this helps.

[AlexanderParticipant]

Thanks a lot! Works perfectly. Question is closed.

[Author]

Replies