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 |
||
9 | trait TTextUtilities |
||
10 | { |
||
11 | /** |
||
12 | * Get text until <!--stop--> or all text. |
||
13 | * |
||
14 | * @param string $text with content |
||
15 | * |
||
16 | * @return string with text |
||
17 | */ |
||
18 | 6 | public function getUntilStop($text) |
|
26 | |||
27 | |||
28 | |||
29 | /** |
||
30 | * Get text until <!--more--> or all text. |
||
31 | * |
||
32 | * @param string $text with content |
||
33 | * |
||
34 | * @return array with text and boolean if more was detected. |
||
35 | */ |
||
36 | 2 | public function getUntilMore($text) |
|
45 | |||
46 | |||
47 | |||
48 | /** |
||
49 | * Wrap HTML element with with start and end. |
||
50 | * |
||
51 | * @param string $text with content |
||
52 | * @param string $tag HTML tag to search for |
||
53 | * @param string $start wrap start part |
||
54 | * @param string $end wrap end part |
||
55 | * @param number $count hits to search for |
||
56 | * |
||
57 | * @return array with text and boolean if more was detected. |
||
58 | */ |
||
59 | public function wrapElementWithStartEnd($text, $tag, $start, $end, $count) |
||
68 | |||
69 | |||
70 | |||
71 | /** |
||
72 | * Wrap content of a HTML element with start and end. |
||
73 | * |
||
74 | * @param string $text with content |
||
75 | * @param string $tag HTML tag to search for |
||
76 | * @param string $start wrap start part |
||
77 | * @param string $end wrap end part |
||
78 | * @param number $count hits to search for |
||
79 | * |
||
80 | * @return array with text and boolean if more was detected. |
||
81 | */ |
||
82 | public function wrapElementContentWithStartEnd($text, $tag, $start, $end, $count) |
||
91 | |||
92 | |||
93 | |||
94 | /** |
||
95 | * Create a TOC of HTML headings from and to a certain level. |
||
96 | * |
||
97 | * @param string $text with content |
||
98 | * @param integer $start level of headings to use for toc. |
||
99 | * @param integer $stop level of headings to use for toc. |
||
100 | * |
||
101 | * @return array with entries to generate a TOC. |
||
102 | */ |
||
103 | public function createToc($text, $start = 2, $stop = 4) |
||
126 | |||
127 | |||
128 | |||
129 | /** |
||
130 | * Create a anchor for each header having an id. |
||
131 | * |
||
132 | * @param string $text with content |
||
133 | * @param integer $start level of headings to use. |
||
134 | * @param integer $stop level of headings to use. |
||
135 | * |
||
136 | * @return string with modified text. |
||
137 | */ |
||
138 | public function createAnchor4Header($text, $start = 1, $stop = 4) |
||
149 | |||
150 | |||
151 | |||
152 | /** |
||
153 | * Add baseurl to all relative links. |
||
154 | * |
||
155 | * @param string $text with content. |
||
156 | * @param string $baseurl as string to prepend relative link. |
||
157 | * @param callable $callback Use to create url from route. |
||
158 | * |
||
159 | * @return string with modified text. |
||
160 | */ |
||
161 | 2 | View Code Duplication | public function addBaseurlToRelativeLinks($text, $baseurl, $callback) |
174 | |||
175 | |||
176 | |||
177 | /** |
||
178 | * Add baseurl to all relative links in image source. |
||
179 | * |
||
180 | * @param string $text with content. |
||
181 | * @param string $baseurl as string to prepend relative link. |
||
182 | * @param callable $callback Use to create url from route. |
||
183 | * |
||
184 | * @return string with modified text. |
||
185 | */ |
||
186 | View Code Duplication | public function addBaseurlToImageSource($text, $baseurl, $callback) |
|
199 | |||
200 | |||
201 | |||
202 | /** |
||
203 | * Generate revision history and add to the end of content. |
||
204 | * |
||
205 | * @param string $text with content. |
||
206 | * @param array $revision with all revisions. |
||
207 | * @param string $start start wrap with this. |
||
208 | * @param string $end end wrap with this. |
||
209 | * @param string $class to add to ul element. |
||
210 | * @param string $source optional url to document source. |
||
211 | * |
||
212 | * @return string with text and optionally added revision history. |
||
213 | */ |
||
214 | public function addRevisionHistory($text, $revision, $start, $end, $class, $source = null) |
||
236 | |||
237 | |||
238 | |||
239 | /** |
||
240 | * Get content as pure text. |
||
241 | * |
||
242 | * @return string with the pure text. |
||
243 | */ |
||
244 | /* public function GetPureText() { |
||
245 | return preg_replace('/\s+/', ' ', strip_tags($this->GetFilteredData())); |
||
246 | } |
||
247 | */ |
||
248 | |||
249 | |||
250 | |||
251 | /** |
||
252 | * Returns the excerpt of the text with at most the specified amount of characters. |
||
253 | * |
||
254 | * @param int $chars the number of characters to return. |
||
255 | * @param boolean $hard do a hard break at exactly $chars characters or find closest space. |
||
256 | * @return string as the excerpt. |
||
257 | */ |
||
258 | /* public function GetExcerpt($chars=139, $hard=false) { |
||
259 | if(!isset($this->data['data_filtered'])) { |
||
260 | return null; |
||
261 | } |
||
262 | $excerpt = strip_tags($this->data['data_filtered']); |
||
263 | |||
264 | if(strlen($excerpt) > $chars) { |
||
265 | $excerpt = substr($excerpt, 0, $chars-1); |
||
266 | } |
||
267 | |||
268 | if(!$hard) { |
||
269 | $lastSpace = strrpos($excerpt, ' '); |
||
270 | $excerpt = substr($excerpt, 0, $lastSpace); |
||
271 | } |
||
272 | |||
273 | return $excerpt; |
||
274 | } |
||
275 | |||
276 | |||
277 | /** |
||
278 | * Returns the first paragraph ot the text. |
||
279 | * |
||
280 | * @return string as the first paragraph. |
||
281 | */ |
||
282 | /* public function GetFirstParagraph() { |
||
283 | if(!isset($this->data['data_filtered'])) { |
||
284 | return null; |
||
285 | } |
||
286 | $excerpt = $this->data['data_filtered']; |
||
287 | |||
288 | $firstPara = strpos($excerpt, '</p>'); |
||
289 | $excerpt = substr($excerpt, 0, $firstPara + 4); |
||
290 | |||
291 | return $excerpt; |
||
292 | } |
||
293 | */ |
||
294 | } |
||
295 |
There are different options of fixing this problem.
If you want to be on the safe side, you can add an additional type-check:
If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:
Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.