From d01b27c5892389456d1354660149442fd9d9e6c0 Mon Sep 17 00:00:00 2001 From: colymba Date: Sun, 1 Dec 2013 13:31:35 +0200 Subject: [PATCH] API bulk action front-end data are configurable Bulk action front-end behaviour and style can now be configured via array( 'isAjax' => true, 'icon' => 'accept', 'isDestructive' => false ) passed to addBulkAction() --- code/GridFieldBulkManager.php | 73 ++++++++++++++++++++++++------ javascript/GridFieldBulkManager.js | 70 ++++++++++++++-------------- templates/BulkManagerButtons.ss | 3 +- 3 files changed, 92 insertions(+), 54 deletions(-) diff --git a/code/GridFieldBulkManager.php b/code/GridFieldBulkManager.php index 6184b98..92d537d 100644 --- a/code/GridFieldBulkManager.php +++ b/code/GridFieldBulkManager.php @@ -41,15 +41,30 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr $this->config['actions'] = array( 'edit' => array( 'label' => _t('GridFieldBulkTools.EDIT_SELECT_LABEL', 'Edit'), - 'handler' => 'GridFieldBulkManager_Request' + 'handler' => 'GridFieldBulkManager_Request', + 'config' => array( + 'isAjax' => false, + 'icon' => 'pencil', + 'isDestructive' => false + ) ), 'unlink' => array( 'label' => _t('GridFieldBulkTools.UNLINK_SELECT_LABEL', 'UnLink'), - 'handler' => 'GridFieldBulkManager_Request' + 'handler' => 'GridFieldBulkManager_Request', + 'config' => array( + 'isAjax' => true, + 'icon' => 'chain--minus', + 'isDestructive' => false + ) ), 'delete' => array( 'label' => _t('GridFieldBulkTools.DELETE_SELECT_LABEL', 'Delete'), - 'handler' => 'GridFieldBulkManager_Request' + 'handler' => 'GridFieldBulkManager_Request', + 'config' => array( + 'isAjax' => true, + 'icon' => 'decline', + 'isDestructive' => true + ) ) ); } @@ -162,9 +177,10 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr * @param string $name Bulk action's name. Used by RequestHandler. * @param string $label Dropdown menu action's label. Default to ucfirst($name). * @param string $handler RequestHandler class name for this action. Default to 'GridFieldBulkAction'.ucfirst($name).'Handler' + * @param array $config Front-end configuration array( 'isAjax' => true, 'icon' => 'accept', 'isDestructive' => false ) * @return GridFieldBulkManager Current GridFieldBulkManager instance */ - function addBulkAction(string $name, $label = null, $handler = null) + function addBulkAction(string $name, $label = null, $handler = null, $config = null) { if ( array_key_exists($name, $this->config['actions']) ) { @@ -188,9 +204,22 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr user_error("Bulk action handler for $name not found: $handler", E_USER_ERROR); } + if ( $config && !is_array($config) ) + { + user_error("Bulk action front-end config should be an array of key => value pairs.", E_USER_ERROR); + } + else{ + $config = array( + 'isAjax' => true, + 'icon' => 'accept', + 'isDestructive' => false + ); + } + $this->config['actions'][$name] = array( - 'label' => $label, - 'handler' => $handler + 'label' => $label, + 'handler' => $handler, + 'config' => $config ); return $this; @@ -265,31 +294,45 @@ class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnPr } $actionsListSource = array(); + $actionsConfig = array(); + foreach ($this->config['actions'] as $action => $actionData) { - $actionsListSource[$action] = $actionData['label']; + $actionsListSource[$action] = $actionData['label']; + $actionsConfig[$action] = $actionData['config']; } + reset($this->config['actions']); + $firstAction = key($this->config['actions']); + $dropDownActionsList = DropdownField::create('bulkActionName', '') ->setSource( $actionsListSource ) ->setAttribute('class', 'bulkActionName no-change-track') ->setAttribute('id', ''); - $templateData = new ArrayData(array( + $templateData = array( 'Menu' => $dropDownActionsList->FieldHolder(), 'Button' => array( - 'Label' => _t('GridFieldBulkTools.ACTION_BTN_LABEL', 'Go'), - 'DataURL' => $gridField->Link('bulkaction') + 'Label' => _t('GridFieldBulkTools.ACTION_BTN_LABEL', 'Go'), + 'DataURL' => $gridField->Link('bulkaction'), + 'Icon' => $this->config['actions'][$firstAction]['config']['icon'], + 'DataConfig' => htmlspecialchars(json_encode($actionsConfig), ENT_QUOTES, 'UTF-8') ), 'Select' => array( 'Label' => _t('GridFieldBulkTools.SELECT_ALL_LABEL', 'Select all') - ) - )); - - $args = array('Colspan' => count($gridField->getColumns())-1); + ), + 'Colspan' => (count($gridField->getColumns()) - 1) + ); + + if ( !$this->config['actions'][$firstAction]['config']['isAjax'] ) + { + $templateData['Button']['href'] = $gridField->Link('bulkaction') . '/' . $firstAction; + } + + $templateData = new ArrayData($templateData); return array( - 'header' => $templateData->renderWith('BulkManagerButtons', $args) + 'header' => $templateData->renderWith('BulkManagerButtons') ); } diff --git a/javascript/GridFieldBulkManager.js b/javascript/GridFieldBulkManager.js index 7a3ad39..178f0dd 100644 --- a/javascript/GridFieldBulkManager.js +++ b/javascript/GridFieldBulkManager.js @@ -48,45 +48,41 @@ }, onunmatch: function(){ }, - onchange: function(e) { - var value, btn, icon; - value = $(this).val(); - btn = $(this).parents('.bulkManagerOptions').find('.doBulkActionButton'); - icon = $(this).parents('.bulkManagerOptions').find('.doBulkActionButton .ui-icon'); - - switch (value) { - case 'edit': - $(btn).removeClass('ss-ui-action-destructive'); - $(btn).attr('data-icon', 'pencil'); - $(icon).removeClass('btn-icon-decline btn-icon-pencil').addClass('btn-icon-pencil'); - - $(btn).attr('href', $(btn).data('url')+'/edit'); - break; - - case 'unlink': - $(btn).removeClass('ss-ui-action-destructive'); - $(btn).attr('data-icon', 'chain--minus'); - $(icon).removeClass('btn-icon-decline btn-icon-pencil').addClass('btn-icon-chain--minus'); - $(btn).removeAttr('href'); - break; - - case 'delete': - $(btn).addClass('ss-ui-action-destructive'); - $(btn).attr('data-icon', 'decline'); - $(icon).removeClass('btn-icon-decline btn-icon-pencil').addClass('btn-icon-decline'); - $(btn).removeAttr('href'); - break; + onchange: function(e) + { + var value = $(this).val(), + $parent = $(this).parents('.bulkManagerOptions'), + $btn = $parent.find('.doBulkActionButton'), + config = $btn.data('config'), + $icon = $parent.find('.doBulkActionButton .ui-icon') + ; + + if ( config[value]['isAjax'] ) + { + $btn.removeAttr('href'); + } + else{ + $btn.attr('href', $btn.data('url')+'/'+value); } - /* - $(icon).removeClass('btn-icon-decline btn-icon-pencil btn-icon-chain--minus') - $(btn).removeClass('ss-ui-action-destructive'); - $(btn).attr('data-icon', 'decline'); - $(btn).attr('data-icon', 'chain--minus'); - $(btn).attr('data-icon', 'pencil'); - $(btn).removeAttr('href'); - $(btn).attr('href', $(btn).data('url')+'/edit'); - */ + + $.each( config, function( configKey, configData ) + { + if ( configKey != value ) + { + $icon.removeClass('btn-icon-'+configData['icon']); + } + }); + $icon.addClass('btn-icon-'+config[value]['icon']); + + + if ( config[value]['isDestructive'] ) + { + $btn.addClass('ss-ui-action-destructive'); + } + else{ + $btn.removeClass('ss-ui-action-destructive'); + } } }); diff --git a/templates/BulkManagerButtons.ss b/templates/BulkManagerButtons.ss index 1040322..123f5f3 100644 --- a/templates/BulkManagerButtons.ss +++ b/templates/BulkManagerButtons.ss @@ -2,10 +2,9 @@ $Menu - + href="$Button.href"<% end_if %> data-url="$Button.DataURL" data-config="$Button.DataConfig" class="doBulkActionButton action ss-ui-button cms-panel-link" data-icon="$Button.Icon"> $Button.Label -