2012-08-11 00:19:13 +02:00
|
|
|
<?php
|
2017-01-25 13:27:11 +01:00
|
|
|
|
|
|
|
namespace Colymba\BulkManager;
|
|
|
|
|
2018-02-12 14:11:49 +01:00
|
|
|
use ReflectionClass;
|
2018-02-26 09:47:40 +01:00
|
|
|
use SilverStripe\Control\HTTPRequest;
|
|
|
|
use SilverStripe\Control\RequestHandler;
|
|
|
|
use SilverStripe\Core\Injector\Injectable;
|
2017-01-25 13:27:11 +01:00
|
|
|
use SilverStripe\Core\Injector\Injector;
|
|
|
|
use SilverStripe\Forms\CheckboxField;
|
|
|
|
use SilverStripe\Forms\DropdownField;
|
2018-02-26 09:47:40 +01:00
|
|
|
use SilverStripe\Forms\GridField\GridField;
|
2017-01-25 13:27:11 +01:00
|
|
|
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
|
2018-02-26 09:47:40 +01:00
|
|
|
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
|
2017-01-25 13:27:11 +01:00
|
|
|
use SilverStripe\Forms\GridField\GridField_URLHandler;
|
2018-02-26 09:47:40 +01:00
|
|
|
use SilverStripe\ORM\DataObject;
|
2017-01-25 13:27:11 +01:00
|
|
|
use SilverStripe\View\ArrayData;
|
|
|
|
use SilverStripe\View\Requirements;
|
2018-09-30 23:05:36 +02:00
|
|
|
use SilverStripe\Control\Controller;
|
2017-01-25 13:27:11 +01:00
|
|
|
|
2012-08-11 00:19:13 +02:00
|
|
|
/**
|
2015-12-15 13:08:57 +01:00
|
|
|
* GridField component for editing attached models in bulk.
|
2012-08-11 00:19:13 +02:00
|
|
|
*
|
|
|
|
* @author colymba
|
|
|
|
*/
|
2017-01-25 13:27:11 +01:00
|
|
|
class BulkManager implements GridField_HTMLProvider, GridField_ColumnProvider, GridField_URLHandler
|
2015-12-15 13:08:57 +01:00
|
|
|
{
|
2018-02-26 09:47:40 +01:00
|
|
|
use Injectable;
|
|
|
|
|
2015-12-15 13:08:57 +01:00
|
|
|
/**
|
|
|
|
* component configuration.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* 'editableFields' => fields editable on the Model
|
2018-02-12 14:11:49 +01:00
|
|
|
* 'actions' => maps of action URL and Handler Class
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $config = array(
|
2017-01-25 13:27:11 +01:00
|
|
|
'editableFields' => null,
|
|
|
|
'actions' => array(),
|
2015-12-15 13:08:57 +01:00
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
2018-02-26 09:47:40 +01:00
|
|
|
* BulkManager component constructor.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param array $editableFields List of editable fields
|
|
|
|
* @param bool $defaultActions Use default actions list. False to start fresh.
|
|
|
|
*/
|
2018-03-02 11:33:17 +01:00
|
|
|
public function __construct($editableFields = null, $defaultActions = true, $defaultVersionedActions = false)
|
2015-12-15 13:08:57 +01:00
|
|
|
{
|
|
|
|
if ($editableFields != null) {
|
|
|
|
$this->setConfig('editableFields', $editableFields);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($defaultActions) {
|
2018-02-26 09:47:40 +01:00
|
|
|
$this
|
|
|
|
->addBulkAction(BulkAction\EditHandler::class)
|
|
|
|
->addBulkAction(BulkAction\UnlinkHandler::class)
|
|
|
|
->addBulkAction(BulkAction\DeleteHandler::class);
|
2018-03-02 11:33:17 +01:00
|
|
|
} elseif ($defaultVersionedActions) {
|
|
|
|
$this
|
|
|
|
->addBulkAction(BulkAction\EditHandler::class)
|
|
|
|
->addBulkAction(BulkAction\UnlinkHandler::class)
|
|
|
|
->addBulkAction(BulkAction\ArchiveHandler::class)
|
|
|
|
->addBulkAction(BulkAction\UnPublishHandler::class)
|
|
|
|
->addBulkAction(BulkAction\PublishHandler::class);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* **********************************************************************
|
|
|
|
* Components settings and custom methodes
|
|
|
|
* */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the component configuration parameter.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param string $reference
|
|
|
|
* @param mixed $value
|
|
|
|
*/
|
|
|
|
public function setConfig($reference, $value)
|
|
|
|
{
|
|
|
|
if (!array_key_exists($reference, $this->config)) {
|
|
|
|
user_error("Unknown option reference: $reference", E_USER_ERROR);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($reference == 'actions') {
|
|
|
|
user_error('Bulk actions must be edited via addBulkAction() and removeBulkAction()', E_USER_ERROR);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (($reference == 'editableFields') && !is_array($value)) {
|
|
|
|
$value = array($value);
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->config[$reference] = $value;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns one $config parameter of the full $config.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param string $reference $congif parameter to return
|
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function getConfig($reference = false)
|
|
|
|
{
|
|
|
|
if ($reference) {
|
|
|
|
return $this->config[$reference];
|
|
|
|
} else {
|
|
|
|
return $this->config;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Lets you add custom bulk actions to the bulk manager interface.
|
2018-02-12 14:11:49 +01:00
|
|
|
* Exisiting handler will be replaced
|
2015-12-15 13:08:57 +01:00
|
|
|
*
|
2018-02-26 09:47:40 +01:00
|
|
|
* @param string $handlerClassName RequestHandler class name for this action.
|
2018-02-12 14:11:49 +01:00
|
|
|
* @param string $action Specific RequestHandler action to be called.
|
2015-12-15 13:08:57 +01:00
|
|
|
*
|
2018-02-26 09:47:40 +01:00
|
|
|
* @return $this Current BulkManager instance
|
2015-12-15 13:08:57 +01:00
|
|
|
*/
|
2018-02-26 09:47:40 +01:00
|
|
|
public function addBulkAction($handlerClassName, $action = null)
|
2015-12-15 13:08:57 +01:00
|
|
|
{
|
2018-02-26 09:47:40 +01:00
|
|
|
if (!class_exists($handlerClassName)) {
|
|
|
|
user_error("Bulk action handler not found: $handlerClassName", E_USER_ERROR);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
2018-02-26 09:47:40 +01:00
|
|
|
$handler = Injector::inst()->get($handlerClassName);
|
2018-02-12 14:11:49 +01:00
|
|
|
$urlSegment = $handler->config()->get('url_segment');
|
|
|
|
if (!$urlSegment)
|
|
|
|
{
|
2018-02-26 09:47:40 +01:00
|
|
|
$rc = new ReflectionClass($handlerClassName);
|
2018-02-12 14:11:49 +01:00
|
|
|
$urlSegment = $rc->getShortName();
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
2018-02-26 09:47:40 +01:00
|
|
|
$this->config['actions'][$urlSegment] = $handlerClassName;
|
2013-11-30 18:30:32 +01:00
|
|
|
|
2015-12-15 13:08:57 +01:00
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Removes a bulk actions from the bulk manager interface.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2018-02-26 09:47:40 +01:00
|
|
|
* @param string $handlerClassName RequestHandler class name of the action to remove.
|
2018-02-12 14:11:49 +01:00
|
|
|
* @param string $urlSegment URL segment of the action to remove.
|
2015-12-15 13:08:57 +01:00
|
|
|
*
|
2018-02-26 09:47:40 +01:00
|
|
|
* @return $this Current BulkManager instance
|
2015-12-15 13:08:57 +01:00
|
|
|
*/
|
2018-02-26 09:47:40 +01:00
|
|
|
public function removeBulkAction($handlerClassName = null, $urlSegment = null)
|
2015-12-15 13:08:57 +01:00
|
|
|
{
|
2018-02-26 09:47:40 +01:00
|
|
|
if (!$handlerClassName && !$urlSegment) {
|
2018-02-12 14:11:49 +01:00
|
|
|
user_error("Provide either a class name or URL segment", E_USER_ERROR);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
2018-02-12 14:11:49 +01:00
|
|
|
foreach ($this->config['actions'] as $url => $class)
|
|
|
|
{
|
2018-02-26 09:47:40 +01:00
|
|
|
if ($handlerClassName === $class || $urlSegment === $url)
|
2018-02-12 14:11:49 +01:00
|
|
|
{
|
|
|
|
unset($this->config['actions'][$url]);
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
}
|
2015-12-15 13:08:57 +01:00
|
|
|
|
2018-02-26 09:47:40 +01:00
|
|
|
user_error("Bulk action '$handlerClassName' or '$urlSegment' doesn't exists.", E_USER_ERROR);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the list of bulk actions already provided
|
|
|
|
*
|
|
|
|
* @return RequestHandler[]
|
|
|
|
*/
|
|
|
|
public function getBulkActions()
|
|
|
|
{
|
|
|
|
return $this->config['actions'];
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/* **********************************************************************
|
|
|
|
* GridField_ColumnProvider
|
|
|
|
* */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add bulk select column.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField Current GridField instance
|
|
|
|
* @param array $columns Columns list
|
|
|
|
*/
|
|
|
|
public function augmentColumns($gridField, &$columns)
|
|
|
|
{
|
|
|
|
if (!in_array('BulkSelect', $columns)) {
|
|
|
|
$columns[] = 'BulkSelect';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Which columns are handled by the component.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField Current GridField instance
|
|
|
|
*
|
|
|
|
* @return array List of handled column names
|
|
|
|
*/
|
|
|
|
public function getColumnsHandled($gridField)
|
|
|
|
{
|
|
|
|
return array('BulkSelect');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the column's content.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField Current GridField instance
|
|
|
|
* @param DataObject $record Record intance for this row
|
|
|
|
* @param string $columnName Column's name for which we need content
|
|
|
|
*
|
|
|
|
* @return mixed Column's field content
|
|
|
|
*/
|
|
|
|
public function getColumnContent($gridField, $record, $columnName)
|
|
|
|
{
|
2017-01-25 13:27:11 +01:00
|
|
|
$cb = CheckboxField::create('bulkSelect_' . $record->ID)
|
|
|
|
->addExtraClass('bulkSelect no-change-track')
|
|
|
|
->setAttribute('data-record', $record->ID);
|
2015-12-15 13:08:57 +01:00
|
|
|
|
|
|
|
return $cb->Field();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the column's HTML attributes.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField Current GridField instance
|
2018-02-26 09:47:40 +01:00
|
|
|
* @param DataObject $record Record instance for this row
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param string $columnName Column's name for which we need attributes
|
|
|
|
*
|
|
|
|
* @return array List of HTML attributes
|
|
|
|
*/
|
|
|
|
public function getColumnAttributes($gridField, $record, $columnName)
|
|
|
|
{
|
|
|
|
return array('class' => 'col-bulkSelect');
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the column's meta data.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField Current GridField instance
|
|
|
|
* @param string $columnName Column's name for which we need meta data
|
|
|
|
*
|
|
|
|
* @return array List of meta data
|
|
|
|
*/
|
|
|
|
public function getColumnMetadata($gridField, $columnName)
|
|
|
|
{
|
|
|
|
if ($columnName == 'BulkSelect') {
|
|
|
|
return array('title' => 'Select');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* **********************************************************************
|
|
|
|
* GridField_HTMLProvider
|
|
|
|
* */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param GridField $gridField
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getHTMLFragments($gridField)
|
|
|
|
{
|
2018-03-05 23:03:12 +01:00
|
|
|
Requirements::javascript('colymba/gridfield-bulk-editing-tools:client/dist/js/main.js');
|
|
|
|
Requirements::css('colymba/gridfield-bulk-editing-tools:client/dist/styles/main.css');
|
2018-02-28 20:26:30 +01:00
|
|
|
Requirements::add_i18n_javascript('colymba/gridfield-bulk-editing-tools:client/lang');
|
2015-12-15 13:08:57 +01:00
|
|
|
|
|
|
|
if (!count($this->config['actions'])) {
|
2018-02-26 09:47:40 +01:00
|
|
|
user_error('Trying to use BulkManager without any bulk action.', E_USER_ERROR);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
$actionsListSource = array();
|
|
|
|
$actionsConfig = array();
|
|
|
|
|
2018-02-26 09:47:40 +01:00
|
|
|
foreach ($this->config['actions'] as $urlSegment => $handlerClassName) {
|
|
|
|
$handler = Injector::inst()->get($handlerClassName);
|
2018-02-12 14:11:49 +01:00
|
|
|
$handlerConfig = $handler->getConfig();
|
2015-12-15 13:08:57 +01:00
|
|
|
|
2018-02-12 14:11:49 +01:00
|
|
|
$actionsListSource[$urlSegment] = $handlerConfig['label'];
|
|
|
|
$actionsConfig[$urlSegment] = $handlerConfig;
|
|
|
|
}
|
2015-12-15 13:08:57 +01:00
|
|
|
|
2018-02-27 12:49:51 +01:00
|
|
|
$dropDownActionsList = DropdownField::create(
|
|
|
|
'bulkActionName',
|
|
|
|
false
|
|
|
|
)
|
2015-12-15 13:08:57 +01:00
|
|
|
->setSource($actionsListSource)
|
2018-02-27 12:49:51 +01:00
|
|
|
->addExtraClass('bulkActionName no-change-track form-group--no-label')
|
|
|
|
->setAttribute('id', '')
|
|
|
|
->setEmptyString(_t('SilverStripe\Admin\LeftAndMain.DropdownBatchActionsDefault', 'Choose an action...'));
|
|
|
|
|
2018-02-12 14:11:49 +01:00
|
|
|
|
2015-12-15 13:08:57 +01:00
|
|
|
$templateData = array(
|
2018-02-27 12:49:51 +01:00
|
|
|
'Menu' => $dropDownActionsList->FieldHolder(),
|
2017-01-25 13:27:11 +01:00
|
|
|
'Button' => array(
|
|
|
|
'Label' => _t('GRIDFIELD_BULK_MANAGER.ACTION_BTN_LABEL', 'Go'),
|
|
|
|
'DataURL' => $gridField->Link('bulkAction'),
|
2018-03-01 09:12:19 +01:00
|
|
|
'DataConfig' => json_encode($actionsConfig)
|
2017-01-25 13:27:11 +01:00
|
|
|
),
|
|
|
|
'Select' => array(
|
|
|
|
'Label' => _t('GRIDFIELD_BULK_MANAGER.SELECT_ALL_LABEL', 'Select all'),
|
|
|
|
),
|
|
|
|
'Colspan' => (count($gridField->getColumns()) - 1),
|
|
|
|
);
|
2013-12-01 12:31:35 +01:00
|
|
|
|
2015-12-15 13:08:57 +01:00
|
|
|
$templateData = new ArrayData($templateData);
|
|
|
|
|
|
|
|
return array(
|
2018-02-12 15:04:09 +01:00
|
|
|
'header' => $templateData->renderWith('Colymba\\BulkManager\\BulkManagerButtons'),
|
2015-12-15 13:08:57 +01:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* **********************************************************************
|
|
|
|
* GridField_URLHandler
|
|
|
|
* */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns an action => handler list.
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getURLHandlers($gridField)
|
|
|
|
{
|
|
|
|
return array(
|
2017-01-25 13:27:11 +01:00
|
|
|
'bulkAction' => 'handleBulkAction',
|
|
|
|
);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pass control over to the RequestHandler
|
|
|
|
* loop through the handlers provided in config['actions']
|
|
|
|
* and find matching url_handlers.
|
|
|
|
*
|
|
|
|
* $url_handlers rule should not use wildcards like '$Action' => '$Action'
|
|
|
|
* but have more specific path defined
|
2017-01-25 13:27:11 +01:00
|
|
|
*
|
2015-12-15 13:08:57 +01:00
|
|
|
* @param GridField $gridField
|
2017-01-25 13:27:11 +01:00
|
|
|
* @param HTTPRequest $request
|
2015-12-15 13:08:57 +01:00
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function handleBulkAction($gridField, $request)
|
|
|
|
{
|
2018-09-30 23:05:36 +02:00
|
|
|
$controller = Controller::curr();
|
2018-02-12 14:11:49 +01:00
|
|
|
$actionUrlSegment = $request->shift();
|
|
|
|
$handlerClass = $this->config['actions'][$actionUrlSegment];
|
|
|
|
|
2018-03-11 11:37:50 +01:00
|
|
|
$controller->pushCurrent();
|
|
|
|
$handler = Injector::inst()->create($handlerClass, $gridField, $this);
|
2018-09-30 23:05:36 +02:00
|
|
|
if ($handler) {
|
2018-02-12 14:11:49 +01:00
|
|
|
return $handler->handleRequest($request);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
|
|
|
|
2018-02-12 14:11:49 +01:00
|
|
|
user_error('Unable to find matching bulk action handler for ' . $actionUrlSegment . ' URL segment.', E_USER_ERROR);
|
2015-12-15 13:08:57 +01:00
|
|
|
}
|
2015-12-07 12:03:20 +01:00
|
|
|
}
|