365 lines
12 KiB
PHP
365 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* GridField component for editing attached models in bulk.
|
|
*
|
|
* @author colymba
|
|
*/
|
|
class GridFieldBulkManager implements GridField_HTMLProvider, GridField_ColumnProvider, GridField_URLHandler
|
|
{
|
|
/**
|
|
* component configuration.
|
|
*
|
|
* 'editableFields' => fields editable on the Model
|
|
* 'actions' => maps of action name and configuration
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $config = array(
|
|
'editableFields' => null,
|
|
'actions' => array(),
|
|
);
|
|
|
|
/**
|
|
* GridFieldBulkManager component constructor.
|
|
*
|
|
* @param array $editableFields List of editable fields
|
|
* @param bool $defaultActions Use default actions list. False to start fresh.
|
|
*/
|
|
public function __construct($editableFields = null, $defaultActions = true)
|
|
{
|
|
if ($editableFields != null) {
|
|
$this->setConfig('editableFields', $editableFields);
|
|
}
|
|
|
|
if ($defaultActions) {
|
|
$this->config['actions'] = array(
|
|
'bulkEdit' => array(
|
|
'label' => _t('GRIDFIELD_BULK_MANAGER.EDIT_SELECT_LABEL', 'Edit'),
|
|
'handler' => 'GridFieldBulkActionEditHandler',
|
|
'config' => array(
|
|
'isAjax' => false,
|
|
'icon' => 'pencil',
|
|
'isDestructive' => false,
|
|
),
|
|
),
|
|
'unLink' => array(
|
|
'label' => _t('GRIDFIELD_BULK_MANAGER.UNLINK_SELECT_LABEL', 'UnLink'),
|
|
'handler' => 'GridFieldBulkActionUnLinkHandler',
|
|
'config' => array(
|
|
'isAjax' => true,
|
|
'icon' => 'chain--minus',
|
|
'isDestructive' => false,
|
|
),
|
|
),
|
|
'delete' => array(
|
|
'label' => _t('GRIDFIELD_BULK_MANAGER.DELETE_SELECT_LABEL', 'Delete'),
|
|
'handler' => 'GridFieldBulkActionDeleteHandler',
|
|
'config' => array(
|
|
'isAjax' => true,
|
|
'icon' => 'decline',
|
|
'isDestructive' => true,
|
|
),
|
|
),
|
|
);
|
|
}
|
|
}
|
|
|
|
/* **********************************************************************
|
|
* Components settings and custom methodes
|
|
* */
|
|
|
|
/**
|
|
* Sets the component configuration parameter.
|
|
*
|
|
* @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.
|
|
*
|
|
* @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.
|
|
*
|
|
* @todo add config options for front-end: isAjax, icon
|
|
*
|
|
* @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
|
|
*/
|
|
public function addBulkAction($name, $label = null, $handler = null, $config = null)
|
|
{
|
|
if (array_key_exists($name, $this->config['actions'])) {
|
|
user_error("Bulk action '$name' already exists.", E_USER_ERROR);
|
|
}
|
|
|
|
if (!$label) {
|
|
$label = ucfirst($name);
|
|
}
|
|
|
|
if (!$handler) {
|
|
$handler = 'GridFieldBulkAction'.ucfirst($name).'Handler';
|
|
}
|
|
|
|
if (!ClassInfo::exists($handler)) {
|
|
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' => isset($config['isAjax']) ? $config['isAjax'] : true,
|
|
'icon' => isset($config['icon']) ? $config['icon'] : 'accept',
|
|
'isDestructive' => isset($config['isDestructive']) ? $config['isDestructive'] : false,
|
|
);
|
|
}
|
|
|
|
$this->config['actions'][$name] = array(
|
|
'label' => $label,
|
|
'handler' => $handler,
|
|
'config' => $config,
|
|
);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Removes a bulk actions from the bulk manager interface.
|
|
*
|
|
* @param string $name Bulk action's name
|
|
*
|
|
* @return GridFieldBulkManager Current GridFieldBulkManager instance
|
|
*/
|
|
public function removeBulkAction($name)
|
|
{
|
|
if (!array_key_exists($name, $this->config['actions'])) {
|
|
user_error("Bulk action '$name' doesn't exists.", E_USER_ERROR);
|
|
}
|
|
|
|
unset($this->config['actions'][$name]);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/* **********************************************************************
|
|
* GridField_ColumnProvider
|
|
* */
|
|
|
|
/**
|
|
* Add bulk select column.
|
|
*
|
|
* @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.
|
|
*
|
|
* @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.
|
|
*
|
|
* @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)
|
|
{
|
|
$cb = CheckboxField::create('bulkSelect_'.$record->ID)
|
|
->addExtraClass('bulkSelect no-change-track')
|
|
->setAttribute('data-record', $record->ID);
|
|
|
|
return $cb->Field();
|
|
}
|
|
|
|
/**
|
|
* Set the column's HTML attributes.
|
|
*
|
|
* @param GridField $gridField Current GridField instance
|
|
* @param DataObject $record Record intance for this row
|
|
* @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.
|
|
*
|
|
* @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)
|
|
{
|
|
Requirements::css(BULKEDITTOOLS_MANAGER_PATH.'/css/GridFieldBulkManager.css');
|
|
Requirements::javascript(BULKEDITTOOLS_MANAGER_PATH.'/javascript/GridFieldBulkManager.js');
|
|
Requirements::add_i18n_javascript(BULKEDITTOOLS_PATH.'/lang/js');
|
|
|
|
if (!count($this->config['actions'])) {
|
|
user_error('Trying to use GridFieldBulkManager without any bulk action.', E_USER_ERROR);
|
|
}
|
|
|
|
$actionsListSource = array();
|
|
$actionsConfig = array();
|
|
|
|
foreach ($this->config['actions'] as $action => $actionData) {
|
|
$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 = array(
|
|
'Menu' => $dropDownActionsList->FieldHolder(),
|
|
'Button' => array(
|
|
'Label' => _t('GRIDFIELD_BULK_MANAGER.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('GRIDFIELD_BULK_MANAGER.SELECT_ALL_LABEL', 'Select all'),
|
|
),
|
|
'Colspan' => (count($gridField->getColumns()) - 1),
|
|
);
|
|
|
|
$templateData = new ArrayData($templateData);
|
|
|
|
return array(
|
|
'header' => $templateData->renderWith('BulkManagerButtons'),
|
|
);
|
|
}
|
|
|
|
/* **********************************************************************
|
|
* GridField_URLHandler
|
|
* */
|
|
|
|
/**
|
|
* Returns an action => handler list.
|
|
*
|
|
* @param GridField $gridField
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getURLHandlers($gridField)
|
|
{
|
|
return array(
|
|
'bulkAction' => 'handleBulkAction',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @param GridField $gridField
|
|
* @param SS_HTTPRequest $request
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function handleBulkAction($gridField, $request)
|
|
{
|
|
$controller = $gridField->getForm()->Controller();
|
|
|
|
foreach ($this->config['actions'] as $name => $data) {
|
|
$handlerClass = $data['handler'];
|
|
$urlHandlers = Config::inst()->get($handlerClass, 'url_handlers', Config::UNINHERITED);
|
|
|
|
if ($urlHandlers) {
|
|
foreach ($urlHandlers as $rule => $action) {
|
|
if ($request->match($rule, false)) {
|
|
//print_r('matched ' . $handlerClass . ' to ' . $rule);
|
|
$handler = Injector::inst()->create($handlerClass, $gridField, $this, $controller);
|
|
|
|
return $handler->handleRequest($request, DataModel::inst());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
user_error('Unable to find matching bulk action handler for '.$request->remaining().'.', E_USER_ERROR);
|
|
}
|
|
}
|