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 |
||
13 | View Code Duplication | trait RelationshipsTrait |
|
|
|||
14 | { |
||
15 | /** |
||
16 | * All relationship fields assigned to this metadata object. |
||
17 | * A relationship is a field that relates to another entity. |
||
18 | * |
||
19 | * @var RelationshipMetadata[] |
||
20 | */ |
||
21 | public $relationships = []; |
||
22 | |||
23 | /** |
||
24 | * Adds a relationship field to this entity. |
||
25 | * |
||
26 | * @param RelationshipMetadata $relationship |
||
27 | * @return self |
||
28 | */ |
||
29 | public function addRelationship(RelationshipMetadata $relationship) |
||
36 | |||
37 | /** |
||
38 | * Gets a relationship field from this entity. |
||
39 | * Returns null if the relationship does not exist. |
||
40 | * |
||
41 | * @param string $key |
||
42 | * @return RelationshipMetadata|null |
||
43 | */ |
||
44 | public function getRelationship($key) |
||
51 | |||
52 | /** |
||
53 | * Gets all relationship fields for this entity. |
||
54 | * |
||
55 | * @return RelationshipMetadata[] |
||
56 | */ |
||
57 | public function getRelationships() |
||
61 | |||
62 | /** |
||
63 | * Determines if a relationship field exists on this entity. |
||
64 | * |
||
65 | * @param string $key |
||
66 | * @return bool |
||
67 | */ |
||
68 | public function hasRelationship($key) |
||
72 | |||
73 | /** |
||
74 | * Determines any relationship fields exist. |
||
75 | * |
||
76 | * @return bool |
||
77 | */ |
||
78 | public function hasRelationships() |
||
82 | |||
83 | /** |
||
84 | * Validates that the relationship can be added. |
||
85 | * |
||
86 | * @param RelationshipMetadata $relationship |
||
87 | * @return self |
||
88 | * @throws MetadataException |
||
89 | */ |
||
90 | abstract protected function validateRelationship(RelationshipMetadata $relationship); |
||
91 | } |
||
92 |
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.