-
-
Notifications
You must be signed in to change notification settings - Fork 188
/
FlashMessageService.php
119 lines (110 loc) · 5.06 KB
/
FlashMessageService.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
<?php
namespace Neos\Flow\Mvc\FlashMessage;
/*
* This file is part of the Neos.Flow 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.
*/
use Neos\Flow\Annotations as Flow;
use Neos\Flow\Mvc\ActionRequest;
use Neos\Flow\Mvc\Exception\InvalidFlashMessageConfigurationException;
use Neos\Flow\ObjectManagement\ObjectManagerInterface;
use Neos\Flow\Security\Exception\InvalidRequestPatternException;
use Neos\Flow\Security\Exception\NoRequestPatternFoundException;
use Neos\Flow\Security\RequestPatternInterface;
use Neos\Flow\Security\RequestPatternResolver;
use Neos\Utility\PositionalArraySorter;
use Psr\Http\Message\ResponseInterface as HttpResponseInterface;
/**
* @Flow\Scope("singleton")
*/
class FlashMessageService
{
/**
* @Flow\Inject
* @var ObjectManagerInterface
*/
protected $objectManager;
/**
* @Flow\Inject
* @var RequestPatternResolver
*/
protected $requestPatternResolver;
/**
* @Flow\InjectConfiguration(path="mvc.flashMessages.containers")
* @var array
*/
protected $flashMessageContainerConfiguration;
/**
* Runtime cache for FlashMessage storage instances indexed by the unique container name
*
* @var FlashMessageStorageInterface[]
*/
private $instantiatedStorages = [];
/**
* Persist all FlashMessageContainers that have been instantiated during the current request cycle
*
* @param HttpResponseInterface $response
* @return HttpResponseInterface
*/
public function persistFlashMessages(HttpResponseInterface $response): HttpResponseInterface
{
foreach ($this->instantiatedStorages as $containerName => $flashMessageStorage) {
$response = $flashMessageStorage->persist($response);
}
return $response;
}
/**
* Load the FlashMessageContainer for the given request
*
* @param ActionRequest $request
* @return FlashMessageContainer
* @throws InvalidFlashMessageConfigurationException
* @throws InvalidRequestPatternException|NoRequestPatternFoundException
*/
public function getFlashMessageContainerForRequest(ActionRequest $request): FlashMessageContainer
{
$storage = $this->getStorageByRequest($request);
return $storage->load($request->getHttpRequest());
}
/**
* @param ActionRequest $request
* @return FlashMessageStorageInterface
* @throws InvalidFlashMessageConfigurationException
* @throws InvalidRequestPatternException|NoRequestPatternFoundException
*/
private function getStorageByRequest(ActionRequest $request): FlashMessageStorageInterface
{
$sortedContainerConfiguration = (new PositionalArraySorter($this->flashMessageContainerConfiguration))->toArray();
foreach ($sortedContainerConfiguration as $containerName => $containerConfiguration) {
if (isset($this->instantiatedStorages[$containerName])) {
return $this->instantiatedStorages[$containerName];
}
if (!isset($containerConfiguration['storage'])) {
throw new InvalidFlashMessageConfigurationException(sprintf('Missing "storage" option for FlashMessage container "%s"', $containerName), 1502966239);
}
if (isset($containerConfiguration['requestPatterns'])) {
foreach ($containerConfiguration['requestPatterns'] as $patternName => $patternConfiguration) {
$patternClassName = $this->requestPatternResolver->resolveRequestPatternClass($patternConfiguration['pattern']);
$requestPattern = $this->objectManager->get($patternClassName, $patternConfiguration['patternOptions'] ?? []);
if (!$requestPattern instanceof RequestPatternInterface) {
throw new InvalidRequestPatternException(sprintf('Invalid request pattern configuration in setting "Neos:Flow:mvc:flashMessages:containers:%s:requestPatterns:%s": Class "%s" does not implement RequestPatternInterface', $containerName, $patternName, $patternClassName), 1502982201);
}
if (!$requestPattern->matchRequest($request)) {
continue 2;
}
}
}
$instantiatedStorage = $this->objectManager->get($containerConfiguration['storage'], $containerConfiguration['storageOptions'] ?? []);
if (!$instantiatedStorage instanceof FlashMessageStorageInterface) {
throw new InvalidFlashMessageConfigurationException(sprintf('The configured "storage" for FlashMessage container "%s" does not implement the FlashMessageStorageInterface', $containerName), 1502966423);
}
return $this->instantiatedStorages[$containerName] = $instantiatedStorage;
}
throw new InvalidFlashMessageConfigurationException('No FlashMessage Storage could be resolved for the current request', 1502966545);
}
}