1 | <?php |
||
25 | final class GenericEntityInvokeController |
||
26 | { |
||
27 | |||
28 | private ControllerHelperInterface $controllerHelper; |
||
|
|||
29 | |||
30 | private ArgumentCompilerInterface $argumentCompiler; |
||
31 | |||
32 | /** @var class-string */ |
||
33 | private string $entityClass; |
||
34 | |||
35 | private string $entityIdKey; |
||
36 | |||
37 | private string $entityIdSource; |
||
38 | |||
39 | private string $methodName; |
||
40 | |||
41 | private array $arguments; |
||
42 | |||
43 | private ?string $denyAccessAttribute; |
||
44 | |||
45 | private string $successMessage; |
||
46 | |||
47 | private string $successFlashMessage; |
||
48 | |||
49 | private ?string $redirectRoute; |
||
50 | |||
51 | private array $redirectRouteParameters; |
||
52 | |||
53 | private int $redirectStatus; |
||
54 | |||
55 | private bool $sendReturnValueInResponse = false; |
||
56 | |||
57 | public function __construct( |
||
58 | ControllerHelperInterface $controllerHelper, |
||
59 | ArgumentCompilerInterface $argumentCompiler, |
||
60 | array $options |
||
61 | ) { |
||
62 | Assert::keyExists($options, 'entity-class'); |
||
63 | Assert::keyExists($options, 'method'); |
||
64 | |||
65 | $options = array_merge([ |
||
66 | 'arguments' => [], |
||
67 | 'deny-access-attribute' => null, |
||
68 | 'success-message' => "Entity method invoked!", |
||
69 | 'success-flash-message' => "", |
||
70 | 12 | 'redirect-route' => null, |
|
71 | 'redirect-route-parameters' => [], |
||
72 | 'redirect-status' => 301, |
||
73 | 'entity-id-key' => 'entityId', |
||
74 | 'entity-id-source' => 'request', |
||
75 | 12 | 'send-return-value-in-response' => false, |
|
76 | 12 | ], $options); |
|
77 | 11 | ||
78 | Assert::classExists($options['entity-class']); |
||
79 | 10 | Assert::methodExists($options['entity-class'], $options['method']); |
|
80 | 10 | Assert::isArray($options['arguments'], 'Method-arguments must be array!'); |
|
81 | Assert::oneOf($options['entity-id-source'], ['request', 'argument']); |
||
82 | |||
83 | $this->controllerHelper = $controllerHelper; |
||
84 | $this->argumentCompiler = $argumentCompiler; |
||
85 | $this->entityClass = $options['entity-class']; |
||
86 | $this->entityIdKey = $options['entity-id-key']; |
||
87 | $this->entityIdSource = $options['entity-id-source']; |
||
88 | $this->methodName = $options['method']; |
||
89 | $this->arguments = $options['arguments']; |
||
90 | 10 | $this->denyAccessAttribute = $options['deny-access-attribute']; |
|
91 | $this->successMessage = $options['success-message']; |
||
92 | 10 | $this->successFlashMessage = $options['success-flash-message']; |
|
93 | 9 | $this->redirectRoute = $options['redirect-route']; |
|
94 | 8 | $this->redirectStatus = $options['redirect-status']; |
|
95 | 7 | $this->redirectRouteParameters = $options['redirect-route-parameters']; |
|
96 | $this->sendReturnValueInResponse = $options['send-return-value-in-response']; |
||
97 | 7 | } |
|
98 | 7 | ||
99 | 7 | public function __invoke(): Response |
|
100 | 7 | { |
|
101 | 7 | /** @var Request $request */ |
|
102 | 7 | $request = $this->controllerHelper->getCurrentRequest(); |
|
103 | 7 | ||
104 | 7 | Assert::isInstanceOf($request, Request::class, "Cannot use controller outside of request-scope!"); |
|
105 | 7 | ||
106 | 7 | /** @var Response $response */ |
|
107 | 7 | $response = null; |
|
108 | 7 | ||
109 | 7 | if ($this->entityIdSource === 'request') { |
|
110 | 7 | /** @var string $entityId */ |
|
111 | 7 | $entityId = $request->get($this->entityIdKey); |
|
112 | |||
113 | 2 | $response = $this->invokeEntityMethod($entityId); |
|
114 | |||
115 | } elseif ($this->entityIdSource === 'argument') { |
||
116 | 2 | $response = $this->invokeEntityMethod(''); |
|
117 | } |
||
118 | 2 | ||
119 | return $response; |
||
120 | |||
121 | 1 | } |
|
122 | |||
123 | 1 | public function invokeEntityMethod(string $entityId): Response |
|
124 | { |
||
125 | 1 | /** @var object $entity */ |
|
126 | $entity = null; |
||
127 | 1 | ||
128 | if ($this->entityIdSource === 'request') { |
||
129 | $entity = $this->controllerHelper->findEntity($this->entityClass, $entityId); |
||
130 | Assert::object($entity, sprintf("Entity with id '%s' not found!", $entityId)); |
||
131 | |||
132 | } elseif ($this->entityIdSource === 'argument') { |
||
133 | 1 | $entity = $this->argumentCompiler->buildArgument($this->entityIdKey); |
|
134 | Assert::object($entity, "Entity not found!"); |
||
135 | } |
||
136 | |||
137 | 5 | Assert::isInstanceOf($entity, $this->entityClass, sprintf( |
|
138 | "Found entity is not of expected class '%s', but of class '%s' instead!", |
||
139 | $this->entityClass, |
||
140 | 5 | get_class($entity) |
|
141 | )); |
||
142 | 5 | ||
143 | 5 | if (!empty($this->denyAccessAttribute)) { |
|
144 | 5 | $this->controllerHelper->denyAccessUnlessGranted($this->denyAccessAttribute, $entity); |
|
145 | } |
||
146 | |||
147 | $reflectionObject = new ReflectionObject($entity); |
||
148 | |||
149 | /** @var ReflectionMethod $reflectionMethod */ |
||
150 | $reflectionMethod = $reflectionObject->getMethod($this->methodName); |
||
151 | 4 | ||
152 | 4 | /** @var array $callArguments */ |
|
153 | 4 | $callArguments = $this->argumentCompiler->buildCallArguments( |
|
154 | 4 | $reflectionMethod, |
|
155 | $this->arguments |
||
156 | ); |
||
157 | 4 | ||
158 | 1 | $this->controllerHelper->dispatchEvent("symfony_generics.entity_interaction", new EntityInteractionEvent( |
|
159 | $this->entityClass, |
||
160 | $entityId, |
||
161 | 3 | $entity, |
|
162 | $this->methodName, |
||
163 | $callArguments |
||
164 | 3 | )); |
|
165 | |||
166 | /** @var mixed $result */ |
||
167 | 3 | $result = $reflectionMethod->invokeArgs($entity, $callArguments); |
|
168 | 3 | ||
169 | 3 | $this->controllerHelper->flushORM(); |
|
170 | |||
171 | if (!empty($this->successFlashMessage)) { |
||
172 | 3 | $this->controllerHelper->addFlashMessage($this->successFlashMessage, "success"); |
|
173 | 3 | } |
|
174 | 3 | ||
175 | 3 | /** @var Response $response */ |
|
176 | 3 | $response = null; |
|
177 | 3 | ||
178 | if ($this->sendReturnValueInResponse) { |
||
179 | return new Response((string)$result); |
||
180 | |||
181 | 3 | } elseif (is_null($this->redirectRoute)) { |
|
182 | $response = new Response($this->successMessage); |
||
183 | 3 | ||
184 | } else { |
||
185 | 3 | $response = $this->controllerHelper->redirectToRoute( |
|
186 | $this->redirectRoute, |
||
187 | $this->argumentCompiler->buildArguments($this->redirectRouteParameters, [ |
||
188 | 'result' => $result |
||
189 | ]), |
||
190 | 3 | $this->redirectStatus |
|
191 | ); |
||
192 | 3 | } |
|
193 | |||
194 | return $response; |
||
195 | 3 | } |
|
196 | 2 | ||
197 | } |
||
198 |