-
-
Notifications
You must be signed in to change notification settings - Fork 218
/
Site.php
396 lines (356 loc) · 9.61 KB
/
Site.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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<?php
/*
* This file is part of the Neos.Neos package.
*
* (c) Contributors of the Neos Project - www.neos.io
*
* This package is Open Source Software. For the full copyright and license
* information, please view the LICENSE file which was distributed with this
* source code.
*/
declare(strict_types=1);
namespace Neos\Neos\Domain\Model;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Neos\ContentRepositoryRegistry\Exception\InvalidConfigurationException;
use Neos\Flow\Annotations as Flow;
use Neos\Media\Domain\Model\AssetCollection;
use Neos\Utility\Arrays;
/**
* Domain model of a site
*
* @Flow\Entity
* @api
*/
class Site
{
/**
* Site states
*/
public const STATE_ONLINE = 1;
public const STATE_OFFLINE = 2;
/**
* @var array
* @phpstan-var array<string,array<string,mixed>>
*/
#[Flow\InjectConfiguration(path: 'sites')]
protected $sitesConfiguration = [];
/**
* @var array
* @phpstan-var array<string,array<string,mixed>>
*/
#[Flow\InjectConfiguration(path: 'sitePresets')]
protected $sitePresetsConfiguration = [];
/**
* Name of the site
*
* @var string
* @Flow\Validate(type="Label")
* @Flow\Validate(type="NotEmpty")
* @Flow\Validate(type="StringLength", options={ "minimum"=1, "maximum"=250 })
*/
protected $name = 'Untitled Site';
/**
* Node name of this site in the content repository.
*
* The first level of nodes of a site can be reached via a path like
* "/Sites/MySite/" where "MySite" is the nodeName.
*
* @var string
* @Flow\Identity
* @Flow\Validate(type="NotEmpty")
* @Flow\Validate(type="StringLength", options={ "minimum"=1, "maximum"=250 })
* @Flow\Validate(type="\Neos\Neos\Validation\Validator\NodeNameValidator")
*/
protected $nodeName;
/**
* @var Collection<Domain>
* @phpstan-var Collection<int,Domain>
* @ORM\OneToMany(mappedBy="site")
* @Flow\Lazy
*/
protected $domains;
/**
* @var Domain
* @phpstan-var ?Domain
* @ORM\ManyToOne
* @ORM\Column(nullable=true)
*/
protected $primaryDomain;
/**
* The site's state
*
* @var integer
* @Flow\Validate(type="NumberRange", options={ "minimum"=1, "maximum"=2 })
*/
protected $state = self::STATE_OFFLINE;
/**
* @var string
* @Flow\Validate(type="NotEmpty")
*/
protected $siteResourcesPackageKey;
/**
* @var AssetCollection
* @phpstan-var ?AssetCollection
* @ORM\ManyToOne
*/
protected $assetCollection;
/**
* Constructs this Site object
*
* @param string $nodeName Node name of this site in the content repository
*/
public function __construct($nodeName)
{
$this->nodeName = $nodeName;
$this->domains = new ArrayCollection();
}
/**
* @return string
*/
public function __toString()
{
return $this->getNodeName()->value;
}
/**
* Sets the name for this site
*
* @param string $name The site name
* @return void
* @api
*/
public function setName($name)
{
$this->name = $name;
}
/**
* Returns the name of this site
*
* @return string The name
* @api
*/
public function getName()
{
return $this->name;
}
/**
* Returns the node name of this site
*
* If you need to fetch the root node for this site, use the content
* context, do not use the NodeDataRepository!
*
* @return SiteNodeName The node name
* @api
*/
public function getNodeName(): SiteNodeName
{
return SiteNodeName::fromString($this->nodeName);
}
/**
* Sets the node name for this site
*
* @param string $nodeName The site node name
* @return void
* @api
*/
public function setNodeName(string|SiteNodeName $nodeName)
{
if ($nodeName instanceof SiteNodeName) {
$nodeName = $nodeName->value;
}
$this->nodeName = $nodeName;
}
/**
* Sets the state for this site
*
* @param integer $state The site's state, must be one of the STATUS_* constants
* @return void
* @api
*/
public function setState($state)
{
$this->state = $state;
}
/**
* Returns the state of this site
*
* @return integer The state - one of the STATUS_* constant's values
* @api
*/
public function getState()
{
return $this->state;
}
/**
* Sets the key of a package containing the static resources for this site.
*
* @param string $packageKey The package key
* @return void
* @api
*/
public function setSiteResourcesPackageKey($packageKey)
{
$this->siteResourcesPackageKey = $packageKey;
}
/**
* Returns the key of a package containing the static resources for this site.
*
* @return string The package key
* @api
*/
public function getSiteResourcesPackageKey()
{
return $this->siteResourcesPackageKey;
}
/**
* @return boolean
* @api
*/
public function isOnline()
{
return $this->state === self::STATE_ONLINE;
}
/**
* @return boolean
* @api
*/
public function isOffline()
{
return $this->state === self::STATE_OFFLINE;
}
/**
* @param Collection<int,Domain> $domains
* @return void
* @api
*/
public function setDomains($domains)
{
$this->domains = $domains;
if (!$this->primaryDomain || !$this->domains->contains($this->primaryDomain)) {
$this->primaryDomain = $this->getFirstActiveDomain();
}
}
/**
* @return Collection<int,Domain>
* @api
*/
public function getDomains()
{
return $this->domains;
}
/**
* @return boolean true if the site has at least one active domain assigned
* @api
*/
public function hasActiveDomains()
{
return $this->domains->exists(function ($index, Domain $domain) {
return $domain->getActive();
});
}
/**
* @return Collection<int,Domain>
* @api
*/
public function getActiveDomains()
{
/** @var Collection<int, Domain> $activeDomains */
$activeDomains = $this->domains->filter(function (Domain $domain) {
return $domain->getActive();
});
return $activeDomains;
}
/**
* @return ?Domain
* @api
*/
public function getFirstActiveDomain()
{
$activeDomains = $this->getActiveDomains();
return count($activeDomains) > 0 ? ($activeDomains->first() ?: null) : null;
}
/**
* Sets (and adds if necessary) the primary domain of this site.
*
* @param Domain|null $domain The domain
* @return void
* @api
*/
public function setPrimaryDomain(Domain $domain = null)
{
if ($domain === null) {
$this->primaryDomain = null;
return;
}
if (!$domain->getActive()) {
return;
}
$this->primaryDomain = $domain;
if (!$this->domains->contains($domain)) {
$this->domains->add($domain);
}
}
/**
* Returns the primary domain, if one has been defined.
*
* @return ?Domain The primary domain or NULL
* @api
*/
public function getPrimaryDomain(): ?Domain
{
return $this->primaryDomain instanceof Domain && $this->primaryDomain->getActive()
? $this->primaryDomain
: $this->getFirstActiveDomain();
}
/**
* @return ?AssetCollection
*/
public function getAssetCollection()
{
return $this->assetCollection;
}
/**
* @param AssetCollection $assetCollection
* @return void
*/
public function setAssetCollection(AssetCollection $assetCollection = null)
{
$this->assetCollection = $assetCollection;
}
/**
* Internal event handler to forward site changes to the "siteChanged" signal
*
* @ORM\PostPersist
* @ORM\PostUpdate
* @ORM\PostRemove
* @return void
*/
public function onPostFlush()
{
$this->emitSiteChanged();
}
/**
* Internal signal
*
* @Flow\Signal
* @return void
*/
public function emitSiteChanged()
{
}
public function getConfiguration(): SiteConfiguration
{
$siteSettingsPath = array_key_exists($this->nodeName, $this->sitesConfiguration) ? $this->nodeName : '*';
$siteSettings = $this->sitesConfiguration[$siteSettingsPath];
if (isset($siteSettings['preset'])) {
is_string($siteSettings['preset']) || throw new \RuntimeException(sprintf('Invalid "preset" configuration for "Neos.Neos.sites.%s". Expected string, got: %s', $siteSettingsPath, get_debug_type($siteSettings['preset'])), 1699785648);
if (!isset($this->sitePresetsConfiguration[$siteSettings['preset']]) || !is_array($this->sitePresetsConfiguration[$siteSettings['preset']])) {
throw new \RuntimeException(sprintf('Site settings "Neos.Neos.sites.%s" refer to a preset "%s", but no corresponding preset is configured', $siteSettingsPath, $siteSettings['preset']), 1699785736);
}
$siteSettings = Arrays::arrayMergeRecursiveOverrule($this->sitePresetsConfiguration[$siteSettings['preset']], $siteSettings);
unset($siteSettings['preset']);
}
return SiteConfiguration::fromArray($siteSettings);
}
}