ggoffy /
wgevents
| Total Complexity | 46 |
| Total Lines | 271 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Utility often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Utility, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 34 | class Utility |
||
| 35 | { |
||
| 36 | use Common\VersionChecks; |
||
|
introduced
by
|
|||
| 37 | |||
| 38 | //checkVerXoops, checkVerPhp Traits |
||
| 39 | |||
| 40 | use Common\ServerStats; |
||
| 41 | |||
| 42 | // getServerStats Trait |
||
| 43 | |||
| 44 | use Common\FilesManagement; |
||
| 45 | |||
| 46 | // Files Management Trait |
||
| 47 | |||
| 48 | /** |
||
| 49 | * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags |
||
| 50 | * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags |
||
| 51 | * www.cakephp.org |
||
| 52 | * |
||
| 53 | * @param string $text String to truncate. |
||
| 54 | * @param int $length Length of returned string, including ellipsis. |
||
| 55 | * @param string $ending Ending to be appended to the trimmed string. |
||
| 56 | * @param bool $exact If false, $text will not be cut mid-word |
||
| 57 | * @param bool $considerHtml If true, HTML tags would be handled correctly |
||
| 58 | * |
||
| 59 | * @return string Trimmed string. |
||
| 60 | */ |
||
| 61 | public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true) |
||
| 62 | { |
||
| 63 | if ($considerHtml) { |
||
| 64 | // if the plain text is shorter than the maximum length, return the whole text |
||
| 65 | if (\mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) { |
||
| 66 | return $text; |
||
| 67 | } |
||
| 68 | // splits all html-tags to scanable lines |
||
| 69 | \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER); |
||
| 70 | $total_length = \mb_strlen($ending); |
||
| 71 | $open_tags = []; |
||
| 72 | $truncate = ''; |
||
| 73 | foreach ($lines as $line_matchings) { |
||
| 74 | // if there is any html-tag in this line, handle it and add it (uncounted) to the output |
||
| 75 | if (!empty($line_matchings[1])) { |
||
| 76 | // if it's an "empty element" with or without xhtml-conform closing slash |
||
| 77 | if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) { |
||
| 78 | // do nothing |
||
| 79 | // if tag is a closing tag |
||
| 80 | } elseif (\preg_match('/^<\s*\/([^\s]+?)\s*>$/s', $line_matchings[1], $tag_matchings)) { |
||
| 81 | // delete tag from $open_tags list |
||
| 82 | $pos = \array_search($tag_matchings[1], $open_tags, true); |
||
| 83 | if (false !== $pos) { |
||
| 84 | unset($open_tags[$pos]); |
||
| 85 | } |
||
| 86 | // if tag is an opening tag |
||
| 87 | } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) { |
||
| 88 | // add tag to the beginning of $open_tags list |
||
| 89 | \array_unshift($open_tags, \mb_strtolower($tag_matchings[1])); |
||
| 90 | } |
||
| 91 | // add html-tag to $truncate'd text |
||
| 92 | $truncate .= $line_matchings[1]; |
||
| 93 | } |
||
| 94 | // calculate the length of the plain text part of the line; handle entities as one character |
||
| 95 | $content_length = \mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#[0-9]{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2])); |
||
| 96 | if ($total_length + $content_length > $length) { |
||
| 97 | // the number of characters which are left |
||
| 98 | $left = $length - $total_length; |
||
| 99 | $entities_length = 0; |
||
| 100 | // search for html entities |
||
| 101 | 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)) { |
||
| 102 | // calculate the real length of all entities in the legal range |
||
| 103 | foreach ($entities[0] as $entity) { |
||
| 104 | if ($left >= $entity[1] + 1 - $entities_length) { |
||
| 105 | $left--; |
||
| 106 | $entities_length += \mb_strlen($entity[0]); |
||
| 107 | } else { |
||
| 108 | // no more characters left |
||
| 109 | break; |
||
| 110 | } |
||
| 111 | } |
||
| 112 | } |
||
| 113 | $truncate .= \mb_substr($line_matchings[2], 0, $left + $entities_length); |
||
| 114 | // maximum lenght is reached, so get off the loop |
||
| 115 | break; |
||
| 116 | } |
||
| 117 | $truncate .= $line_matchings[2]; |
||
| 118 | $total_length += $content_length; |
||
| 119 | |||
| 120 | // if the maximum length is reached, get off the loop |
||
| 121 | if ($total_length >= $length) { |
||
| 122 | break; |
||
| 123 | } |
||
| 124 | } |
||
| 125 | } else { |
||
| 126 | if (\mb_strlen($text) <= $length) { |
||
| 127 | return $text; |
||
| 128 | } |
||
| 129 | $truncate = \mb_substr($text, 0, $length - \mb_strlen($ending)); |
||
| 130 | } |
||
| 131 | // if the words shouldn't be cut in the middle... |
||
| 132 | if (!$exact) { |
||
| 133 | // ...search the last occurance of a space... |
||
| 134 | $spacepos = \mb_strrpos($truncate, ' '); |
||
| 135 | if (isset($spacepos)) { |
||
| 136 | // ...and cut the text in this position |
||
| 137 | $truncate = \mb_substr($truncate, 0, $spacepos); |
||
| 138 | } |
||
| 139 | } |
||
| 140 | // add the defined ending to the text |
||
| 141 | if ('' != $truncate) { |
||
| 142 | $truncate .= $ending; |
||
| 143 | } |
||
| 144 | if ($considerHtml) { |
||
| 145 | // close all unclosed html-tags |
||
| 146 | foreach ($open_tags as $tag) { |
||
| 147 | $truncate .= '</' . $tag . '>'; |
||
| 148 | } |
||
| 149 | } |
||
| 150 | |||
| 151 | return $truncate; |
||
| 152 | } |
||
| 153 | |||
| 154 | /** |
||
| 155 | * @public function to convert float into string |
||
| 156 | * @param float $float |
||
| 157 | * @return string |
||
| 158 | */ |
||
| 159 | public static function FloatToString($float) { |
||
| 166 | |||
| 167 | } |
||
| 168 | |||
| 169 | /** |
||
| 170 | * @public function to convert string into float |
||
| 171 | * @param string $str |
||
| 172 | * @return float |
||
| 173 | */ |
||
| 174 | public static function StringToFloat($str) { |
||
| 175 | |||
| 176 | $helper = \XoopsModules\Wgevents\Helper::getInstance(); |
||
| 177 | $dec = $helper->getConfig('sep_comma'); |
||
| 178 | $thnd = $helper->getConfig('sep_thousand'); |
||
| 179 | |||
| 180 | $str = \preg_replace('[^0-9\,\.\-\+]', '', (string)$str); |
||
| 181 | $str = \str_replace([$thnd, ' '], '', $str); |
||
| 182 | $str = \str_replace($dec, '.', $str); |
||
| 183 | |||
| 184 | return (float)$str; |
||
| 185 | |||
| 186 | } |
||
| 187 | |||
| 188 | /** |
||
| 189 | * @public function to get text of status |
||
| 190 | * @param $status |
||
| 191 | * @return string |
||
| 192 | */ |
||
| 193 | public static function getStatusText($status) |
||
| 236 | |||
| 237 | } |
||
| 238 | |||
| 239 | /** |
||
| 240 | * @public function to get text of salutation |
||
| 241 | * @param $salutation |
||
| 242 | * @return string |
||
| 243 | */ |
||
| 244 | public static function getSalutationText($salutation) |
||
| 245 | { |
||
| 246 | switch ($salutation) { |
||
| 247 | case Constants::SALUTATION_NONE: |
||
| 248 | default: |
||
| 249 | $salutation_text = ''; |
||
| 250 | break; |
||
| 251 | case Constants::SALUTATION_MEN: |
||
| 252 | $salutation_text = \_MA_WGEVENTS_REGISTRATION_SALUTATION_MEN; |
||
| 253 | break; |
||
| 254 | case Constants::SALUTATION_WOMEN: |
||
| 255 | $salutation_text = \_MA_WGEVENTS_REGISTRATION_SALUTATION_WOMEN; |
||
| 256 | break; |
||
| 257 | } |
||
| 258 | |||
| 259 | return $salutation_text; |
||
| 260 | |||
| 261 | } |
||
| 262 | |||
| 263 | /** |
||
| 264 | * @public function to get text of salutation |
||
| 265 | * @param $financial |
||
| 266 | * @return string |
||
| 267 | */ |
||
| 268 | public static function getFinancialText($financial) |
||
| 269 | { |
||
| 270 | switch ($financial) { |
||
| 271 | case Constants::FINANCIAL_UNPAID: |
||
| 272 | $financial_text = \_MA_WGEVENTS_REGISTRATION_FINANCIAL_UNPAID; |
||
| 273 | break; |
||
| 274 | case Constants::FINANCIAL_PAID: |
||
| 275 | $financial_text = \_MA_WGEVENTS_REGISTRATION_FINANCIAL_PAID; |
||
| 276 | break; |
||
| 277 | case -1: |
||
| 278 | default: |
||
| 279 | $financial_text = 'Invalid financial'; |
||
| 280 | break; |
||
| 281 | } |
||
| 282 | |||
| 283 | return $financial_text; |
||
| 284 | |||
| 285 | } |
||
| 286 | |||
| 287 | /** |
||
| 288 | * @public function to get text of waiting list |
||
| 289 | * @param $listwait |
||
| 290 | * @return string |
||
| 291 | */ |
||
| 292 | public static function getListWaitText($listwait) |
||
| 305 | |||
| 306 | } |
||
| 307 | } |
||
| 308 |
Loading history...