| Total Complexity | 42 |
| Total Lines | 322 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like SysUtility 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 SysUtility, and based on these observations, apply Extract Interface, too.
| 1 | <?php declare(strict_types=1); |
||
| 35 | class SysUtility |
||
| 36 | { |
||
| 37 | use VersionChecks; |
||
|
|
|||
| 38 | use ServerStats; |
||
| 39 | use FilesManagement; |
||
| 40 | |||
| 41 | // Files Management Trait |
||
| 42 | //--------------- Custom module methods ----------------------------- |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @param $text |
||
| 46 | * @param $form_sort |
||
| 47 | * @return string |
||
| 48 | */ |
||
| 49 | public static function selectSorting($text, $form_sort) |
||
| 50 | { |
||
| 51 | global $start, $order, $file_cat, $sort, $xoopsModule; |
||
| 52 | $select_view = ''; |
||
| 53 | $moduleDirName = \basename(\dirname(__DIR__, 2)); |
||
| 54 | $helper = Helper::getInstance(); |
||
| 55 | // $pathModIcon16 = XOOPS_URL . '/modules/' . $moduleDirName . '/' . $helper->getModule()->getInfo('modicons16'); |
||
| 56 | $pathModIcon16 = $helper->url($helper->getModule()->getInfo('modicons16')); |
||
| 57 | $select_view = '<form name="form_switch" id="form_switch" action="' . Request::getString('REQUEST_URI', '', 'SERVER') . '" method="post"><span style="font-weight: bold;">' . $text . '</span>'; |
||
| 58 | //$sorts = $sort == 'asc' ? 'desc' : 'asc'; |
||
| 59 | if ($form_sort == $sort) { |
||
| 60 | $sel1 = 'asc' === $order ? 'selasc.png' : 'asc.png'; |
||
| 61 | $sel2 = 'desc' === $order ? 'seldesc.png' : 'desc.png'; |
||
| 62 | } else { |
||
| 63 | $sel1 = 'asc.png'; |
||
| 64 | $sel2 = 'desc.png'; |
||
| 65 | } |
||
| 66 | $select_view .= ' <a href="' . Request::getString('PHP_SELF', '', 'SERVER') . '?start=' . $start . '&sort=' . $form_sort . '&order=asc"><img src="' . $pathModIcon16 . '/' . $sel1 . '" title="ASC" alt="ASC"></a>'; |
||
| 67 | $select_view .= '<a href="' . Request::getString('PHP_SELF', '', 'SERVER') . '?start=' . $start . '&sort=' . $form_sort . '&order=desc"><img src="' . $pathModIcon16 . '/' . $sel2 . '" title="DESC" alt="DESC"></a>'; |
||
| 68 | $select_view .= '</form>'; |
||
| 69 | |||
| 70 | return $select_view; |
||
| 71 | } |
||
| 72 | |||
| 73 | /***************Blocks***************/ |
||
| 74 | |||
| 75 | /** |
||
| 76 | * @param array $cats |
||
| 77 | * @return string |
||
| 78 | */ |
||
| 79 | public static function blockAddCatSelect($cats) |
||
| 80 | { |
||
| 81 | $cat_sql = ''; |
||
| 82 | if (\is_array($cats) && !empty($cats)) { |
||
| 83 | $cat_sql = '(' . \current($cats); |
||
| 84 | \array_shift($cats); |
||
| 85 | foreach ($cats as $cat) { |
||
| 86 | $cat_sql .= ',' . $cat; |
||
| 87 | } |
||
| 88 | $cat_sql .= ')'; |
||
| 89 | } |
||
| 90 | |||
| 91 | return $cat_sql; |
||
| 92 | } |
||
| 93 | |||
| 94 | /** |
||
| 95 | * @param $content |
||
| 96 | */ |
||
| 97 | public static function metaKeywords($content): void |
||
| 98 | { |
||
| 99 | global $xoopsTpl, $xoTheme; |
||
| 100 | $myts = \MyTextSanitizer::getInstance(); |
||
| 101 | $content = $myts->undoHtmlSpecialChars($myts->displayTarea($content)); |
||
| 102 | if (\is_object($xoTheme)) { |
||
| 103 | $xoTheme->addMeta('meta', 'keywords', \strip_tags($content)); |
||
| 104 | } else { // Compatibility for old Xoops versions |
||
| 105 | $xoopsTpl->assign('xoops_metaKeywords', \strip_tags($content)); |
||
| 106 | } |
||
| 107 | } |
||
| 108 | |||
| 109 | /** |
||
| 110 | * @param $content |
||
| 111 | */ |
||
| 112 | public static function metaDescription($content): void |
||
| 121 | } |
||
| 122 | } |
||
| 123 | |||
| 124 | /** |
||
| 125 | * @param $tableName |
||
| 126 | * @param $columnName |
||
| 127 | * |
||
| 128 | * @return array |
||
| 129 | */ |
||
| 130 | public static function enumerate($tableName, $columnName) |
||
| 131 | { |
||
| 132 | $table = $GLOBALS['xoopsDB']->prefix($tableName); |
||
| 133 | // $result = $GLOBALS['xoopsDB']->query("SELECT COLUMN_TYPE FROM INFORMATION_SCHEMA.COLUMNS |
||
| 134 | // WHERE TABLE_NAME = '" . $table . "' AND COLUMN_NAME = '" . $columnName . "'") |
||
| 135 | // || exit ($GLOBALS['xoopsDB']->error()); |
||
| 136 | $sql = 'SELECT COLUMN_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = "' . $table . '" AND COLUMN_NAME = "' . $columnName . '"'; |
||
| 137 | $result = $GLOBALS['xoopsDB']->query($sql); |
||
| 138 | if (!$result) { |
||
| 139 | \trigger_error($GLOBALS['xoopsDB']->error()); |
||
| 140 | } |
||
| 141 | $row = $GLOBALS['xoopsDB']->fetchBoth($result); |
||
| 142 | $enumList = \explode(',', \str_replace("'", '', \mb_substr($row['COLUMN_TYPE'], 5, -6))); |
||
| 143 | |||
| 144 | return $enumList; |
||
| 145 | } |
||
| 146 | |||
| 147 | /** |
||
| 148 | * @param array|string $tableName |
||
| 149 | * @param string $id_field |
||
| 150 | * @param int $id |
||
| 151 | * |
||
| 152 | * @return mixed |
||
| 153 | */ |
||
| 154 | public static function cloneRecord($tableName, $id_field, $id) |
||
| 155 | { |
||
| 156 | $new_id = false; |
||
| 157 | $table = $GLOBALS['xoopsDB']->prefix($tableName); |
||
| 158 | // copy content of the record you wish to clone |
||
| 159 | $sql = "SELECT * FROM $table WHERE $id_field='$id' "; |
||
| 160 | $result = $GLOBALS['xoopsDB']->query($sql); |
||
| 161 | if (!$result) { |
||
| 162 | \trigger_error($GLOBALS['xoopsDB']->error()); |
||
| 163 | } |
||
| 164 | $tempTable = $GLOBALS['xoopsDB']->fetchArray($result, \MYSQLI_ASSOC); |
||
| 165 | |||
| 166 | // set the auto-incremented id's value to blank. |
||
| 167 | unset($tempTable[$id_field]); |
||
| 168 | // insert cloned copy of the original record |
||
| 169 | $sql = "INSERT INTO $table (" . \implode(', ', \array_keys($tempTable)) . ") VALUES ('" . \implode("', '", $tempTable) . "')"; |
||
| 170 | $result = $GLOBALS['xoopsDB']->queryF($sql); |
||
| 171 | if (!$result) { |
||
| 172 | \trigger_error($GLOBALS['xoopsDB']->error()); |
||
| 173 | } |
||
| 174 | |||
| 175 | // Return the new id |
||
| 176 | $new_id = $GLOBALS['xoopsDB']->getInsertId(); |
||
| 177 | |||
| 178 | return $new_id; |
||
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags |
||
| 183 | * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags |
||
| 184 | * www.cakephp.org |
||
| 185 | * |
||
| 186 | * @param string $text String to truncate. |
||
| 187 | * @param int $length Length of returned string, including ellipsis. |
||
| 188 | * @param string $ending Ending to be appended to the trimmed string. |
||
| 189 | * @param bool $exact If false, $text will not be cut mid-word |
||
| 190 | * @param bool $considerHtml If true, HTML tags would be handled correctly |
||
| 191 | * |
||
| 192 | * @return string Trimmed string. |
||
| 193 | */ |
||
| 194 | public static function truncateHtml($text, $length = 100, $ending = '...', $exact = false, $considerHtml = true) |
||
| 195 | { |
||
| 196 | $openTags = []; |
||
| 197 | if ($considerHtml) { |
||
| 198 | // if the plain text is shorter than the maximum length, return the whole text |
||
| 199 | if (\mb_strlen(\preg_replace('/<.*?' . '>/', '', $text)) <= $length) { |
||
| 200 | return $text; |
||
| 201 | } |
||
| 202 | // splits all html-tags to scanable lines |
||
| 203 | \preg_match_all('/(<.+?' . '>)?([^<>]*)/s', $text, $lines, \PREG_SET_ORDER); |
||
| 204 | $total_length = mb_strlen($ending); |
||
| 205 | //$openTags = []; |
||
| 206 | $truncate = ''; |
||
| 207 | foreach ($lines as $line_matchings) { |
||
| 208 | // if there is any html-tag in this line, handle it and add it (uncounted) to the output |
||
| 209 | if (!empty($line_matchings[1])) { |
||
| 210 | // if it's an "empty element" with or without xhtml-conform closing slash |
||
| 211 | if (\preg_match('/^<(\s*.+?\/\s*|\s*(img|br|input|hr|area|base|basefont|col|frame|isindex|link|meta|param)(\s.+?)?)>$/is', $line_matchings[1])) { |
||
| 212 | // do nothing |
||
| 213 | // if tag is a closing tag |
||
| 214 | } elseif (\preg_match('/^<\s*\/(\S+?)\s*>$/', $line_matchings[1], $tag_matchings)) { |
||
| 215 | // delete tag from $openTags list |
||
| 216 | $pos = \array_search($tag_matchings[1], $openTags, true); |
||
| 217 | if (false !== $pos) { |
||
| 218 | unset($openTags[$pos]); |
||
| 219 | } |
||
| 220 | // if tag is an opening tag |
||
| 221 | } elseif (\preg_match('/^<\s*([^\s>!]+).*?' . '>$/s', $line_matchings[1], $tag_matchings)) { |
||
| 222 | // add tag to the beginning of $openTags list |
||
| 223 | \array_unshift($openTags, \mb_strtolower($tag_matchings[1])); |
||
| 224 | } |
||
| 225 | // add html-tag to $truncate'd text |
||
| 226 | $truncate .= $line_matchings[1]; |
||
| 227 | } |
||
| 228 | // calculate the length of the plain text part of the line; handle entities as one character |
||
| 229 | $content_length = \mb_strlen(\preg_replace('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', ' ', $line_matchings[2])); |
||
| 230 | if ($total_length + $content_length > $length) { |
||
| 231 | // the number of characters which are left |
||
| 232 | $left = $length - $total_length; |
||
| 233 | $entities_length = 0; |
||
| 234 | // search for html entities |
||
| 235 | if (\preg_match_all('/&[0-9a-z]{2,8};|&#\d{1,7};|[0-9a-f]{1,6};/i', $line_matchings[2], $entities, \PREG_OFFSET_CAPTURE)) { |
||
| 236 | // calculate the real length of all entities in the legal range |
||
| 237 | foreach ($entities[0] as $entity) { |
||
| 238 | if ($left >= $entity[1] + 1 - $entities_length) { |
||
| 239 | $left--; |
||
| 240 | $entities_length += \mb_strlen($entity[0]); |
||
| 241 | } else { |
||
| 242 | // no more characters left |
||
| 243 | break; |
||
| 244 | } |
||
| 245 | } |
||
| 246 | } |
||
| 247 | $truncate .= \mb_substr($line_matchings[2], 0, $left + $entities_length); |
||
| 248 | // maximum lenght is reached, so get off the loop |
||
| 249 | break; |
||
| 250 | } |
||
| 251 | $truncate .= $line_matchings[2]; |
||
| 252 | $total_length += $content_length; |
||
| 253 | // if the maximum length is reached, get off the loop |
||
| 254 | if ($total_length >= $length) { |
||
| 255 | break; |
||
| 256 | } |
||
| 257 | } |
||
| 258 | } elseif (\mb_strlen($text) <= $length) { |
||
| 259 | return $text; |
||
| 260 | } |
||
| 261 | $truncate = \mb_substr($text, 0, $length - \mb_strlen($ending)); |
||
| 262 | // if the words shouldn't be cut in the middle... |
||
| 263 | if (!$exact) { |
||
| 264 | // ...search the last occurance of a space... |
||
| 265 | $spacepos = \mb_strrpos($truncate, ' '); |
||
| 266 | if (isset($spacepos)) { |
||
| 267 | // ...and cut the text in this position |
||
| 268 | $truncate = \mb_substr($truncate, 0, $spacepos); |
||
| 269 | } |
||
| 270 | } |
||
| 271 | // add the defined ending to the text |
||
| 272 | $truncate .= $ending; |
||
| 273 | if ($considerHtml) { |
||
| 274 | // close all unclosed html-tags |
||
| 275 | foreach ($openTags as $tag) { |
||
| 276 | $truncate .= '</' . $tag . '>'; |
||
| 277 | } |
||
| 278 | } |
||
| 279 | |||
| 280 | return $truncate; |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * @param \Xmf\Module\Helper $helper |
||
| 285 | * @param array|null $options |
||
| 286 | * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor |
||
| 287 | */ |
||
| 288 | public static function getEditor( |
||
| 341 | } |
||
| 342 | |||
| 343 | /** |
||
| 344 | * @param $fieldname |
||
| 345 | * @param $table |
||
| 346 | * |
||
| 347 | * @return bool |
||
| 348 | */ |
||
| 349 | public function fieldExists( |
||
| 357 | } |
||
| 358 | } |
||
| 359 |