/
ElementalAreasExtension.php
340 lines (287 loc) · 10.4 KB
/
ElementalAreasExtension.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
<?php
namespace DNADesign\Elemental\Extensions;
use DNADesign\Elemental\Forms\ElementalAreaField;
use DNADesign\Elemental\Models\BaseElement;
use DNADesign\Elemental\Models\ElementalArea;
use SilverStripe\CMS\Model\RedirectorPage;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\CMS\Model\VirtualPage;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Extensible;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\RelatedData\StandardRelatedDataService;
use SilverStripe\Versioned\Versioned;
use SilverStripe\View\ViewableData;
/**
* This extension handles most of the relationships between pages and element
* area, it doesn't add an ElementArea to the page however. Because of this,
* developers can add multiple {@link ElementArea} areas to to a page.
*
* If you want multiple ElementalAreas add them as has_ones, add this extensions
* and MAKE SURE you don't forget to add ElementAreas to $owns, otherwise they
* will never publish
*
* private static $has_one = array(
* 'ElementalArea1' => ElementalArea::class,
* 'ElementalArea2' => ElementalArea::class
* );
*
* private static $owns = array(
* 'ElementalArea1',
* 'ElementalArea2'
* );
*
* private static $cascade_duplicates = array(
* 'ElementalArea1',
* 'ElementalArea2'
* );
*
* @template T of DataObject
* @extends DataExtension<T&static>
*/
class ElementalAreasExtension extends DataExtension
{
use Extensible;
/**
* Classes to ignore adding elements to
* @config
* @var array $ignored_classes
*/
private static $ignored_classes = [];
/**
* On saving the element area, should Elemental reset the main website
* `$Content` field.
*
* @config
* @var boolean
*/
private static $clear_contentfield = false;
/**
* Whether to sort the elements alphabetically by their title
*
* @config
* @var boolean
*/
private static $sort_types_alphabetically = true;
/**
* Whether or not to replace the default SiteTree content field
* Applies globally, across all page types; unless a page type overrides this with its own config setting of
* `elemental_keep_content_field`
*
* @var boolean
* @config
*/
private static $keep_content_fields = false;
/**
* Get the available element types for this page type,
*
* Uses allowed_elements, stop_element_inheritance, disallowed_elements in
* order to get to correct list.
*
* @return array
*/
public function getElementalTypes()
{
$config = $this->owner->config();
if (is_array($config->get('allowed_elements'))) {
if ($config->get('stop_element_inheritance')) {
$availableClasses = $config->get('allowed_elements', Config::UNINHERITED);
} else {
$availableClasses = $config->get('allowed_elements');
}
} else {
$availableClasses = ClassInfo::subclassesFor(BaseElement::class);
}
if ($config->get('stop_element_inheritance')) {
$disallowedElements = (array) $config->get('disallowed_elements', Config::UNINHERITED);
} else {
$disallowedElements = (array) $config->get('disallowed_elements');
}
$list = [];
foreach ($availableClasses as $availableClass) {
/** @var BaseElement $inst */
$inst = singleton($availableClass);
if (!in_array($availableClass, $disallowedElements ?? []) && $inst->canCreate()) {
if ($inst->hasMethod('canCreateElement') && !$inst->canCreateElement()) {
continue;
}
$list[$availableClass] = $inst->getType();
}
}
if ($config->get('sort_types_alphabetically') !== false) {
asort($list);
}
if (isset($list[BaseElement::class])) {
unset($list[BaseElement::class]);
}
$class = get_class($this->owner);
$this->owner->invokeWithExtensions('updateAvailableTypesForClass', $class, $list);
return $list;
}
/**
* Returns an array of the relation names to ElementAreas. Ignores any
* has_one fields named `Parent` as that would indicate that this is child
* of an existing area
*
* @return array
*/
public function getElementalRelations()
{
$hasOnes = $this->owner->hasOne();
if (!$hasOnes) {
return false;
}
$elementalAreaRelations = [];
foreach ($hasOnes as $hasOneName => $hasOneClass) {
if ($hasOneName === 'Parent' || $hasOneName === 'ParentID') {
continue;
}
if ($hasOneClass == ElementalArea::class || is_subclass_of($hasOneClass, ElementalArea::class)) {
$elementalAreaRelations[] = $hasOneName;
}
}
return $elementalAreaRelations;
}
/**
* Setup the CMS Fields
*
* @param FieldList
*/
public function updateCMSFields(FieldList $fields)
{
if (!$this->supportsElemental()) {
return;
}
// add an empty holder for content as some module explicitly use insert after content
$globalReplace = !Config::inst()->get(self::class, 'keep_content_fields');
$classOverride = Config::inst()->get(get_class($this->owner), 'elemental_keep_content_field');
if ($globalReplace && !$classOverride || $classOverride === false) {
$fields->replaceField('Content', new LiteralField('Content', ''));
}
$elementalAreaRelations = $this->owner->getElementalRelations();
foreach ($elementalAreaRelations as $eaRelationship) {
$key = $eaRelationship . 'ID';
// remove the scaffold dropdown
$fields->removeByName($key);
// remove the field, but don't add anything.
if (!$this->owner->isInDb()) {
continue;
}
// Example: $eaRelationship = 'ElementalArea';
$area = $this->owner->$eaRelationship();
$editor = ElementalAreaField::create($eaRelationship, $area, $this->getElementalTypes());
if ($this->owner instanceof SiteTree && $fields->findOrMakeTab('Root.Main')->fieldByName('Metadata')) {
$fields->addFieldToTab('Root.Main', $editor, 'Metadata');
} else {
$fields->addFieldToTab('Root.Main', $editor);
}
}
return $fields;
}
/**
* Make sure there is always an ElementalArea for adding Elements
*/
public function onBeforeWrite()
{
parent::onBeforeWrite();
if (!$this->supportsElemental()) {
return;
}
$elementalAreaRelations = $this->owner->getElementalRelations();
$this->ensureElementalAreasExist($elementalAreaRelations);
$ownerClassName = get_class($this->owner);
// Update the OwnerClassName on EA if the class has changed
foreach ($elementalAreaRelations as $eaRelation) {
$ea = $this->owner->$eaRelation();
if ($ea->OwnerClassName !== $ownerClassName) {
$ea->OwnerClassName = $ownerClassName;
$ea->write();
}
}
if (Config::inst()->get(self::class, 'clear_contentfield')) {
$this->owner->Content = '';
}
}
/**
* @return boolean
*/
public function supportsElemental()
{
if ($this->owner->hasMethod('includeElemental')) {
$res = $this->owner->includeElemental();
if ($res !== null) {
return $res;
}
}
if (is_a($this->owner, RedirectorPage::class) || is_a($this->owner, VirtualPage::class)) {
return false;
} elseif ($ignored = Config::inst()->get(ElementalPageExtension::class, 'ignored_classes')) {
foreach ($ignored as $check) {
if (is_a($this->owner, $check ?? '')) {
return false;
}
}
}
return true;
}
/**
* Set all has_one relationships to an ElementalArea to a valid ID if they're unset
*
* @param array $elementalAreaRelations indexed array of relationship names that are to ElementalAreas
* @return DataObject
*/
public function ensureElementalAreasExist($elementalAreaRelations)
{
foreach ($elementalAreaRelations as $eaRelationship) {
$areaID = $eaRelationship . 'ID';
if (!$this->owner->$areaID) {
$area = ElementalArea::create();
$area->OwnerClassName = get_class($this->owner);
$area->write();
$this->owner->$areaID = $area->ID;
}
}
return $this->owner;
}
/**
* Extension hook {@see DataObject::requireDefaultRecords}
*
* @return void
*/
public function requireDefaultRecords()
{
if (!$this->supportsElemental()) {
return;
}
$this->owner->extend('onBeforeRequireDefaultElementalRecords');
$ownerClass = get_class($this->owner);
$elementalAreas = $this->owner->getElementalRelations();
$schema = $this->owner->getSchema();
// There is no inbuilt filter for null values
$where = [];
foreach ($elementalAreas as $areaName) {
$queryDetails = $schema->sqlColumnForField($ownerClass, $areaName . 'ID');
$where[] = $queryDetails . ' IS NULL OR ' . $queryDetails . ' = 0' ;
}
$records = $ownerClass::get()->where(implode(' OR ', $where));
if ($ignored_classes = Config::inst()->get(ElementalPageExtension::class, 'ignored_classes')) {
$records = $records->exclude('ClassName', $ignored_classes);
}
foreach ($records as $elementalObject) {
if ($elementalObject->hasMethod('includeElemental')) {
$res = $elementalObject->includeElemental();
if ($res === false) {
continue;
}
}
/** @var ElementalAreasExtension $elementalObject */
$elementalObject->ensureElementalAreasExist($elementalAreas);
$elementalObject->write();
}
$this->owner->extend('onAfterRequireDefaultElementalRecords');
}
}