Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
27 | final class GenericEntityFetchController |
||
28 | { |
||
29 | use ApplyDataTemplateTrait; |
||
30 | |||
31 | /** |
||
32 | * @var ControllerHelperInterface |
||
33 | */ |
||
34 | private ControllerHelperInterface $controllerHelper; |
||
|
|||
35 | |||
36 | private ?EncoderInterface $encoder; |
||
37 | |||
38 | private ?NormalizerInterface $normalizer; |
||
39 | |||
40 | private ?array $dataTemplate; |
||
41 | |||
42 | private ?string $authorizationAttribute; |
||
43 | |||
44 | /** @var class-string */ |
||
45 | private string $entityClass; |
||
46 | |||
47 | private string $entityIdKey; |
||
48 | |||
49 | private string $format; |
||
50 | |||
51 | public function __construct( |
||
52 | ControllerHelperInterface $controllerHelper, |
||
53 | array $options |
||
54 | ) { |
||
55 | Assert::keyExists($options, 'entity-class'); |
||
56 | |||
57 | $options = array_merge([ |
||
58 | 'format' => 'json', |
||
59 | 'encoder' => null, |
||
60 | 'normalizer' => null, |
||
61 | 'data-template' => null, |
||
62 | 'authorization-attribute' => null, |
||
63 | 'entity-id-key' => 'entityId', |
||
64 | ], $options); |
||
65 | |||
66 | Assert::true(is_null($options['encoder']) || $options['encoder'] instanceof EncoderInterface); |
||
67 | Assert::true(is_null($options['normalizer']) || $options['normalizer'] instanceof NormalizerInterface); |
||
68 | Assert::classExists($options['entity-class']); |
||
69 | |||
70 | $this->controllerHelper = $controllerHelper; |
||
71 | 13 | $this->entityIdKey = $options['entity-id-key']; |
|
72 | $this->encoder = $options['encoder']; |
||
73 | $this->normalizer = $options['normalizer']; |
||
74 | $this->entityClass = $options['entity-class']; |
||
75 | 13 | $this->format = $options['format']; |
|
76 | 13 | $this->dataTemplate = $options['data-template']; |
|
77 | $this->authorizationAttribute = $options['authorization-attribute']; |
||
78 | 12 | } |
|
79 | 12 | ||
80 | public function __invoke(): Response |
||
81 | { |
||
82 | /** @var Request $request */ |
||
83 | $request = $this->controllerHelper->getCurrentRequest(); |
||
84 | |||
85 | 12 | Assert::isInstanceOf($request, Request::class, "Cannot use controller outside of request-scope!"); |
|
86 | |||
87 | 12 | /** @var string $entityId */ |
|
88 | 11 | $entityId = $request->get($this->entityIdKey); |
|
89 | 10 | ||
90 | return $this->fetchEntity($entityId); |
||
91 | 9 | } |
|
92 | 9 | ||
93 | 9 | public function fetchEntity(string $entityId): Response |
|
94 | 9 | { |
|
95 | 9 | /** @var object $entity */ |
|
96 | 9 | $entity = $this->controllerHelper->findEntity($this->entityClass, $entityId); |
|
97 | 9 | ||
98 | 9 | if (is_null($entity)) { |
|
99 | 9 | throw new InvalidArgumentException(sprintf( |
|
100 | "Could not find entity with id '%s'!", |
||
101 | 2 | $entityId |
|
102 | )); |
||
103 | } |
||
104 | 2 | ||
105 | if (!empty($this->authorizationAttribute)) { |
||
106 | 2 | $this->controllerHelper->denyAccessUnlessGranted($this->authorizationAttribute, $entity); |
|
107 | } |
||
108 | |||
109 | 1 | $this->controllerHelper->dispatchEvent("symfony_generics.entity_interaction", new EntityInteractionEvent( |
|
110 | $this->entityClass, |
||
111 | 1 | $entityId, |
|
112 | $entity, |
||
113 | "*FETCH*" |
||
114 | 7 | )); |
|
115 | |||
116 | /** @var array $normalizedEntity */ |
||
117 | 7 | $normalizedEntity = array(); |
|
118 | |||
119 | 7 | if ($this->normalizer instanceof NormalizerInterface) { |
|
120 | 1 | $normalizedEntity = $this->normalizer->normalize($entity); |
|
121 | 1 | ||
122 | 1 | } else { |
|
123 | $normalizer = new ObjectNormalizer(); |
||
124 | |||
125 | $normalizedEntity = $normalizer->normalize($entity); |
||
126 | 6 | } |
|
127 | 1 | ||
128 | if (!is_array($normalizedEntity)) { |
||
129 | throw new ErrorException("Result of normalize process must be an array!"); |
||
130 | 5 | } |
|
131 | 5 | ||
132 | 5 | if (!is_null($this->dataTemplate)) { |
|
133 | 5 | $normalizedEntity = $this->applyDataTemplate($normalizedEntity, $this->dataTemplate); |
|
134 | 5 | } |
|
135 | |||
136 | /** @var string $serializedEntity */ |
||
137 | $serializedEntity = ""; |
||
138 | 5 | ||
139 | if ($this->encoder instanceof EncoderInterface) { |
||
140 | 5 | $serializedEntity = $this->encoder->encode($normalizedEntity, $this->format); |
|
141 | 1 | ||
142 | } else { |
||
143 | $serializedEntity = json_encode($normalizedEntity); |
||
144 | 4 | } |
|
145 | |||
146 | 4 | return new Response($serializedEntity); |
|
147 | } |
||
148 | |||
149 | } |
||
150 |