XoopsModules25x /
tools
| Conditions | 19 |
| Paths | 194 |
| Total Lines | 90 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 65 | public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true) |
||
| 66 | { |
||
| 67 | if ($considerHtml) { |
||
| 68 | // if the plain text is shorter than the maximum length, return the whole text |
||
| 69 | if (mb_strlen(preg_replace('/<.*?' . '>/', '', $text)) <= $length) { |
||
| 70 | return $text; |
||
| 71 | } |
||
| 72 | // splits all html-tags to scanable lines |
||
| 73 | preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, PREG_SET_ORDER); |
||
| 74 | $total_length = mb_strlen($ending); |
||
| 75 | $open_tags = []; |
||
| 76 | $truncate = ''; |
||
| 77 | foreach ($lines as $line_matchings) { |
||
|
|
|||
| 78 | // if there is any html-tag in this line, handle it and add it (uncounted) to the output |
||
| 79 | if (!empty($line_matchings[1])) { |
||
| 80 | // if it's an "empty element" with or without xhtml-conform closing slash |
||
| 81 | if (preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) { |
||
| 82 | // do nothing |
||
| 83 | // if tag is a closing tag |
||
| 84 | } elseif (preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) { |
||
| 85 | // delete tag from $open_tags list |
||
| 86 | $pos = array_search($tag_matchings[1], $open_tags, true); |
||
| 87 | if (false !== $pos) { |
||
| 88 | unset($open_tags[$pos]); |
||
| 89 | } |
||
| 90 | // if tag is an opening tag |
||
| 91 | } elseif (preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) { |
||
| 92 | // add tag to the beginning of $open_tags list |
||
| 93 | array_unshift($open_tags, mb_strtolower($tag_matchings[1])); |
||
| 94 | } |
||
| 95 | // add html-tag to $truncate'd text |
||
| 96 | $truncate .= $line_matchings[1]; |
||
| 97 | } |
||
| 98 | // calculate the length of the plain text part of the line; handle entities as one character |
||
| 99 | $content_length = mb_strlen(preg_replace('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2])); |
||
| 100 | if ($total_length + $content_length > $length) { |
||
| 101 | // the number of characters which are left |
||
| 102 | $left = $length - $total_length; |
||
| 103 | $entities_length = 0; |
||
| 104 | // search for html entities |
||
| 105 | if (preg_match_all('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', $line_matchings[2], $entities, PREG_OFFSET_CAPTURE)) { |
||
| 106 | // calculate the real length of all entities in the legal range |
||
| 107 | foreach ($entities[0] as $entity) { |
||
| 108 | if ($left >= $entity[1] + 1 - $entities_length) { |
||
| 109 | $left--; |
||
| 110 | $entities_length += mb_strlen($entity[0]); |
||
| 111 | } else { |
||
| 112 | // no more characters left |
||
| 113 | break; |
||
| 114 | } |
||
| 115 | } |
||
| 116 | } |
||
| 117 | $truncate .= mb_substr($line_matchings[2], 0, $left + $entities_length); |
||
| 118 | // maximum lenght is reached, so get off the loop |
||
| 119 | break; |
||
| 120 | } |
||
| 121 | $truncate .= $line_matchings[2]; |
||
| 122 | $total_length += $content_length; |
||
| 123 | |||
| 124 | // if the maximum length is reached, get off the loop |
||
| 125 | if ($total_length >= $length) { |
||
| 126 | break; |
||
| 127 | } |
||
| 128 | } |
||
| 129 | } else { |
||
| 130 | if (mb_strlen($text) <= $length) { |
||
| 131 | return $text; |
||
| 132 | } |
||
| 133 | $truncate = mb_substr($text, 0, $length - mb_strlen($ending)); |
||
| 134 | } |
||
| 135 | // if the words shouldn't be cut in the middle... |
||
| 136 | if (!$exact) { |
||
| 137 | // ...search the last occurance of a space... |
||
| 138 | $spacepos = mb_strrpos($truncate, ' '); |
||
| 139 | if (isset($spacepos)) { |
||
| 140 | // ...and cut the text in this position |
||
| 141 | $truncate = mb_substr($truncate, 0, $spacepos); |
||
| 142 | } |
||
| 143 | } |
||
| 144 | // add the defined ending to the text |
||
| 145 | $truncate .= $ending; |
||
| 146 | if ($considerHtml) { |
||
| 147 | // close all unclosed html-tags |
||
| 148 | foreach ($open_tags as $tag) { |
||
| 149 | $truncate .= '</' . $tag . '>'; |
||
| 150 | } |
||
| 151 | } |
||
| 152 | |||
| 153 | return $truncate; |
||
| 154 | } |
||
| 155 | |||
| 252 |
Loading history...
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.