/
GridFieldArchiveAction.php
219 lines (191 loc) · 6 KB
/
GridFieldArchiveAction.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
<?php
namespace SilverStripe\Versioned;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_ActionMenuItem;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_ColumnProvider;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationException;
/**
* This class is a {@link GridField} component that replaces the delete action
* and adds an archive action for objects.
*/
class GridFieldArchiveAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem
{
/**
* @inheritdoc
*/
public function getTitle($gridField, $record, $columnName)
{
$field = $this->getArchiveAction($gridField, $record);
if ($field) {
return $field->getAttribute('title');
}
return _t(__CLASS__ . '.Delete', "Delete");
}
/**
* @inheritdoc
*/
public function getGroup($gridField, $record, $columnName)
{
$field = $this->getArchiveAction($gridField, $record);
return $field ? GridField_ActionMenuItem::DEFAULT_GROUP: null;
}
/**
*
* @param GridField $gridField
* @param DataObject $record
* @param string $columnName
* @return array|null the attributes for the action
*/
public function getExtraData($gridField, $record, $columnName)
{
$field = $this->getArchiveAction($gridField, $record);
if ($field) {
return $field->getAttributes();
}
return null;
}
/**
* Add a column 'Actions'
*
* @param GridField $gridField
* @param array $columns
*/
public function augmentColumns($gridField, &$columns)
{
$model = $gridField->getModelClass();
$isModelVersioned = $model::has_extension(Versioned::class);
if ($isModelVersioned) {
$config = $gridField->getConfig();
$deleteComponents = $config->getComponentsByType(GridFieldDeleteAction::class);
foreach ($deleteComponents as $deleteComponent) {
if ($deleteComponent->getRemoveRelation()) {
// The 'delete' button will "unlink" the relationship, NOT delete the item.
continue;
}
// Deleting an item that is published would leave no way to unpublish it.
$config->removeComponent($deleteComponent);
}
}
if (!in_array('Actions', $columns ?? [])) {
$columns[] = 'Actions';
}
}
/**
* Return any special attributes that will be used for FormField::create_tag()
*
* @param GridField $gridField
* @param DataObject $record
* @param string $columnName
* @return array
*/
public function getColumnAttributes($gridField, $record, $columnName)
{
return ['class' => 'grid-field__col-compact'];
}
/**
* Add the title
*
* @param GridField $gridField
* @param string $columnName
* @return array
*/
public function getColumnMetadata($gridField, $columnName)
{
if ($columnName == 'Actions') {
return ['title' => ''];
}
return [];
}
/**
* Which columns are handled by this component
*
* @param GridField $gridField
* @return array
*/
public function getColumnsHandled($gridField)
{
return ['Actions'];
}
/**
* Which GridField actions are this component handling
*
* @param GridField $gridField
* @return array
*/
public function getActions($gridField)
{
return ['archiverecord'];
}
/**
*
* @param GridField $gridField
* @param DataObject $record
* @param string $columnName
* @return string|null the HTML for the column
*/
public function getColumnContent($gridField, $record, $columnName)
{
$field = $this->getArchiveAction($gridField, $record);
if ($field) {
return $field->Field();
}
return null;
}
/**
* Handle the actions and apply any changes to the GridField
*
* @param GridField $gridField
* @param string $actionName
* @param array $arguments
* @param array $data Form data
* @throws ValidationException
*/
public function handleAction(GridField $gridField, $actionName, $arguments, $data)
{
if ($actionName === 'archiverecord') {
/** @var DataObject|Versioned $item */
$item = $gridField->getList()->byID($arguments['RecordID']);
if (!$item) {
return;
}
if (!$item->canArchive()) {
throw new ValidationException(
_t(__CLASS__ . '.ArchivePermissionsFailure', "No archive permissions")
);
}
$item->doArchive();
}
}
/**
* Returns the GridField_FormAction if archive can be performed
*
* @param GridField $gridField
* @param DataObject $record
* @return GridField_FormAction|null
*/
public function getArchiveAction($gridField, $record)
{
/* @var DataObject|Versioned $record */
if (!$record->hasMethod('canArchive') || !$record->canArchive()) {
return null;
}
$title = _t(__CLASS__ . '.Archive', "Archive");
$field = GridField_FormAction::create(
$gridField,
'ArchiveRecord' . $record->ID,
false,
"archiverecord",
['RecordID' => $record->ID]
)
->addExtraClass('action--archive btn--icon-md font-icon-box btn--no-text grid-field__icon-action action-menu--handled')
->setAttribute('classNames', 'action--archive font-icon-box')
->setDescription($title)
->setAttribute('aria-label', $title);
return $field;
}
}