mambax7 /
adslight
| Total Complexity | 50 |
| Total Lines | 381 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 1 | Features | 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 |
||
| 36 | class SysUtility |
||
| 37 | { |
||
| 38 | use VersionChecks; |
||
|
introduced
by
|
|||
| 39 | |||
| 40 | //checkVerXoops, checkVerPhp Traits |
||
| 41 | |||
| 42 | use ServerStats; |
||
| 43 | |||
| 44 | // getServerStats Trait |
||
| 45 | |||
| 46 | use FilesManagement; |
||
| 47 | |||
| 48 | // Files Management Trait |
||
| 49 | // use ModuleStats; // ModuleStats Trait |
||
| 50 | |||
| 51 | //--------------- Common module methods ----------------------------- |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Access the only instance of this class |
||
| 55 | */ |
||
| 56 | public static function getInstance(): self |
||
| 57 | { |
||
| 58 | static $instance; |
||
| 59 | if (null === $instance) { |
||
| 60 | $instance = new static(); |
||
| 61 | } |
||
| 62 | |||
| 63 | return $instance; |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @param $text |
||
| 68 | * @param $form_sort |
||
| 69 | */ |
||
| 70 | public static function selectSorting($text, $form_sort): string |
||
| 71 | { |
||
| 72 | global $start, $order, $sort; |
||
| 73 | |||
| 74 | $select_view = ''; |
||
| 75 | $moduleDirName = \basename(\dirname(__DIR__)); |
||
| 76 | $helper = Helper::getInstance(); |
||
| 77 | |||
| 78 | //$pathModIcon16 = XOOPS_URL . '/modules/' . $moduleDirName . '/' . $helper->getConfig('modicons16'); |
||
| 79 | $pathModIcon16 = $helper->url($helper->getModule()->getInfo('modicons16')); |
||
| 80 | |||
| 81 | $select_view = '<form name="form_switch" id="form_switch" action="' . Request::getString('REQUEST_URI', '', 'SERVER') . '" method="post"><span style="font-weight: bold;">' . $text . '</span>'; |
||
| 82 | //$sorts = $sort == 'asc' ? 'desc' : 'asc'; |
||
| 83 | if ($form_sort === $sort) { |
||
| 84 | $sel1 = 'asc' === $order ? 'selasc.png' : 'asc.png'; |
||
| 85 | $sel2 = 'desc' === $order ? 'seldesc.png' : 'desc.png'; |
||
| 86 | } else { |
||
| 87 | $sel1 = 'asc.png'; |
||
| 88 | $sel2 = 'desc.png'; |
||
| 89 | } |
||
| 90 | $select_view .= ' <a href="' . Request::getString('SCRIPT_NAME', '', 'SERVER') . '?start=' . $start . '&sort=' . $form_sort . '&order=asc"><img src="' . $pathModIcon16 . '/' . $sel1 . '" title="ASC" alt="ASC"></a>'; |
||
| 91 | $select_view .= '<a href="' . Request::getString('SCRIPT_NAME', '', 'SERVER') . '?start=' . $start . '&sort=' . $form_sort . '&order=desc"><img src="' . $pathModIcon16 . '/' . $sel2 . '" title="DESC" alt="DESC"></a>'; |
||
| 92 | $select_view .= '</form>'; |
||
| 93 | |||
| 94 | return $select_view; |
||
| 95 | } |
||
| 96 | |||
| 97 | /***************Blocks***************/ |
||
| 98 | |||
| 99 | public static function blockAddCatSelect(array $cats): string |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * @param $content |
||
| 116 | */ |
||
| 117 | public static function metaKeywords($content): void |
||
| 118 | { |
||
| 119 | global $xoopsTpl, $xoTheme; |
||
| 120 | $myts = \MyTextSanitizer::getInstance(); |
||
| 121 | $content = $myts->undoHtmlSpecialChars($myts->displayTarea($content)); |
||
| 122 | if (\is_object($xoTheme)) { |
||
| 123 | $xoTheme->addMeta('meta', 'keywords', \strip_tags($content)); |
||
| 124 | } else { // Compatibility for old Xoops versions |
||
| 125 | $xoopsTpl->assign('xoops_metaKeywords', \strip_tags($content)); |
||
| 126 | } |
||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * @param $content |
||
| 131 | */ |
||
| 132 | public static function metaDescription($content): void |
||
| 133 | { |
||
| 134 | global $xoopsTpl, $xoTheme; |
||
| 135 | $myts = \MyTextSanitizer::getInstance(); |
||
| 136 | $content = $myts->undoHtmlSpecialChars($myts->displayTarea($content)); |
||
| 137 | if (\is_object($xoTheme)) { |
||
| 138 | $xoTheme->addMeta('meta', 'description', \strip_tags($content)); |
||
| 139 | } else { // Compatibility for old Xoops versions |
||
| 140 | $xoopsTpl->assign('xoops_metaDescription', \strip_tags($content)); |
||
| 141 | } |
||
| 142 | } |
||
| 143 | |||
| 144 | /** |
||
| 145 | * @return array|false |
||
| 146 | */ |
||
| 147 | public static function enumerate(string $tableName, string $columnName) |
||
| 148 | { |
||
| 149 | $table = $GLOBALS['xoopsDB']->prefix($tableName); |
||
| 150 | |||
| 151 | // $result = $GLOBALS['xoopsDB']->query("SELECT COLUMN_TYPE FROM INFORMATION_SCHEMA.COLUMNS |
||
| 152 | // WHERE TABLE_NAME = '" . $table . "' AND COLUMN_NAME = '" . $columnName . "'") |
||
| 153 | // || exit ($GLOBALS['xoopsDB']->error()); |
||
| 154 | |||
| 155 | $sql = 'SELECT COLUMN_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = "' . $table . '" AND COLUMN_NAME = "' . $columnName . '"'; |
||
| 156 | $result = $GLOBALS['xoopsDB']->query($sql); |
||
| 157 | if (!$result) { |
||
| 158 | // exit($GLOBALS['xoopsDB']->error()); |
||
| 159 | $logger = \XoopsLogger::getInstance(); |
||
| 160 | $logger->handleError(\E_USER_WARNING, $sql, __FILE__, __LINE__); |
||
| 161 | return false; |
||
| 162 | } |
||
| 163 | |||
| 164 | $row = $GLOBALS['xoopsDB']->fetchBoth($result); |
||
| 165 | return \explode(',', \str_replace("'", '', \mb_substr($row['COLUMN_TYPE'], 5, -6))); |
||
| 166 | } |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Clone a record in a dB |
||
| 170 | * |
||
| 171 | * @TODO need to exit more gracefully on error. Should throw/trigger error and then return false |
||
| 172 | * |
||
| 173 | * @param string $tableName name of dB table (without prefix) |
||
| 174 | * @param string $idField name of field (column) in dB table |
||
| 175 | * @param int $id item id to clone |
||
| 176 | */ |
||
| 177 | public static function cloneRecord(string $tableName, string $idField, int $id): void |
||
| 178 | { |
||
| 179 | $newId = false; |
||
| 180 | $table = $GLOBALS['xoopsDB']->prefix($tableName); |
||
| 181 | // copy content of the record you wish to clone |
||
| 182 | $sql = "SELECT * FROM ${table} WHERE ${idField}='" . $id . "' "; |
||
| 183 | $tempTable = $GLOBALS['xoopsDB']->fetchArray($GLOBALS['xoopsDB']->query($sql), \MYSQLI_ASSOC); |
||
| 184 | if (!$tempTable) { |
||
| 185 | exit($GLOBALS['xoopsDB']->error()); |
||
| 186 | } |
||
| 187 | // set the auto-incremented id's value to blank. |
||
| 188 | unset($tempTable[$idField]); |
||
| 189 | // insert cloned copy of the original record |
||
| 190 | $sql = "INSERT INTO ${table} (" . \implode(', ', \array_keys($tempTable)) . ") VALUES ('" . \implode("', '", $tempTable) . "')"; |
||
| 191 | $result = $GLOBALS['xoopsDB']->queryF($sql); |
||
| 192 | if (!$result) { |
||
| 193 | exit($GLOBALS['xoopsDB']->error()); |
||
| 194 | } |
||
| 195 | // Return the new id |
||
| 196 | return $GLOBALS['xoopsDB']->getInsertId(); |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * truncateHtml can truncate a string up to a number of characters while preserving whole words and HTML tags |
||
| 201 | * www.gsdesign.ro/blog/cut-html-string-without-breaking-the-tags |
||
| 202 | * www.cakephp.org |
||
| 203 | * |
||
| 204 | * @TODO: Refactor to consider HTML5 & void (self-closing) elements |
||
| 205 | * @TODO: Consider using https://github.com/jlgrall/truncateHTML/blob/master/truncateHTML.php |
||
| 206 | * |
||
| 207 | * @param string $text String to truncate. |
||
| 208 | * @param int|null $length Length of returned string, including ellipsis. |
||
| 209 | * @param string|null $ending Ending to be appended to the trimmed string. |
||
| 210 | * @param bool $exact If false, $text will not be cut mid-word |
||
| 211 | * @param bool $considerHtml If true, HTML tags would be handled correctly |
||
| 212 | * |
||
| 213 | * @return string Trimmed string. |
||
| 214 | */ |
||
| 215 | public static function truncateHtml( |
||
| 310 | } |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Get correct text editor based on user rights |
||
| 314 | * |
||
| 315 | * @param \Xmf\Module\Helper|null $helper |
||
| 316 | * @param array|null $options |
||
| 317 | * @return \XoopsFormDhtmlTextArea|\XoopsFormEditor |
||
| 318 | */ |
||
| 319 | public static function getEditor(?\Xmf\Module\Helper $helper = null, ?array $options = null) |
||
| 320 | { |
||
| 321 | /** @var Helper $helper */ |
||
| 322 | if (null === $options) { |
||
| 323 | $options = []; |
||
| 324 | $options['name'] = 'Editor'; |
||
| 325 | $options['value'] = 'Editor'; |
||
| 326 | $options['rows'] = 10; |
||
| 327 | $options['cols'] = '100%'; |
||
| 328 | $options['width'] = '100%'; |
||
| 329 | $options['height'] = '400px'; |
||
| 330 | } |
||
| 331 | |||
| 332 | if (null === $helper) { |
||
| 333 | $helper = Helper::getInstance(); |
||
| 334 | } |
||
| 335 | |||
| 336 | $isAdmin = $helper->isUserAdmin(); |
||
| 337 | |||
| 338 | if (\class_exists('XoopsFormEditor')) { |
||
| 339 | if ($isAdmin) { |
||
| 340 | $descEditor = new XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorAdmin'), $options, $nohtml = false, $onfailure = 'textarea'); |
||
| 341 | } else { |
||
| 342 | $descEditor = new XoopsFormEditor(\ucfirst($options['name']), $helper->getConfig('editorUser'), $options, $nohtml = false, $onfailure = 'textarea'); |
||
| 343 | } |
||
| 344 | } else { |
||
| 345 | $descEditor = new \XoopsFormDhtmlTextArea(\ucfirst($options['name']), $options['name'], $options['value'], '100%', '100%'); |
||
| 346 | } |
||
| 347 | |||
| 348 | // $form->addElement($descEditor); |
||
| 349 | |||
| 350 | return $descEditor; |
||
| 351 | } |
||
| 352 | |||
| 353 | /** |
||
| 354 | * Check if column in dB table exists |
||
| 355 | * |
||
| 356 | * @param string $fieldname name of dB table field |
||
| 357 | * @param string $table name of dB table (including prefix) |
||
| 358 | * |
||
| 359 | * @return bool true if table exists |
||
| 360 | * @deprecated |
||
| 361 | */ |
||
| 362 | public static function fieldExists(string $fieldname, string $table): bool |
||
| 363 | { |
||
| 364 | $trace = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 1); |
||
| 365 | \trigger_error(__METHOD__ . " is deprecated, use Xmf\Database\Tables instead - instantiated from {$trace[0]['file']} line {$trace[0]['line']},"); |
||
| 366 | |||
| 367 | $result = $GLOBALS['xoopsDB']->queryF("SHOW COLUMNS FROM ${table} LIKE '${fieldname}'"); |
||
| 368 | return $GLOBALS['xoopsDB']->getRowsNum($result) > 0; |
||
| 369 | } |
||
| 370 | |||
| 371 | /** |
||
| 372 | * Function responsible for checking if a directory exists, we can also write in and create an index.html file |
||
| 373 | * |
||
| 374 | * @param string $folder The full path of the directory to check |
||
| 375 | */ |
||
| 376 | public static function prepareFolder(string $folder): void |
||
| 377 | { |
||
| 378 | try { |
||
| 379 | if (!@\mkdir($folder) && !\is_dir($folder)) { |
||
| 380 | throw new \RuntimeException(\sprintf('Unable to create the %s directory', $folder)); |
||
| 381 | } |
||
| 382 | file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>'); |
||
| 383 | } catch (\Throwable $e) { |
||
| 384 | echo 'Caught exception: ', $e->getMessage(), "\n", '<br>'; |
||
| 385 | } |
||
| 386 | } |
||
| 387 | |||
| 388 | /** |
||
| 389 | * Check if dB table table exists |
||
| 390 | * |
||
| 391 | * @param string $tablename dB tablename with prefix |
||
| 392 | * @return bool true if table exists |
||
| 393 | */ |
||
| 394 | public static function tableExists(string $tablename): bool |
||
| 395 | { |
||
| 396 | $trace = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 1); |
||
| 397 | \trigger_error(__FUNCTION__ . " is deprecated, called from {$trace[0]['file']} line {$trace[0]['line']}"); |
||
| 398 | $GLOBALS['xoopsLogger']->addDeprecated( |
||
| 399 | \basename(\dirname(__DIR__, 2)) . ' Module: ' . __FUNCTION__ . ' function is deprecated, please use Xmf\Database\Tables method(s) instead.' . " Called from {$trace[0]['file']}line {$trace[0]['line']}" |
||
| 400 | ); |
||
| 401 | $result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '${tablename}'"); |
||
| 402 | |||
| 403 | return $GLOBALS['xoopsDB']->getRowsNum($result) > 0; |
||
| 404 | } |
||
| 405 | |||
| 406 | /** |
||
| 407 | * Add a field to a mysql table |
||
| 408 | * |
||
| 409 | * @param $field |
||
| 410 | * @param $table |
||
| 411 | * @return bool|\mysqli_result |
||
| 412 | */ |
||
| 413 | public static function addField($field, $table) |
||
| 417 | } |
||
| 418 | } |
||
| 419 |
Loading history...