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 | trait Relations |
||
14 | { |
||
15 | /** |
||
16 | * @param string $entity |
||
17 | * @param string|null $field |
||
18 | * @param callable|null $callback |
||
19 | * |
||
20 | * @return OneToOne |
||
21 | */ |
||
22 | public function hasOne($entity, $field = null, callable $callback = null) |
||
26 | |||
27 | /** |
||
28 | * @param string $entity |
||
29 | * @param string|null $field |
||
30 | * @param callable|null $callback |
||
31 | * |
||
32 | * @return OneToOne |
||
33 | */ |
||
34 | View Code Duplication | public function oneToOne($entity, $field = null, callable $callback = null) |
|
46 | |||
47 | /** |
||
48 | * @param string $entity |
||
49 | * @param string|null $field |
||
50 | * @param callable|null $callback |
||
51 | * |
||
52 | * @return ManyToOne |
||
53 | */ |
||
54 | public function belongsTo($entity, $field = null, callable $callback = null) |
||
58 | |||
59 | /** |
||
60 | * @param string $entity |
||
61 | * @param string|null $field |
||
62 | * @param callable|null $callback |
||
63 | * |
||
64 | * @return ManyToOne |
||
65 | */ |
||
66 | View Code Duplication | public function manyToOne($entity, $field = null, callable $callback = null) |
|
78 | |||
79 | /** |
||
80 | * @param string $entity |
||
81 | * @param string|null $field |
||
82 | * @param callable|null $callback |
||
83 | * |
||
84 | * @return OneToMany |
||
85 | */ |
||
86 | public function hasMany($entity, $field = null, callable $callback = null) |
||
90 | |||
91 | /** |
||
92 | * @param string $entity |
||
93 | * @param string|null $field |
||
94 | * @param callable|null $callback |
||
95 | * |
||
96 | * @return OneToMany |
||
97 | */ |
||
98 | View Code Duplication | public function oneToMany($entity, $field = null, callable $callback = null) |
|
110 | |||
111 | /** |
||
112 | * @param string $entity |
||
113 | * @param string|null $field |
||
114 | * @param callable|null $callback |
||
115 | * |
||
116 | * @return ManyToMany |
||
117 | */ |
||
118 | public function belongsToMany($entity, $field = null, callable $callback = null) |
||
122 | |||
123 | /** |
||
124 | * @param string $entity |
||
125 | * @param string|null $field |
||
126 | * @param callable|null $callback |
||
127 | * |
||
128 | * @return ManyToMany |
||
129 | */ |
||
130 | View Code Duplication | public function manyToMany($entity, $field = null, callable $callback = null) |
|
142 | |||
143 | /** |
||
144 | * Adds a custom relation to the entity. |
||
145 | * |
||
146 | * @param Relation $relation |
||
147 | * @param callable|null $callback |
||
148 | * |
||
149 | * @return Relation |
||
150 | */ |
||
151 | public function addRelation(Relation $relation, callable $callback = null) |
||
157 | |||
158 | /** |
||
159 | * @param string $entity |
||
160 | * @param string|null $field |
||
161 | * |
||
162 | * @return string |
||
163 | */ |
||
164 | protected function guessSingularField($entity, $field = null) |
||
168 | |||
169 | /** |
||
170 | * @param string $entity |
||
171 | * @param string|null $field |
||
172 | * |
||
173 | * @return string |
||
174 | */ |
||
175 | protected function guessPluralField($entity, $field = null) |
||
179 | |||
180 | /** |
||
181 | * @return \Doctrine\ORM\Mapping\Builder\ClassMetadataBuilder |
||
182 | */ |
||
183 | abstract public function getBuilder(); |
||
184 | |||
185 | /** |
||
186 | * @param Buildable $buildable |
||
187 | * @param callable|null $callback |
||
188 | */ |
||
189 | abstract protected function callbackAndQueue(Buildable $buildable, callable $callback = null); |
||
190 | |||
191 | /** |
||
192 | * @return \Doctrine\ORM\Mapping\NamingStrategy |
||
193 | */ |
||
194 | abstract public function getNamingStrategy(); |
||
195 | } |
||
196 |