Show/Hide icon in datagrid

I have defined a datagrid for activity items. The activity can have the status open or closed. If the activity status is open than 2 icons (view, edit) should be shown, but if the status is closed than only the view icon should be shown. Closed activity can not be edited.

How can I implement this requirement?

pseudo code:

YAML

actions: update: type: navigate icon: edit link: update_link show: record.get('itemstatus') == 1 view: type: navigate icon: eye-open link: view_link

1 2 3 4 5 6 7 8 9 10

actions:             update:                 type:          navigate                 icon:          edit                 link:          update_link                 show:          record.get('itemstatus') == 1             view:                 type:          navigate                 icon:          eye-open                 link:          view_link

Thanks for helping

Topic

[Yevhen ShyshkinParticipant]

Hello, mike_m.

You have to use action configuration (or action permission provider) – this way you can enable/disable actions on a row level. See this example and this code.

[mike_mParticipant]

Thanks for helping me out. It works perfectly.

[adriwan_kenobyParticipant]

Hi @Yevhen Shyshkin,

I use this in a project.
It works fine for one action but I use the same logic for another and it doesn’t works. I have a weird twig runtime error “type must be defined” instead… Type of what ? The action, I thought it was defined…

YAML

#actions.yml parameters: sinabs_monitoring.extension.action.type.custom.class: Sinabs\MonitoringBundle\Extension\Action\Actions\CustomAction services: sinabs_monitoring.extension.action.type.custom: class: %sinabs_monitoring.extension.action.type.custom.class% scope: prototype tags: - { name: oro_datagrid.extension.action.type, type: custom } #datagrid.yml activate_link: type: url route: monitoring_api_activate_monitor params: - id activate: type: custom acl_resource: monitoring.monitor_update label: activate_monitor icon: ok confirmation: true link: activate_link deactivate: type: custom acl_resource: monitoring.monitor_update label: deactivate_monitor icon: remove confirmation: true link: activate_link #action_configuration: [ @sinabs_monitoring.datagrid.action_permission_provider, getActivateActionPermissions ] #requirejs.yml config: paths: 'oro/datagrid/action/custom-action': 'bundles/sinabsmonitoring/js/datagrid/action/custom-action.js'

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

#actions.yml parameters:     sinabs_monitoring.extension.action.type.custom.class: Sinabs\MonitoringBundle\Extension\Action\Actions\CustomAction   services:     sinabs_monitoring.extension.action.type.custom:         class: %sinabs_monitoring.extension.action.type.custom.class%         scope: prototype         tags:             - { name: oro_datagrid.extension.action.type, type: custom }   #datagrid.yml activate_link:                 type: url                 route: monitoring_api_activate_monitor                 params:                     - id   activate:                 type: custom                                 acl_resource: monitoring.monitor_update                 label: activate_monitor                 icon: ok                 confirmation: true                 link: activate_link             deactivate:                 type: custom                                 acl_resource: monitoring.monitor_update                 label: deactivate_monitor                 icon: remove                 confirmation: true                 link: activate_link                 #action_configuration: [ @sinabs_monitoring.datagrid.action_permission_provider, getActivateActionPermissions ]   #requirejs.yml config:     paths:         'oro/datagrid/action/custom-action': 'bundles/sinabsmonitoring/js/datagrid/action/custom-action.js'

JavaScript

/*global define*/ define([ './model-action' ], function (ModelAction) { 'use strict'; var CustomAction; /** * Ajax action, triggers REST AJAX request * * @export oro/datagrid/action/custom-action * @class oro.datagrid.action.CustomAction * @extends oro.datagrid.action.ModelAction */ CustomAction = ModelAction.extend({ defaultMessages: { confirm_title: 'Execution Confirmation', confirm_content: 'Are you sure you want to do this?', confirm_ok: 'Yes, do it', confirm_cancel: 'Cancel', success: 'Action performed.', error: 'Action is not performed.', empty_selection: 'Please, select item to perform action.' } }); return CustomAction; });

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

/*global define*/ define([     './model-action' ], function (ModelAction) {     'use strict';     var CustomAction;     /**      * Ajax action, triggers REST AJAX request      *      * @export  oro/datagrid/action/custom-action      * @class   oro.datagrid.action.CustomAction      * @extends oro.datagrid.action.ModelAction      */     CustomAction = ModelAction.extend({         defaultMessages: {             confirm_title: 'Execution Confirmation',             confirm_content: 'Are you sure you want to do this?',             confirm_ok: 'Yes, do it',             confirm_cancel: 'Cancel',             success: 'Action performed.',             error: 'Action is not performed.',             empty_selection: 'Please, select item to perform action.'         }     });     return CustomAction; });

PHP

<?php namespace Sinabs\MonitoringBundle\Extension\Action\Actions; use Oro\Bundle\DataGridBundle\Extension\Action\Actions\AjaxAction; class CustomAction extends AjaxAction { public function getOptions() { $options = parent::getOptions(); $options['frontend_type'] = 'custom'; if (empty($options['frontend_handle'])) { $options['frontend_handle'] = 'custom'; } return $options; } }

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

