|
1
|
|
|
<?php |
|
2
|
|
|
namespace DNADesign\Elemental\Services; |
|
3
|
|
|
|
|
4
|
|
|
use DNADesign\Elemental\Models\BaseElement; |
|
5
|
|
|
use Psr\SimpleCache\CacheInterface; |
|
6
|
|
|
use SilverStripe\Core\ClassInfo; |
|
7
|
|
|
use SilverStripe\Core\Config\Configurable; |
|
8
|
|
|
use SilverStripe\Core\Flushable; |
|
9
|
|
|
use SilverStripe\Core\Injector\Injector; |
|
10
|
|
|
use SilverStripe\Forms\TabSet; |
|
11
|
|
|
|
|
12
|
|
|
/** |
|
13
|
|
|
* Provides top-level CMS field tab names for any element that extends BaseElement |
|
14
|
|
|
* |
|
15
|
|
|
* Note that this will be replaced by GraphQL form schema caching (see |
|
16
|
|
|
* http://github.com/silverstripe/silverstripe-admin/issues/627 ). This service may be removed without warning in a |
|
17
|
|
|
* minor release. |
|
18
|
|
|
* |
|
19
|
|
|
* @internal |
|
20
|
|
|
*/ |
|
21
|
|
|
class ElementTabProvider implements Flushable |
|
22
|
|
|
{ |
|
23
|
|
|
use Configurable; |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* Set to true to refresh the tab cache on flush |
|
27
|
|
|
* |
|
28
|
|
|
* @config |
|
29
|
|
|
* @var bool |
|
30
|
|
|
*/ |
|
31
|
|
|
private static $regenerate_on_flush = false; |
|
|
|
|
|
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @var CacheInterface |
|
35
|
|
|
*/ |
|
36
|
|
|
protected $cache; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* ElementTabProvider constructor. |
|
40
|
|
|
* @param CacheInterface $cache |
|
41
|
|
|
*/ |
|
42
|
|
|
public function __construct(CacheInterface $cache = null) |
|
43
|
|
|
{ |
|
44
|
|
|
if (!$cache) { |
|
45
|
|
|
$cache = Injector::inst()->get(CacheInterface::class . '.ElementTabCache'); |
|
46
|
|
|
} |
|
47
|
|
|
$this->cache = $cache; |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
/** |
|
51
|
|
|
* Get the top level tab names for the given element class |
|
52
|
|
|
* |
|
53
|
|
|
* @param string $elementClass |
|
54
|
|
|
* @return array Array of the tabs for the element |
|
55
|
|
|
*/ |
|
56
|
|
|
public function getTabsForElement($elementClass) |
|
57
|
|
|
{ |
|
58
|
|
|
if (null !== ($tabs = $this->getCache()->get($this->getCacheKey($elementClass)))) { |
|
59
|
|
|
return $tabs; |
|
60
|
|
|
} |
|
61
|
|
|
|
|
62
|
|
|
return $this->generateTabsForElement($elementClass); |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* This function is triggered early in the request if the "flush" query |
|
67
|
|
|
* parameter has been set. Each class that implements Flushable implements |
|
68
|
|
|
* this function which looks after it's own specific flushing functionality. |
|
69
|
|
|
* |
|
70
|
|
|
* @see FlushMiddleware |
|
71
|
|
|
*/ |
|
72
|
|
|
public static function flush() |
|
73
|
|
|
{ |
|
74
|
|
|
/** @var static $self */ |
|
75
|
|
|
$self = singleton(static::class); |
|
76
|
|
|
|
|
77
|
|
|
$self->cache->clear(); |
|
78
|
|
|
|
|
79
|
|
|
if ($self->config()->get('regenerate_on_flush')) { |
|
80
|
|
|
$self->generateAllTabs(); |
|
81
|
|
|
} |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
/** |
|
85
|
|
|
* @param CacheInterface $cache |
|
86
|
|
|
* @return $this |
|
87
|
|
|
*/ |
|
88
|
|
|
public function setCache($cache) |
|
89
|
|
|
{ |
|
90
|
|
|
$this->cache = $cache; |
|
91
|
|
|
return $this; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* @return CacheInterface |
|
96
|
|
|
*/ |
|
97
|
|
|
protected function getCache() |
|
98
|
|
|
{ |
|
99
|
|
|
return $this->cache; |
|
100
|
|
|
} |
|
101
|
|
|
|
|
102
|
|
|
/** |
|
103
|
|
|
* Identify and regenerate all tab names for all elemental blocks (and cache them) |
|
104
|
|
|
* |
|
105
|
|
|
* @return void |
|
106
|
|
|
*/ |
|
107
|
|
|
protected function generateAllTabs() |
|
108
|
|
|
{ |
|
109
|
|
|
foreach (ClassInfo::subclassesFor(BaseElement::class) as $class) { |
|
110
|
|
|
$this->generateTabsForElement($class); |
|
111
|
|
|
} |
|
112
|
|
|
} |
|
113
|
|
|
|
|
114
|
|
|
/** |
|
115
|
|
|
* Generate top level tab names for the given element class (and cache them) |
|
116
|
|
|
* |
|
117
|
|
|
* @param string $elementClass |
|
118
|
|
|
* @return array |
|
119
|
|
|
*/ |
|
120
|
|
|
protected function generateTabsForElement($elementClass) |
|
121
|
|
|
{ |
|
122
|
|
|
// We set an ID because some tabs only show if ->isInDb() is true |
|
123
|
|
|
/** @var BaseElement $element */ |
|
124
|
|
|
$element = Injector::inst()->create($elementClass); |
|
125
|
|
|
$element->ID = 1; |
|
126
|
|
|
|
|
127
|
|
|
/** @var TabSet $tabset */ |
|
128
|
|
|
$tabset = $element->getCMSFields()->fieldByName('Root'); |
|
129
|
|
|
|
|
130
|
|
|
$tabs = $tabset->Tabs()->map()->toArray(); |
|
131
|
|
|
|
|
132
|
|
|
$this->getCache()->set($this->getCacheKey($elementClass), $tabs); |
|
133
|
|
|
|
|
134
|
|
|
return $tabs; |
|
135
|
|
|
} |
|
136
|
|
|
|
|
137
|
|
|
/** |
|
138
|
|
|
* Generate a valid cache key from the given element class. |
|
139
|
|
|
* |
|
140
|
|
|
* @param string $className |
|
141
|
|
|
* @return string |
|
142
|
|
|
*/ |
|
143
|
|
|
protected function getCacheKey($className) |
|
144
|
|
|
{ |
|
145
|
|
|
return 'Tabs.' . str_replace(['\\'], '-', $className); |
|
146
|
|
|
} |
|
147
|
|
|
} |
|
148
|
|
|
|
dnadesign /
silverstripe-elemental
Loading history...