-
Notifications
You must be signed in to change notification settings - Fork 116
/
ElementalPageExtension.php
179 lines (166 loc) · 5.79 KB
/
ElementalPageExtension.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
<?php
namespace DNADesign\Elemental\Extensions;
use DNADesign\Elemental\Models\BaseElement;
use DNADesign\Elemental\Models\ElementalArea;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Controller;
use SilverStripe\View\Parsers\HTMLValue;
use SilverStripe\View\SSViewer;
/**
* @property int ElementalAreaID
* @method ElementalArea ElementalArea()
*
* @extends ElementalAreasExtension<SiteTree>
*/
class ElementalPageExtension extends ElementalAreasExtension
{
private static $has_one = [
'ElementalArea' => ElementalArea::class,
];
private static $owns = [
'ElementalArea',
];
private static $cascade_duplicates = [
'ElementalArea',
];
/**
* The delimiter to separate distinct elements in indexed content.
*
* When using the getElementsForSearch() method to index all elements in a single field,
* a custom delimiter can be used help to avoid false positive results for phrase queries.
*
* @config
* @var string
*/
private static $search_index_element_delimiter = ' ';
/**
* Used to cache all ElementalArea's prior to eager loading elements
*
* @internal
*/
private static ?array $elementalAreas = null;
/**
* Returns the contents of each ElementalArea has_one's markup for use in Solr or Elastic search indexing
*
* @return string
*/
public function getElementsForSearch()
{
$oldThemes = SSViewer::get_themes();
SSViewer::set_themes(SSViewer::config()->get('themes'));
try {
$output = [];
$elements = $this->getEagerLoadedElements();
/** @var BaseElement $element */
foreach ($elements as $element) {
if (!$element->getSearchIndexable()) {
continue;
}
$content = $element->getContentForSearchIndex();
if ($content) {
$output[] = $content;
}
}
} finally {
// Reset theme if an exception occurs, if you don't have a
// try / finally around code that might throw an Exception,
// CMS layout can break on the response. (SilverStripe 4.1.1)
SSViewer::set_themes($oldThemes);
}
return implode($this->owner->config()->get('search_index_element_delimiter') ?? '', $output);
}
/**
* Returns the contents of all Elements on the pages ElementalAreas for use in CMS search
*/
public function getContentFromElementsForCmsSearch(): string
{
$output = [];
$elements = $this->getEagerLoadedElements();
/** @var BaseElement $element */
foreach ($elements as $element) {
if (!$element->getSearchIndexable()) {
continue;
}
$content = $element->getContentForCmsSearch();
if ($content) {
$output[] = $content;
}
}
// Use |%| to delimite different elements rather than space so that you don't
// accidentally join results of two elements that are next to each other in a table
return implode('|%|', $output);
}
/**
* @see SiteTree::getAnchorsOnPage()
*/
public function updateAnchorsOnPage(array &$anchors): void
{
if (!($this->owner instanceof SiteTree)) {
return;
}
$this->loopThroughElements(function (BaseElement $element) use (&$anchors) {
$anchors = array_merge($anchors, $element->getAnchorsInContent());
});
}
public function MetaTags(&$tags)
{
if (!Controller::has_curr()) {
return;
}
$controller = Controller::curr();
$request = $controller->getRequest();
if ($request->getVar('ElementalPreview') !== null) {
$html = HTMLValue::create($tags);
$xpath = "//meta[@name='x-page-id' or @name='x-cms-edit-link']";
$removeTags = $html->query($xpath);
$body = $html->getBody();
foreach ($removeTags as $tag) {
$body->removeChild($tag);
}
$tags = $html->getContent();
}
}
private function getEagerLoadedElements(): array
{
$elements = [];
if (is_null(ElementalPageExtension::$elementalAreas)) {
ElementalPageExtension::$elementalAreas = [];
foreach (ElementalArea::get()->eagerLoad('Elements') as $elementalArea) {
ElementalPageExtension::$elementalAreas[$elementalArea->ID] = $elementalArea;
}
}
foreach ($this->owner->hasOne() as $relation => $class) {
if (!is_a($class, ElementalArea::class, true)) {
continue;
}
$elementalAreaID = $this->owner->{"{$relation}ID"};
if ($elementalAreaID && array_key_exists($elementalAreaID, ElementalPageExtension::$elementalAreas)) {
$elementalArea = ElementalPageExtension::$elementalAreas[$elementalAreaID];
} else {
$elementalArea = $this->owner->$relation();
}
foreach ($elementalArea->Elements() as $element) {
$elements[] = $element;
}
}
return $elements;
}
/**
* Call some function over all elements belonging to this page
*/
private function loopThroughElements(callable $callback): void
{
foreach ($this->owner->hasOne() as $key => $class) {
if ($class !== ElementalArea::class) {
continue;
}
/** @var ElementalArea $area */
$area = $this->owner->$key();
if ($area) {
foreach ($area->Elements() as $element) {
$callback($element);
}
}
}
}
}