-
Notifications
You must be signed in to change notification settings - Fork 116
/
ElementalAreaField.php
300 lines (261 loc) · 9.96 KB
/
ElementalAreaField.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
<?php
namespace DNADesign\Elemental\Forms;
use DNADesign\Elemental\Controllers\ElementalAreaController;
use DNADesign\Elemental\Models\BaseElement;
use DNADesign\Elemental\Models\ElementalArea;
use SilverStripe\Control\Controller;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\CompositeField;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\FormField;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\TabSet;
use SilverStripe\ORM\DataObjectInterface;
use Symbiote\GridFieldExtensions\GridFieldAddNewMultiClass;
use SilverStripe\Forms\GridField\GridFieldDetailForm;
use SilverStripe\Forms\GridField\GridFieldDetailForm_ItemRequest;
class ElementalAreaField extends GridField
{
/**
* @var ElementalArea $area
*/
protected $area;
/**
* @var array $type
*/
protected $types = [];
/**
* @var null
*/
protected $inputType = null;
protected $modelClassName = BaseElement::class;
/**
* @param string $name
* @param ElementalArea $area
* @param string[] $blockTypes
*/
public function __construct($name, ElementalArea $area, array $blockTypes)
{
$this->setTypes($blockTypes);
$config = new ElementalAreaConfig();
if (!empty($blockTypes)) {
/** @var GridFieldAddNewMultiClass $adder */
$adder = Injector::inst()->create(GridFieldAddNewMultiClass::class);
$adder->setClasses($blockTypes);
$config->addComponent($adder);
}
// By default, no need for a title on the editor. If there is more than one area then use `setTitle` to describe
parent::__construct($name, '', $area->Elements(), $config);
$this->area = $area;
$this->addExtraClass('element-editor__container no-change-track');
}
/**
* @param array $types
*
* @return $this
*/
public function setTypes($types)
{
$this->types = $types;
return $this;
}
/**
* @return array
*/
public function getTypes()
{
$types = $this->types;
$this->extend('updateGetTypes', $types);
return $types;
}
/**
* @return ElementalArea
*/
public function getArea()
{
return $this->area;
}
/**
* Overloaded to skip GridField implementation - this is copied from FormField.
*
* @param array $properties
* @return \SilverStripe\ORM\FieldType\DBHTMLText|string
*/
public function FieldHolder($properties = array())
{
$context = $this;
if (count($properties ?? [])) {
$context = $this->customise($properties);
}
return $context->renderWith($this->getFieldHolderTemplates());
}
public function getSchemaDataDefaults()
{
$schemaData = parent::getSchemaDataDefaults();
$area = $this->getArea();
$pageId = ($area && ($page = $area->getOwnerPage())) ? $page->ID : null;
$schemaData['page-id'] = $pageId;
$schemaData['elemental-area-id'] = $area ? (int) $area->ID : null;
$allowedTypes = $this->getTypes();
$schemaData['allowed-elements'] = array_keys($allowedTypes ?? []);
return $schemaData;
}
/**
* A getter method that seems redundant in that it is a function that returns a function,
* however the returned closure is used in an array map function to return a complete FieldList
* representing a read only view of the element passed in (to the closure).
*
* @return callable
*/
protected function getReadOnlyBlockReducer()
{
return function (BaseElement $element) {
$parentName = 'Element' . $element->ID;
$elementFields = $element->getCMSFields();
// Obtain highest impact fields for a summary (e.g. Title & Content)
foreach ($elementFields as $field) {
if (is_object($field) && $field instanceof TabSet) {
// Assign the fields of the first Tab in the TabSet - most regularly 'Root.Main'
$elementFields = $field->FieldList()->first()->FieldList();
break;
}
}
// Set values (before names don't match anymore)
$elementFields->setValues($element->getQueriedDatabaseFields());
// Combine into an appropriately named group
$elementGroup = FieldGroup::create($elementFields);
$elementGroup->setForm($this->getForm());
$elementGroup->setName($parentName);
$elementGroup->addExtraClass('elemental-area__element--historic');
// Also set the important data for the rendering Component
$elementGroup->setSchemaData([
'data' => [
'ElementID' => $element->ID,
'ElementType' => $element->getType(),
'ElementIcon' => $element->config()->get('icon'),
'ElementTitle' => $element->Title,
'ElementEditLink' => Controller::join_links(
// Always get the edit link for the block directly, not the in-line edit form if supported
$element->CMSEditLink(true),
'#Root_History'
),
],
]);
return $elementGroup;
};
}
/**
* Provides a readonly representation of the GridField (superclass) Uses a reducer
* {@see ElementalAreaField::getReadOnlyBlockReducer()} to fetch a read only representation of the listed class
* {@see GridField::getModelClass()}
*
* @return CompositeField
*/
public function performReadonlyTransformation()
{
/** @var CompositeField $readOnlyField */
$readOnlyField = $this->castedCopy(CompositeField::class);
$blockReducer = $this->getReadOnlyBlockReducer();
$readOnlyField->setChildren(
FieldList::create(array_map($blockReducer, $this->getArea()->Elements()->toArray() ?? []))
);
$readOnlyField = $readOnlyField->performReadonlyTransformation();
// Ensure field names are unique between elements on parent form but only after transformations have been
// performed
/** @var FieldGroup $elementForm */
foreach ($readOnlyField->getChildren() as $elementForm) {
$parentName = $elementForm->getName();
$elementForm->getChildren()->recursiveWalk(function (FormField $field) use ($parentName) {
$field->setName($parentName . '_' . $field->getName());
});
}
return $readOnlyField
->setReadOnly(true)
->setName($this->getName())
->addExtraClass('elemental-area--read-only');
}
public function setSubmittedValue($value, $data = null)
{
// Content comes through as a JSON encoded list through a hidden field.
return $this->setValue(json_decode($value ?? '', true));
}
/**
* This will perform FormField validation
* DataObject validation will happen in saveInto() as part of $element->write()
*/
public function validate($validator)
{
$result = true;
foreach ($this->getElementData() as $arr) {
/** @var BaseElement $element */
/** @var array $data */
$element = $arr['element'];
$data = $arr['data'];
$elementForm = $this->getElementForm($element);
if (!$elementForm) {
continue;
}
$elementForm->loadDataFrom($data);
$formValidatorResult = $elementForm->getValidator()->validate();
if (!$formValidatorResult->isValid()) {
$validator->getResult()->combineAnd($formValidatorResult);
$result = false;
}
}
return $this->extendValidationResult($result, $validator);
}
public function saveInto(DataObjectInterface $dataObject)
{
parent::saveInto($dataObject);
foreach ($this->getElementData() as $arr) {
/** @var BaseElement $element */
/** @var array $data */
$element = $arr['element'];
$data = $arr['data'];
$element->updateFromFormData($data);
$element->write();
}
}
private function getElementData(): array
{
$elementData = [];
$value = $this->Value();
if (!$value) {
return [];
}
$idPrefixLength = strlen(sprintf(ElementalAreaController::FORM_NAME_TEMPLATE ?? '', ''));
foreach ($value as $form => $data) {
// Extract the ID
$elementId = (int) substr($form ?? '', $idPrefixLength ?? 0);
$element = $this->getArea()->Elements()->byID($elementId);
if (!$element) {
// Ignore invalid elements
continue;
}
$data = ElementalAreaController::removeNamespacesFromFields($data, $element->ID);
$elementData[] = ['element' => $element, 'data' => $data];
}
return $elementData;
}
private function getElementForm(BaseElement $element): ?Form
{
// This is essentially the same method used to generate a form to edit an element
// that a non-inline edit form will use - see GridFieldDetailForm::handleItem()
$requestHandler = $requestHandler = $this->getForm()->getController();
$gridFieldDetailForm = new GridFieldDetailForm();
// The validator needs to be explicitly copied from the element to the form
$validator = $element->getCMSCompositeValidator();
$gridFieldDetailForm->setValidator($validator);
$gridFieldDetailFormItemRequest = new GridFieldDetailForm_ItemRequest(
$this,
$gridFieldDetailForm,
$element,
$requestHandler,
''
);
$form = $gridFieldDetailFormItemRequest->ItemEditForm();
return $form;
}
}