/
BulkManager.php
360 lines (316 loc) · 11.1 KB
/
BulkManager.php
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<?php
namespace Colymba\BulkManager;
use ReflectionClass;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\RequestHandler;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
use SilverStripe\Forms\GridField\GridField_URLHandler;
use SilverStripe\ORM\DataObject;
use SilverStripe\View\ArrayData;
use SilverStripe\View\Requirements;
use SilverStripe\Control\Controller;
/**
* GridField component for editing attached models in bulk.
*
* @author colymba
*/
class BulkManager implements GridField_HTMLProvider, GridField_ColumnProvider, GridField_URLHandler
{
use Injectable;
/**
* component configuration.
*
* 'editableFields' => fields editable on the Model
* 'actions' => maps of action URL and Handler Class
*
* @var array
*/
protected $config = array(
'editableFields' => null,
'actions' => array(),
);
/**
* BulkManager 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, $defaultVersionedActions = false)
{
if ($editableFields != null) {
$this->setConfig('editableFields', $editableFields);
}
if ($defaultActions) {
$this
->addBulkAction(BulkAction\EditHandler::class)
->addBulkAction(BulkAction\UnlinkHandler::class)
->addBulkAction(BulkAction\DeleteHandler::class);
} elseif ($defaultVersionedActions) {
$this
->addBulkAction(BulkAction\EditHandler::class)
->addBulkAction(BulkAction\UnlinkHandler::class)
->addBulkAction(BulkAction\ArchiveHandler::class)
->addBulkAction(BulkAction\UnPublishHandler::class)
->addBulkAction(BulkAction\PublishHandler::class);
}
}
/* **********************************************************************
* 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.
* Exisiting handler will be replaced
*
* @param string $handlerClassName RequestHandler class name for this action.
* @param string $action Specific RequestHandler action to be called.
*
* @return $this Current BulkManager instance
*/
public function addBulkAction($handlerClassName, $action = null)
{
if (!class_exists($handlerClassName ?? '')) {
user_error("Bulk action handler not found: $handlerClassName", E_USER_ERROR);
}
$handler = Injector::inst()->get($handlerClassName);
$urlSegment = $handler->config()->get('url_segment');
if (!$urlSegment)
{
$rc = new ReflectionClass($handlerClassName);
$urlSegment = $rc->getShortName();
}
$this->config['actions'][$urlSegment] = $handlerClassName;
return $this;
}
/**
* Removes a bulk actions from the bulk manager interface.
*
* @param string $handlerClassName RequestHandler class name of the action to remove.
* @param string $urlSegment URL segment of the action to remove.
*
* @return $this Current BulkManager instance
*/
public function removeBulkAction($handlerClassName = null, $urlSegment = null)
{
if (!$handlerClassName && !$urlSegment) {
user_error("Provide either a class name or URL segment", E_USER_ERROR);
}
foreach ($this->config['actions'] as $url => $class)
{
if ($handlerClassName === $class || $urlSegment === $url)
{
unset($this->config['actions'][$url]);
return $this;
}
}
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'];
}
/* **********************************************************************
* 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 instance 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::javascript('colymba/gridfield-bulk-editing-tools:client/dist/js/main.js');
Requirements::css('colymba/gridfield-bulk-editing-tools:client/dist/styles/main.css');
Requirements::add_i18n_javascript('colymba/gridfield-bulk-editing-tools:client/lang');
if (!count($this->config['actions'] ?? [])) {
user_error('Trying to use BulkManager without any bulk action.', E_USER_ERROR);
}
$actionsListSource = array();
$actionsConfig = array();
foreach ($this->config['actions'] as $urlSegment => $handlerClassName) {
$handler = Injector::inst()->get($handlerClassName);
$handlerConfig = $handler->getConfig();
$actionsListSource[$urlSegment] = $handlerConfig['label'];
$actionsConfig[$urlSegment] = $handlerConfig;
}
$dropDownActionsList = DropdownField::create(
'bulkActionName',
false
)
->setSource($actionsListSource)
->addExtraClass('bulkActionName no-change-track form-group--no-label')
->setAttribute('id', '')
->setEmptyString(_t('SilverStripe\Admin\LeftAndMain.DropdownBatchActionsDefault', 'Choose an action...'));
$templateData = array(
'Menu' => $dropDownActionsList->FieldHolder(),
'Button' => array(
'Label' => _t('GRIDFIELD_BULK_MANAGER.ACTION_BTN_LABEL', 'Go'),
'DataURL' => $gridField->Link('bulkAction'),
'DataConfig' => json_encode($actionsConfig)
),
'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('Colymba\\BulkManager\\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 HTTPRequest $request
*
* @return mixed
*/
public function handleBulkAction($gridField, $request)
{
$controller = Controller::curr();
$actionUrlSegment = $request->shift();
$handlerClass = $this->config['actions'][$actionUrlSegment];
$controller->pushCurrent();
$handler = Injector::inst()->create($handlerClass, $gridField, $this);
if ($handler) {
return $handler->handleRequest($request);
}
user_error('Unable to find matching bulk action handler for ' . $actionUrlSegment . ' URL segment.', E_USER_ERROR);
}
}