as3io /
modlr
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 |
||
| 17 | abstract class AbstractAdapter implements AdapterInterface |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * The Serializer |
||
| 21 | * |
||
| 22 | * @var SerializerInterface |
||
| 23 | */ |
||
| 24 | protected $serializer; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * The Normalizer |
||
| 28 | * |
||
| 29 | * @var NormalizerInterface |
||
| 30 | */ |
||
| 31 | protected $normalizer; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * The Store to use for persistence operations. |
||
| 35 | * |
||
| 36 | * @var Store |
||
| 37 | */ |
||
| 38 | protected $store; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * The current REST request. |
||
| 42 | * |
||
| 43 | * @var Rest\RestRequest |
||
| 44 | */ |
||
| 45 | protected $request; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * The REST configuration. |
||
| 49 | * |
||
| 50 | * @var Rest\RestConfiguration |
||
| 51 | */ |
||
| 52 | protected $config; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Constructor. |
||
| 56 | * |
||
| 57 | * @param SerializerInterface $serializer |
||
| 58 | * @param NormalizerInterface $normalizer |
||
| 59 | * @param Store $store |
||
| 60 | * @param Rest\RestConfiguration $config |
||
| 61 | */ |
||
| 62 | public function __construct(SerializerInterface $serializer, NormalizerInterface $normalizer, Store $store, Rest\RestConfiguration $config) |
||
| 69 | |||
| 70 | /** |
||
| 71 | * {@inheritDoc} |
||
| 72 | */ |
||
| 73 | abstract public function processRequest(Rest\RestRequest $request); |
||
| 74 | |||
| 75 | /** |
||
| 76 | * {@inheritDoc} |
||
| 77 | */ |
||
| 78 | public function findRecord($typeKey, $identifier, array $fields = [], array $inclusions = []) |
||
| 79 | { |
||
| 80 | $model = $this->getStore()->find($typeKey, $identifier); |
||
| 81 | $payload = $this->serialize($model); |
||
| 82 | return $this->createRestResponse(200, $payload); |
||
| 83 | } |
||
| 84 | |||
| 85 | /** |
||
| 86 | * {@inheritDoc} |
||
| 87 | */ |
||
| 88 | public function findAll($typeKey, array $identifiers = [], array $fields = [], array $sort = [], array $pagination = [], array $inclusions = []) |
||
| 89 | { |
||
| 90 | $collection = $this->getStore()->findAll($typeKey, $identifiers, $fields, $sort, $pagination['offset'], $pagination['limit']); |
||
| 91 | $payload = $this->serializeCollection($collection); |
||
| 92 | return $this->createRestResponse(200, $payload); |
||
| 93 | } |
||
| 94 | |||
| 95 | /** |
||
| 96 | * {@inheritDoc} |
||
| 97 | */ |
||
| 98 | public function findQuery($typeKey, array $criteria, array $fields = [], array $sort = [], array $pagination = [], array $inclusions = []) |
||
| 99 | { |
||
| 100 | $collection = $this->getStore()->findQuery($typeKey, $criteria, $fields, $sort, $pagination['offset'], $pagination['limit']); |
||
| 101 | $payload = $this->serializeCollection($collection); |
||
| 102 | return $this->createRestResponse(200, $payload); |
||
| 103 | } |
||
| 104 | |||
| 105 | /** |
||
| 106 | * {@inheritDoc} |
||
| 107 | */ |
||
| 108 | public function findRelationship($typeKey, $identifier, $fieldKey) |
||
| 109 | { |
||
| 110 | $model = $this->getStore()->find($typeKey, $identifier); |
||
| 111 | if (false === $model->isRelationship($fieldKey)) { |
||
| 112 | throw AdapterException::badRequest(sprintf('The relationship field "%s" does not exist on model "%s"', $fieldKey, $typeKey)); |
||
| 113 | } |
||
| 114 | $rel = $model->get($fieldKey); |
||
| 115 | $payload = (true === $model->isHasOne($fieldKey)) ? $this->serialize($rel) : $this->serializeArray($rel); |
||
| 116 | return $this->createRestResponse(200, $payload); |
||
| 117 | } |
||
| 118 | |||
| 119 | /** |
||
| 120 | * {@inheritDoc} |
||
| 121 | */ |
||
| 122 | View Code Duplication | public function createRecord($typeKey, Rest\RestPayload $payload) //, array $fields = [], array $inclusions = []) |
|
| 133 | |||
| 134 | /** |
||
| 135 | * {@inheritDoc} |
||
| 136 | */ |
||
| 137 | View Code Duplication | public function updateRecord($typeKey, $identifier, Rest\RestPayload $payload) // , array $fields = [], array $inclusions = []) |
|
| 148 | |||
| 149 | /** |
||
| 150 | * {@inheritDoc} |
||
| 151 | */ |
||
| 152 | public function deleteRecord($typeKey, $identifier) |
||
| 157 | |||
| 158 | /** |
||
| 159 | * {@inheritDoc} |
||
| 160 | */ |
||
| 161 | public function autocomplete($typeKey, $attributeKey, $searchValue, array $pagination = []) |
||
| 167 | |||
| 168 | /** |
||
| 169 | * {@inheritDoc} |
||
| 170 | */ |
||
| 171 | public function getRequest() |
||
| 172 | { |
||
| 173 | return $this->request; |
||
| 174 | } |
||
| 175 | |||
| 176 | /** |
||
| 177 | * {@inheritDoc} |
||
| 178 | */ |
||
| 179 | abstract public function buildUrl(EntityMetadata $metadata, $identifier, $relFieldKey = null, $isRelatedLink = false); |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Validates a normalized create record payload. |
||
| 183 | * |
||
| 184 | * @param string $typeKey |
||
| 185 | * @param array $normalized |
||
| 186 | * @throws AdapterException On invalid create record payload. |
||
| 187 | */ |
||
| 188 | abstract protected function validateCreatePayload($typeKey, array $normalized); |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Validates a normalized update record payload. |
||
| 192 | * |
||
| 193 | * @param string $typeKey |
||
| 194 | * @param string $identifier |
||
| 195 | * @param array $normalized |
||
| 196 | * @throws AdapterException On invalid update record payload. |
||
| 197 | */ |
||
| 198 | abstract protected function validateUpdatePayload($typeKey, $identifier, array $normalized); |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Creates a RestResponse object based on common response parameters shared by this adapter. |
||
| 202 | * |
||
| 203 | * @param int $status |
||
| 204 | * @param Rest\RestPayload $payload |
||
| 205 | * @return Rest\RestResponse |
||
| 206 | */ |
||
| 207 | abstract protected function createRestResponse($status, Rest\RestPayload $payload = null); |
||
| 208 | |||
| 209 | /** |
||
| 210 | * {@inheritDoc} |
||
| 211 | */ |
||
| 212 | public function handleException(\Exception $e) |
||
| 213 | { |
||
| 232 | |||
| 233 | /** |
||
| 234 | * {@inheritDoc} |
||
| 235 | */ |
||
| 236 | public function getStore() |
||
| 240 | |||
| 241 | /** |
||
| 242 | * {@inheritDoc} |
||
| 243 | */ |
||
| 244 | public function getSerializer() |
||
| 248 | |||
| 249 | /** |
||
| 250 | * {@inheritDoc} |
||
| 251 | */ |
||
| 252 | public function getNormalizer() |
||
| 256 | |||
| 257 | /** |
||
| 258 | * {@inheritDoc} |
||
| 259 | */ |
||
| 260 | public function normalize(Rest\RestPayload $payload) |
||
| 264 | |||
| 265 | /** |
||
| 266 | * {@inheritDoc} |
||
| 267 | */ |
||
| 268 | public function serialize(Model $model = null) |
||
| 274 | |||
| 275 | /** |
||
| 276 | * {@inheritDoc} |
||
| 277 | */ |
||
| 278 | public function serializeArray(array $models) |
||
| 284 | |||
| 285 | /** |
||
| 286 | * {@inheritDoc} |
||
| 287 | */ |
||
| 288 | public function serializeCollection(Collection $collection) |
||
| 294 | |||
| 295 | /** |
||
| 296 | * Validates that the serialized value is support by a RestPayload. |
||
| 297 | * |
||
| 298 | * @param mixed $serialized |
||
| 299 | * @return bool |
||
| 300 | * @throws AdapterException On invalid serialized value. |
||
| 301 | */ |
||
| 302 | protected function validateSerialization($serialized) |
||
| 309 | |||
| 310 | /** |
||
| 311 | * {@inheritDoc} |
||
| 312 | */ |
||
| 313 | public function getEntityMetadata($typeKey) |
||
| 317 | } |
||
| 318 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.