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 |
||
24 | View Code Duplication | class OpeningHoursSpecification extends BaseType implements OpeningHoursSpecificationContract, IntangibleContract, StructuredValueContract, ThingContract |
|
|
|||
25 | { |
||
26 | /** |
||
27 | * An additional type for the item, typically used for adding more specific |
||
28 | * types from external vocabularies in microdata syntax. This is a |
||
29 | * relationship between something and a class that the thing is in. In RDFa |
||
30 | * syntax, it is better to use the native RDFa syntax - the 'typeof' |
||
31 | * attribute - for multiple types. Schema.org tools may have only weaker |
||
32 | * understanding of extra types, in particular those defined externally. |
||
33 | * |
||
34 | * @param string|string[] $additionalType |
||
35 | * |
||
36 | * @return static |
||
37 | * |
||
38 | * @see http://schema.org/additionalType |
||
39 | */ |
||
40 | public function additionalType($additionalType) |
||
44 | |||
45 | /** |
||
46 | * An alias for the item. |
||
47 | * |
||
48 | * @param string|string[] $alternateName |
||
49 | * |
||
50 | * @return static |
||
51 | * |
||
52 | * @see http://schema.org/alternateName |
||
53 | */ |
||
54 | public function alternateName($alternateName) |
||
58 | |||
59 | /** |
||
60 | * The closing hour of the place or service on the given day(s) of the week. |
||
61 | * |
||
62 | * @param \DateTimeInterface|\DateTimeInterface[] $closes |
||
63 | * |
||
64 | * @return static |
||
65 | * |
||
66 | * @see http://schema.org/closes |
||
67 | */ |
||
68 | public function closes($closes) |
||
72 | |||
73 | /** |
||
74 | * The day of the week for which these opening hours are valid. |
||
75 | * |
||
76 | * @param \Spatie\SchemaOrg\Contracts\DayOfWeekContract|\Spatie\SchemaOrg\Contracts\DayOfWeekContract[] $dayOfWeek |
||
77 | * |
||
78 | * @return static |
||
79 | * |
||
80 | * @see http://schema.org/dayOfWeek |
||
81 | */ |
||
82 | public function dayOfWeek($dayOfWeek) |
||
86 | |||
87 | /** |
||
88 | * A description of the item. |
||
89 | * |
||
90 | * @param string|string[] $description |
||
91 | * |
||
92 | * @return static |
||
93 | * |
||
94 | * @see http://schema.org/description |
||
95 | */ |
||
96 | public function description($description) |
||
100 | |||
101 | /** |
||
102 | * A sub property of description. A short description of the item used to |
||
103 | * disambiguate from other, similar items. Information from other properties |
||
104 | * (in particular, name) may be necessary for the description to be useful |
||
105 | * for disambiguation. |
||
106 | * |
||
107 | * @param string|string[] $disambiguatingDescription |
||
108 | * |
||
109 | * @return static |
||
110 | * |
||
111 | * @see http://schema.org/disambiguatingDescription |
||
112 | */ |
||
113 | public function disambiguatingDescription($disambiguatingDescription) |
||
117 | |||
118 | /** |
||
119 | * The identifier property represents any kind of identifier for any kind of |
||
120 | * [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides |
||
121 | * dedicated properties for representing many of these, either as textual |
||
122 | * strings or as URL (URI) links. See [background |
||
123 | * notes](/docs/datamodel.html#identifierBg) for more details. |
||
124 | * |
||
125 | * @param \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier |
||
126 | * |
||
127 | * @return static |
||
128 | * |
||
129 | * @see http://schema.org/identifier |
||
130 | */ |
||
131 | public function identifier($identifier) |
||
135 | |||
136 | /** |
||
137 | * An image of the item. This can be a [[URL]] or a fully described |
||
138 | * [[ImageObject]]. |
||
139 | * |
||
140 | * @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image |
||
141 | * |
||
142 | * @return static |
||
143 | * |
||
144 | * @see http://schema.org/image |
||
145 | */ |
||
146 | public function image($image) |
||
150 | |||
151 | /** |
||
152 | * Indicates a page (or other CreativeWork) for which this thing is the main |
||
153 | * entity being described. See [background |
||
154 | * notes](/docs/datamodel.html#mainEntityBackground) for details. |
||
155 | * |
||
156 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage |
||
157 | * |
||
158 | * @return static |
||
159 | * |
||
160 | * @see http://schema.org/mainEntityOfPage |
||
161 | */ |
||
162 | public function mainEntityOfPage($mainEntityOfPage) |
||
166 | |||
167 | /** |
||
168 | * The name of the item. |
||
169 | * |
||
170 | * @param string|string[] $name |
||
171 | * |
||
172 | * @return static |
||
173 | * |
||
174 | * @see http://schema.org/name |
||
175 | */ |
||
176 | public function name($name) |
||
180 | |||
181 | /** |
||
182 | * The opening hour of the place or service on the given day(s) of the week. |
||
183 | * |
||
184 | * @param \DateTimeInterface|\DateTimeInterface[] $opens |
||
185 | * |
||
186 | * @return static |
||
187 | * |
||
188 | * @see http://schema.org/opens |
||
189 | */ |
||
190 | public function opens($opens) |
||
194 | |||
195 | /** |
||
196 | * Indicates a potential Action, which describes an idealized action in |
||
197 | * which this thing would play an 'object' role. |
||
198 | * |
||
199 | * @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction |
||
200 | * |
||
201 | * @return static |
||
202 | * |
||
203 | * @see http://schema.org/potentialAction |
||
204 | */ |
||
205 | public function potentialAction($potentialAction) |
||
209 | |||
210 | /** |
||
211 | * URL of a reference Web page that unambiguously indicates the item's |
||
212 | * identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or |
||
213 | * official website. |
||
214 | * |
||
215 | * @param string|string[] $sameAs |
||
216 | * |
||
217 | * @return static |
||
218 | * |
||
219 | * @see http://schema.org/sameAs |
||
220 | */ |
||
221 | public function sameAs($sameAs) |
||
225 | |||
226 | /** |
||
227 | * A CreativeWork or Event about this Thing. |
||
228 | * |
||
229 | * @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf |
||
230 | * |
||
231 | * @return static |
||
232 | * |
||
233 | * @see http://schema.org/subjectOf |
||
234 | */ |
||
235 | public function subjectOf($subjectOf) |
||
239 | |||
240 | /** |
||
241 | * URL of the item. |
||
242 | * |
||
243 | * @param string|string[] $url |
||
244 | * |
||
245 | * @return static |
||
246 | * |
||
247 | * @see http://schema.org/url |
||
248 | */ |
||
249 | public function url($url) |
||
253 | |||
254 | /** |
||
255 | * The date when the item becomes valid. |
||
256 | * |
||
257 | * @param \DateTimeInterface|\DateTimeInterface[] $validFrom |
||
258 | * |
||
259 | * @return static |
||
260 | * |
||
261 | * @see http://schema.org/validFrom |
||
262 | */ |
||
263 | public function validFrom($validFrom) |
||
267 | |||
268 | /** |
||
269 | * The date after when the item is not valid. For example the end of an |
||
270 | * offer, salary period, or a period of opening hours. |
||
271 | * |
||
272 | * @param \DateTimeInterface|\DateTimeInterface[] $validThrough |
||
273 | * |
||
274 | * @return static |
||
275 | * |
||
276 | * @see http://schema.org/validThrough |
||
277 | */ |
||
278 | public function validThrough($validThrough) |
||
282 | |||
283 | } |
||
284 |
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.