<?php   namespace Sinabs\MonitoringBundle\Extension\Action\Actions;   use Oro\Bundle\DataGridBundle\Extension\Action\Actions\AjaxAction;   class CustomAction extends AjaxAction {           public function getOptions() {         $options = parent::getOptions();         $options['frontend_type'] = 'custom';         if (empty($options['frontend_handle'])) {             $options['frontend_handle'] = 'custom';         }         return $options;     }   }

PHP

<?php namespace Sinabs\MonitoringBundle\Datagrid; use Oro\Bundle\DataGridBundle\Datasource\ResultRecordInterface; class ActionPermissionProvider { /** * This method is for another action which works without any problem * * @param ResultRecordInterface $record * @return array */ public function getEndAlertePermissions(ResultRecordInterface $record) { $isActive = $record->getValue('end'); return array( 'end_alerte' => is_null($isActive), 'view' => true, ); } /** * @param ResultRecordInterface $record * @return array */ public function getActivateActionPermissions(ResultRecordInterface $record) { $isActive = $record->getValue('active'); return array( 'activate' => !$isActive, 'deactivate' => $isActive, 'view' => 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 Sinabs\MonitoringBundle\Datagrid;   use Oro\Bundle\DataGridBundle\Datasource\ResultRecordInterface;   class ActionPermissionProvider {       /**      * This method is for another action which works without any problem      *      * @param ResultRecordInterface $record      * @return array      */     public function getEndAlertePermissions(ResultRecordInterface $record) {         $isActive = $record->getValue('end');             return array(             'end_alerte' => is_null($isActive),             'view' => true,         );     }       /**      * @param ResultRecordInterface $record      * @return array      */     public function getActivateActionPermissions(ResultRecordInterface $record) {         $isActive = $record->getValue('active');                 return array(             'activate' => !$isActive,             'deactivate' => $isActive,             'view' => true,         );     } }

The problem maybe is that I use same link for both action. I just want to toggle the state (a bool) of my entity ans display different icon for the action depend on this state.

[Yevhen ShyshkinParticipant]

Hello.

Please, see how it was done for processes or workflows grid – here is grid configuration and permission provider.

[adriwan_kenobyParticipant]

Hello,

I have already seen this example and I have a weird excpetion “type must be defined”. My use case isn’t exactly like this example because I have only one methode activateAction which toggle the state of my entity.

Look at the previous code. I have made like in your example…

I’am not sure but I suppose that the problem happen because I put this action in a RestController and not in FOSRestController. It maybe annotations which are not correctly defined.

Thanks for your help.

PHP

/** * @Get( * "/monitor/activate/{id}", * requirements={"version"="latest|v1", "id"="\d+"}, * defaults={"version"="latest", "_format"="json"} * ) * * @ApiDoc(description="Activate monitor", resource=true) * @AclAncestor("monitoring.monitor_update") * * @param $id * * @return Response */ public function activateAction($id) { $em = $this->get('doctrine.orm.entity_manager'); $monitor = $em->getRepository('SinabsMonitoringBundle:Monitor') ->getMonitorById($id); ($monitor->isActive()) ? $monitor->setActive(false) : $monitor->setActive(true); $em->flush(); return $this->handleView( $this->view( array( 'successful' => true, ), Codes::HTTP_OK ) ); }

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

/**      * @Get(      *      "/monitor/activate/{id}",      *      requirements={"version"="latest|v1", "id"="\d+"},      *      defaults={"version"="latest", "_format"="json"}      * )      *        * @ApiDoc(description="Activate monitor", resource=true)      * @AclAncestor("monitoring.monitor_update")      *      * @param $id      *      * @return Response      */     public function activateAction($id) {                  $em = $this->get('doctrine.orm.entity_manager');         $monitor = $em->getRepository('SinabsMonitoringBundle:Monitor')                 ->getMonitorById($id);         ($monitor->isActive()) ? $monitor->setActive(false) : $monitor->setActive(true);         $em->flush();           return $this->handleView(                         $this->view(                                 array(                             'successful' => true,                                 ), Codes::HTTP_OK                         )         );     }

[Yevhen ShyshkinParticipant]

I think you are seeing this exception – it is triggered if action configuration doesn’t include action type. Please, check content of the configuration that triggers this exception – it might give you some clues.

[adriwan_kenobyParticipant]

Hi,

Sorry but I don’t really understand how to check the configuration.
I thought the action type was define in datagrid.yml. Morevover it work fine for another action that I have define, then I don’t understand why this not work for this one.

[Yevhen ShyshkinParticipant]

There are a lot of things that might trigger this exception – e.g. incorrect file formatting, other grid with invalid configuration at the same page, some listener that modifies your config etc. So, i’m asking you to debug this case and check what configuration really triggers this error.

[prganvaniParticipant]

How to Remove GridSetting button from datagrid view?

[Author]

Replies