XoopsModules25x /
xoopstube
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:
Complex classes like XoopstubeUtilities 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 XoopstubeUtilities, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 36 | class XoopstubeUtilities |
||
| 37 | { |
||
| 38 | |||
| 39 | const MODULE_NAME = 'xoopstube'; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * Access the only instance of this class |
||
| 43 | * |
||
| 44 | * @return object |
||
| 45 | * |
||
| 46 | * @static |
||
| 47 | * @staticvar object |
||
| 48 | */ |
||
| 49 | public function getInstance() |
||
| 58 | |||
| 59 | /** |
||
| 60 | * Returns a module's option (with cache) |
||
| 61 | * |
||
| 62 | * @param string $option module option's name |
||
| 63 | * @param boolean $withCache Do we have to use some cache ? |
||
| 64 | * |
||
| 65 | * @return mixed option's value |
||
| 66 | */ |
||
| 67 | public static function getModuleOption($option, $withCache = true) |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Is Xoops 2.3.x ? |
||
| 99 | * |
||
| 100 | * @return boolean |
||
| 101 | */ |
||
| 102 | View Code Duplication | public function isX23() |
|
| 112 | |||
| 113 | /** |
||
| 114 | * Is Xoops 2.0.x ? |
||
| 115 | * |
||
| 116 | * @return boolean |
||
| 117 | */ |
||
| 118 | View Code Duplication | public static function isX20() |
|
| 128 | |||
| 129 | /** |
||
| 130 | * Create (in a link) a javascript confirmation's box |
||
| 131 | * |
||
| 132 | * @param string $message Message to display |
||
| 133 | * @param boolean $form Is this a confirmation for a form ? |
||
| 134 | * |
||
| 135 | * @return string the javascript code to insert in the link (or in the form) |
||
| 136 | */ |
||
| 137 | public static function javascriptLinkConfirm($message, $form = false) |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Get current user IP |
||
| 148 | * |
||
| 149 | * @return string IP address (format Ipv4) |
||
| 150 | */ |
||
| 151 | public static function IP() |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Set the page's title, meta description and meta keywords |
||
| 182 | * Datas are supposed to be sanitized |
||
| 183 | * |
||
| 184 | * @param string $pageTitle Page's Title |
||
| 185 | * @param string $metaDescription Page's meta description |
||
| 186 | * @param string $metaKeywords Page's meta keywords |
||
| 187 | * |
||
| 188 | * @return void |
||
| 189 | */ |
||
| 190 | public static function setMetas($pageTitle = '', $metaDescription = '', $metaKeywords = '') |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Send an email from a template to a list of recipients |
||
| 213 | * |
||
| 214 | * @param $tplName |
||
| 215 | * @param array $recipients List of recipients |
||
| 216 | * @param string $subject Email's subject |
||
| 217 | * @param array $variables Varirables to give to the template |
||
| 218 | * |
||
| 219 | * @internal param string $tpl_name Template's name |
||
| 220 | * @return boolean Result of the send |
||
| 221 | */ |
||
| 222 | public static function sendEmailFromTpl($tplName, $recipients, $subject, $variables) |
||
| 284 | |||
| 285 | /** |
||
| 286 | * Remove module's cache |
||
| 287 | */ |
||
| 288 | public static function updateCache() |
||
| 314 | |||
| 315 | /** |
||
| 316 | * Redirect user with a message |
||
| 317 | * |
||
| 318 | * @param string $message message to display |
||
| 319 | * @param string $url The place where to go |
||
| 320 | * @param integer timeout Time to wait before to redirect |
||
| 321 | */ |
||
| 322 | public static function redirect($message = '', $url = 'index.php', $time = 2) |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Internal function used to get the handler of the current module |
||
| 330 | * |
||
| 331 | * @return object The module |
||
| 332 | */ |
||
| 333 | protected function _getModule() |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Returns the module's name (as defined by the user in the module manager) with cache |
||
| 351 | * |
||
| 352 | * @return string Module's name |
||
| 353 | */ |
||
| 354 | public static function getModuleName() |
||
| 364 | |||
| 365 | /** |
||
| 366 | * Create a title for the href tags inside html links |
||
| 367 | * |
||
| 368 | * @param string $title Text to use |
||
| 369 | * |
||
| 370 | * @return string Formated text |
||
| 371 | */ |
||
| 372 | public static function makeHrefTitle($title) |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Retourne la liste des utilisateurs appartenants à un groupe |
||
| 382 | * |
||
| 383 | * @param int $groupId Searched group |
||
| 384 | * |
||
| 385 | * @return array Array of XoopsUsers |
||
| 386 | */ |
||
| 387 | public function getUsersFromGroup($groupId) |
||
| 395 | |||
| 396 | /** |
||
| 397 | * Retourne la liste des emails des utilisateurs membres d'un groupe |
||
| 398 | * |
||
| 399 | * @param $groupId |
||
| 400 | * |
||
| 401 | * @internal param int $group_id Group's number |
||
| 402 | * @return array Emails list |
||
| 403 | */ |
||
| 404 | public static function getEmailsFromGroup($groupId) |
||
| 414 | |||
| 415 | /** |
||
| 416 | * Vérifie que l'utilisateur courant fait partie du groupe des administrateurs |
||
| 417 | * |
||
| 418 | * @return booleean Admin or not |
||
| 419 | */ |
||
| 420 | public static function isAdmin() |
||
| 433 | |||
| 434 | /** |
||
| 435 | * Returns the current date in the Mysql format |
||
| 436 | * |
||
| 437 | * @return string Date in the Mysql format |
||
| 438 | */ |
||
| 439 | public static function getCurrentSQLDate() |
||
| 443 | |||
| 444 | /** |
||
| 445 | * @return bool|string |
||
| 446 | */ |
||
| 447 | public function getCurrentSQLDateTime() |
||
| 451 | |||
| 452 | /** |
||
| 453 | * Convert a Mysql date to the human's format |
||
| 454 | * |
||
| 455 | * @param string $date The date to convert |
||
| 456 | * @param string $format |
||
| 457 | * |
||
| 458 | * @return string The date in a human form |
||
| 459 | */ |
||
| 460 | public function SQLDateToHuman($date, $format = 'l') |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Convert a timestamp to a Mysql date |
||
| 471 | * |
||
| 472 | * @param integer $timestamp The timestamp to use |
||
| 473 | * |
||
| 474 | * @return string The date in the Mysql format |
||
| 475 | */ |
||
| 476 | public function timestampToMysqlDate($timestamp) |
||
| 480 | |||
| 481 | /** |
||
| 482 | * Conversion d'un dateTime Mysql en date lisible en français |
||
| 483 | * |
||
| 484 | * @param $dateTime |
||
| 485 | * |
||
| 486 | * @return bool|string |
||
| 487 | */ |
||
| 488 | public function sqlDateTimeToFrench($dateTime) |
||
| 492 | |||
| 493 | /** |
||
| 494 | * Convert a timestamp to a Mysql datetime form |
||
| 495 | * |
||
| 496 | * @param integer $timestamp The timestamp to use |
||
| 497 | * |
||
| 498 | * @return string The date and time in the Mysql format |
||
| 499 | */ |
||
| 500 | public function timestampToMysqlDateTime($timestamp) |
||
| 504 | |||
| 505 | /** |
||
| 506 | * This function indicates if the current Xoops version needs to add asterisks to required fields in forms |
||
| 507 | * |
||
| 508 | * @return boolean Yes = we need to add them, false = no |
||
| 509 | */ |
||
| 510 | public function needsAsterisk() |
||
| 527 | |||
| 528 | /** |
||
| 529 | * Mark the mandatory fields of a form with a star |
||
| 530 | * |
||
| 531 | * @param object $sform The form to modify |
||
| 532 | * |
||
| 533 | * @internal param string $caracter The character to use to mark fields |
||
| 534 | * @return object The modified form |
||
| 535 | */ |
||
| 536 | public static function &formMarkRequiredFields(&$sform) |
||
| 556 | |||
| 557 | /** |
||
| 558 | * Create an html heading (from h1 to h6) |
||
| 559 | * |
||
| 560 | * @param string $title The text to use |
||
| 561 | * @param integer $level Level to return |
||
| 562 | * |
||
| 563 | * @return string The heading |
||
| 564 | */ |
||
| 565 | public static function htitle($title = '', $level = 1) |
||
| 569 | |||
| 570 | /** |
||
| 571 | * Create a unique upload filename |
||
| 572 | * |
||
| 573 | * @param string $folder The folder where the file will be saved |
||
| 574 | * @param string $fileName Original filename (coming from the user) |
||
| 575 | * @param boolean $trimName Do we need to create a "short" unique name ? |
||
| 576 | * |
||
| 577 | * @return string The unique filename to use (with its extension) |
||
| 578 | */ |
||
| 579 | public function createUploadName($folder, $fileName, $trimName = false) |
||
| 607 | |||
| 608 | /** |
||
| 609 | * Replace html entities with their ASCII equivalent |
||
| 610 | * |
||
| 611 | * @param string $chaine The string undecode |
||
| 612 | * |
||
| 613 | * @return string The undecoded string |
||
| 614 | */ |
||
| 615 | public function unhtml($chaine) |
||
| 878 | |||
| 879 | /** |
||
| 880 | * Création d'une titre pour être utilisé par l'url rewriting |
||
| 881 | * |
||
| 882 | * @param string $content Le texte à utiliser pour créer l'url |
||
| 883 | * @param integer $urw La limite basse pour créer les mots |
||
| 884 | * |
||
| 885 | * @return string Le texte à utiliser pour l'url |
||
| 886 | * Note, some parts are from Solo's code |
||
| 887 | */ |
||
| 888 | public static function makeSeoUrl($content, $urw = 1) |
||
| 928 | |||
| 929 | /** |
||
| 930 | * Create the meta keywords based on the content |
||
| 931 | * |
||
| 932 | * @param string $content Content from which we have to create metakeywords |
||
| 933 | * |
||
| 934 | * @return string The list of meta keywords |
||
| 935 | */ |
||
| 936 | public static function createMetaKeywords($content) |
||
| 1003 | |||
| 1004 | /** |
||
| 1005 | * Fonction chargée de gérer l'upload |
||
| 1006 | * |
||
| 1007 | * @param integer $indice L'indice du fichier à télécharger |
||
| 1008 | * @param string $dstpath |
||
| 1009 | * @param null $mimeTypes |
||
| 1010 | * @param null $uploadMaxSize |
||
| 1011 | * @param null $maxWidth |
||
| 1012 | * @param null $maxHeight |
||
| 1013 | * |
||
| 1014 | * @return mixed True si l'upload s'est bien déroulé sinon le message d'erreur correspondant |
||
| 1015 | */ |
||
| 1016 | public static function uploadFile($indice, $dstpath = XOOPS_UPLOAD_PATH, $mimeTypes = null, $uploadMaxSize = null, $maxWidth = null, $maxHeight = null) |
||
| 1057 | |||
| 1058 | /** |
||
| 1059 | * Resize a Picture to some given dimensions (using the wideImage library) |
||
| 1060 | * |
||
| 1061 | * @param string $src_path Picture's source |
||
| 1062 | * @param string $dst_path Picture's destination |
||
| 1063 | * @param integer $param_width Maximum picture's width |
||
| 1064 | * @param integer $param_height Maximum picture's height |
||
| 1065 | * @param boolean $keep_original Do we have to keep the original picture ? |
||
| 1066 | * @param string $fit Resize mode (see the wideImage library for more information) |
||
| 1067 | * |
||
| 1068 | * @return bool |
||
| 1069 | */ |
||
| 1070 | public function resizePicture($src_path, $dst_path, $param_width, $param_height, $keep_original = false, $fit = 'inside') |
||
| 1100 | |||
| 1101 | /** |
||
| 1102 | * Déclenchement d'une alerte Xoops suite à un évènement |
||
| 1103 | * |
||
| 1104 | * @param string $category La catégorie de l'évènement |
||
| 1105 | * @param integer $itemId L'ID de l'élément (trop général pour être décris précisément) |
||
| 1106 | * @param unknown_type $event L'évènement qui est déclencé |
||
| 1107 | * @param unknown_type $tags Les variables à passer au template |
||
| 1108 | */ |
||
| 1109 | public function notify($category, $itemId, $event, $tags) |
||
| 1115 | |||
| 1116 | /** |
||
| 1117 | * Ajoute des jours à une date et retourne la nouvelle date au format Date de Mysql |
||
| 1118 | * |
||
| 1119 | * @param int $duration |
||
| 1120 | * @param integer $startingDate Date de départ (timestamp) |
||
| 1121 | * |
||
| 1122 | * @internal param int $durations Durée en jours |
||
| 1123 | * @return bool|string |
||
| 1124 | */ |
||
| 1125 | public function addDaysToDate($duration = 1, $startingDate = 0) |
||
| 1134 | |||
| 1135 | /** |
||
| 1136 | * Retourne un breadcrumb en fonction des paramètres passés et en partant (d'office) de la racine du module |
||
| 1137 | * |
||
| 1138 | * @param array $path Le chemin complet (excepté la racine) du breadcrumb sous la forme clé=url valeur=titre |
||
| 1139 | * @param string $raquo Le séparateur par défaut à utiliser |
||
| 1140 | * |
||
| 1141 | * @return string le breadcrumb |
||
| 1142 | */ |
||
| 1143 | public static function breadcrumb($path, $raquo = ' » ') |
||
| 1164 | |||
| 1165 | /** |
||
| 1166 | * @param $string |
||
| 1167 | * |
||
| 1168 | * @return string |
||
| 1169 | */ |
||
| 1170 | public function close_tags($string) |
||
| 1201 | |||
| 1202 | /** |
||
| 1203 | * @param $string |
||
| 1204 | * @param int $length |
||
| 1205 | * @param string $etc |
||
| 1206 | * @param bool $break_words |
||
| 1207 | * |
||
| 1208 | * @return mixed|string |
||
| 1209 | */ |
||
| 1210 | public function truncate_tagsafe($string, $length = 80, $etc = '...', $break_words = false) |
||
| 1229 | |||
| 1230 | /** |
||
| 1231 | * Create an infotip |
||
| 1232 | * @param $text |
||
| 1233 | * @return string |
||
| 1234 | */ |
||
| 1235 | public function makeInfotips($text) |
||
| 1246 | |||
| 1247 | /** |
||
| 1248 | * Mise en place de l'appel à la feuille de style du module dans le template |
||
| 1249 | * @param string $url |
||
| 1250 | */ |
||
| 1251 | View Code Duplication | public static function setCSS($url = '') |
|
| 1264 | |||
| 1265 | /** |
||
| 1266 | * Mise en place de l'appel à la feuille de style du module dans le template |
||
| 1267 | * @param string $language |
||
| 1268 | */ |
||
| 1269 | View Code Duplication | public static function setLocalCSS($language = 'english') |
|
| 1281 | |||
| 1282 | /** |
||
| 1283 | * Calcul du TTC à partir du HT et de la TVA |
||
| 1284 | * |
||
| 1285 | * @param float $ht Montant HT |
||
| 1286 | * @param float $vat Taux de TVA |
||
| 1287 | * @param boolean $edit Si faux alors le montant est formaté pour affichage sinon il reste tel quel |
||
| 1288 | * @param string $format Format d'affichage du résultat (long ou court) |
||
| 1289 | * |
||
| 1290 | * @return mixed Soit une chaine soit un flottant |
||
| 1291 | */ |
||
| 1292 | public static function getTTC($ht, $vat, $edit = false, $format = 's') |
||
| 1302 | |||
| 1303 | /** |
||
| 1304 | * Renvoie le montant de la tva à partir du montant HT |
||
| 1305 | * @param $ht |
||
| 1306 | * @param $vat |
||
| 1307 | * @return float |
||
| 1308 | */ |
||
| 1309 | public function getVAT($ht, $vat) |
||
| 1313 | |||
| 1314 | /** |
||
| 1315 | * Retourne le montant TTC |
||
| 1316 | * |
||
| 1317 | * @param floatval $product_price Le montant du produit |
||
| 1318 | * @param integer $vat_id Le numéro de TVA |
||
| 1319 | * |
||
| 1320 | * @return floatval Le montant TTC si on a trouvé sa TVA sinon |
||
| 1321 | */ |
||
| 1322 | public static function getAmountWithVat($product_price, $vat_id) |
||
| 1344 | |||
| 1345 | /** |
||
| 1346 | * @param $datastream |
||
| 1347 | * @param $url |
||
| 1348 | * |
||
| 1349 | * @return string |
||
| 1350 | */ |
||
| 1351 | public function postIt($datastream, $url) |
||
| 1368 | |||
| 1369 | /** |
||
| 1370 | * Retourne le type Mime d'un fichier en utilisant d'abord finfo puis mime_content |
||
| 1371 | * |
||
| 1372 | * @param string $filename Le fichier (avec son chemin d'accès complet) dont on veut connaître le type mime |
||
| 1373 | * |
||
| 1374 | * @return string |
||
| 1375 | */ |
||
| 1376 | public static function getMimeType($filename) |
||
| 1392 | |||
| 1393 | /** |
||
| 1394 | * Retourne un criteria compo qui permet de filtrer les produits sur le mois courant |
||
| 1395 | * |
||
| 1396 | * @return object |
||
| 1397 | */ |
||
| 1398 | public function getThisMonthCriteria() |
||
| 1408 | |||
| 1409 | /** |
||
| 1410 | * Retourne une liste d'objets XoopsUsers à partir d'une liste d'identifiants |
||
| 1411 | * |
||
| 1412 | * @param array $xoopsUsersIDs La liste des ID |
||
| 1413 | * |
||
| 1414 | * @return array Les objets XoopsUsers |
||
| 1415 | */ |
||
| 1416 | public static function getUsersFromIds($xoopsUsersIDs) |
||
| 1432 | |||
| 1433 | /** |
||
| 1434 | * Retourne l'ID de l'utilisateur courant (s'il est connecté) |
||
| 1435 | * |
||
| 1436 | * @return integer L'uid ou 0 |
||
| 1437 | */ |
||
| 1438 | public static function getCurrentUserID() |
||
| 1445 | |||
| 1446 | /** |
||
| 1447 | * Retourne la liste des groupes de l'utilisateur courant (avec cache) |
||
| 1448 | * |
||
| 1449 | * @param int $uid |
||
| 1450 | * |
||
| 1451 | * @return array Les ID des groupes auquel l'utilisateur courant appartient |
||
| 1452 | */ |
||
| 1453 | public function getMemberGroups($uid = 0) |
||
| 1473 | |||
| 1474 | /** |
||
| 1475 | * Indique si l'utilisateur courant fait partie d'une groupe donné (avec gestion de cache) |
||
| 1476 | * |
||
| 1477 | * @param integer $group Groupe recherché |
||
| 1478 | * @param int $uid |
||
| 1479 | * |
||
| 1480 | * @return boolean vrai si l'utilisateur fait partie du groupe, faux sinon |
||
| 1481 | */ |
||
| 1482 | public static function isMemberOfGroup($group = 0, $uid = 0) |
||
| 1500 | |||
| 1501 | /** |
||
| 1502 | * Fonction chargée de vérifier qu'un répertoire existe, qu'on peut écrire dedans et création d'un fichier index.html |
||
| 1503 | * |
||
| 1504 | * @param string $folder Le chemin complet du répertoire à vérifier |
||
| 1505 | * |
||
| 1506 | * @return void |
||
| 1507 | */ |
||
| 1508 | public static function prepareFolder($folder) |
||
| 1516 | |||
| 1517 | /** |
||
| 1518 | * Duplicate a file in local |
||
| 1519 | * |
||
| 1520 | * @param string $path The file's path |
||
| 1521 | * @param string $filename The filename |
||
| 1522 | * |
||
| 1523 | * @return mixed If the copy succeed, the new filename else false |
||
| 1524 | * @since 2.1 |
||
| 1525 | */ |
||
| 1526 | public function duplicateFile($path, $filename) |
||
| 1535 | |||
| 1536 | /** |
||
| 1537 | * Load a language file |
||
| 1538 | * |
||
| 1539 | * @param string $languageFile The required language file |
||
| 1540 | * @param string $defaultExtension Default extension to use |
||
| 1541 | * |
||
| 1542 | * @since 2.2.2009.02.13 |
||
| 1543 | */ |
||
| 1544 | public static function loadLanguageFile($languageFile, $defaultExtension = '.php') |
||
| 1557 | |||
| 1558 | /** |
||
| 1559 | * Formatage d'un floattant pour la base de données |
||
| 1560 | * |
||
| 1561 | * @param float Le montant à formater |
||
| 1562 | * |
||
| 1563 | * @return string le montant formaté |
||
| 1564 | * @since 2.2.2009.02.25 |
||
| 1565 | */ |
||
| 1566 | public static function formatFloatForDB($amount) |
||
| 1570 | |||
| 1571 | /** |
||
| 1572 | * Appelle un fichier Javascript à la manière de Xoops |
||
| 1573 | * |
||
| 1574 | * @note, l'url complète ne doit pas être fournie, la méthode se charge d'ajouter |
||
| 1575 | * le chemin vers le répertoire js en fonction de la requête, c'est à dire que si |
||
| 1576 | * on appelle un fichier de langue, la méthode ajoute l'url vers le répertoire de |
||
| 1577 | * langue, dans le cas contraire on ajoute l'url vers le répertoire JS du module. |
||
| 1578 | * |
||
| 1579 | * @param string $javascriptFile |
||
| 1580 | * @param bool $inLanguageFolder |
||
| 1581 | * @param bool $oldWay |
||
| 1582 | * |
||
| 1583 | * @return void |
||
| 1584 | * @since 2.3.2009.03.14 |
||
| 1585 | */ |
||
| 1586 | public static function callJavascriptFile($javascriptFile, $inLanguageFolder = false, $oldWay = false) |
||
| 1605 | |||
| 1606 | /** |
||
| 1607 | * Create the <option> of an html select |
||
| 1608 | * |
||
| 1609 | * @param array $array Array of index and labels |
||
| 1610 | * @param mixed $default the default value |
||
| 1611 | * @param bool $withNull |
||
| 1612 | * |
||
| 1613 | * @return string |
||
| 1614 | * @since 2.3.2009.03.13 |
||
| 1615 | */ |
||
| 1616 | public function htmlSelectOptions($array, $default = 0, $withNull = true) |
||
| 1637 | |||
| 1638 | /** |
||
| 1639 | * Creates an html select |
||
| 1640 | * |
||
| 1641 | * @param string $selectName Selector's name |
||
| 1642 | * @param array $array Options |
||
| 1643 | * @param mixed $default Default's value |
||
| 1644 | * @param boolean $withNull Do we include a null option ? |
||
| 1645 | * |
||
| 1646 | * @return string |
||
| 1647 | * @since 2.3.2009.03.13 |
||
| 1648 | */ |
||
| 1649 | public static function htmlSelect($selectName, $array, $default, $withNull = true) |
||
| 1658 | |||
| 1659 | /** |
||
| 1660 | * Extrait l'id d'une chaine formatée sous la forme xxxx-99 (duquel on récupère 99) |
||
| 1661 | * |
||
| 1662 | * @note: utilisé par les attributs produits |
||
| 1663 | * |
||
| 1664 | * @param string $string La chaine de travail |
||
| 1665 | * @param string $separator Le séparateur |
||
| 1666 | * |
||
| 1667 | * @return string |
||
| 1668 | */ |
||
| 1669 | View Code Duplication | public function getId($string, $separator = '_') |
|
| 1678 | |||
| 1679 | /** |
||
| 1680 | * Fonction "inverse" de getId (depuis xxxx-99 on récupère xxxx) |
||
| 1681 | * |
||
| 1682 | * @note: utilisé par les attributs produits |
||
| 1683 | * |
||
| 1684 | * @param string $string La chaine de travail |
||
| 1685 | * @param string $separator Le séparateur |
||
| 1686 | * |
||
| 1687 | * @return string |
||
| 1688 | */ |
||
| 1689 | View Code Duplication | public function getName($string, $separator = '_') |
|
| 1698 | |||
| 1699 | /** |
||
| 1700 | * Renvoie un montant nul si le montant est négatif |
||
| 1701 | * |
||
| 1702 | * @param float $amount |
||
| 1703 | * |
||
| 1704 | * @return float |
||
| 1705 | */ |
||
| 1706 | public static function doNotAcceptNegativeAmounts(&$amount) |
||
| 1712 | |||
| 1713 | /** |
||
| 1714 | * Returns a string from the request |
||
| 1715 | * |
||
| 1716 | * @param string $valueName Name of the parameter you want to get |
||
| 1717 | * @param mixed $defaultValue Default value to return if the parameter is not set in the request |
||
| 1718 | * |
||
| 1719 | * @return mixed |
||
| 1720 | */ |
||
| 1721 | public function getFromRequest($valueName, $defaultValue = '') |
||
| 1725 | |||
| 1726 | /** |
||
| 1727 | * Verify that a mysql table exists |
||
| 1728 | * |
||
| 1729 | * @package Oledrion |
||
| 1730 | * @author Instant Zero (http://xoops.instant-zero.com) |
||
| 1731 | * @copyright (c) Instant Zero |
||
| 1732 | * @param $tablename |
||
| 1733 | * @return bool |
||
| 1734 | */ |
||
| 1735 | public static function tableExists($tablename) |
||
| 1742 | |||
| 1743 | /** |
||
| 1744 | * Verify that a field exists inside a mysql table |
||
| 1745 | * |
||
| 1746 | * @package Oledrion |
||
| 1747 | * @author Instant Zero (http://xoops.instant-zero.com) |
||
| 1748 | * @copyright (c) Instant Zero |
||
| 1749 | * @param $fieldname |
||
| 1750 | * @param $table |
||
| 1751 | * @return bool |
||
| 1752 | */ |
||
| 1753 | public static function fieldExists($fieldname, $table) |
||
| 1760 | |||
| 1761 | /** |
||
| 1762 | * Retourne la définition d'un champ |
||
| 1763 | * |
||
| 1764 | * @param string $fieldname |
||
| 1765 | * @param string $table |
||
| 1766 | * |
||
| 1767 | * @return array |
||
| 1768 | */ |
||
| 1769 | public function getFieldDefinition($fieldname, $table) |
||
| 1779 | |||
| 1780 | /** |
||
| 1781 | * Add a field to a mysql table |
||
| 1782 | * |
||
| 1783 | * @package Oledrion |
||
| 1784 | * @author Instant Zero (http://xoops.instant-zero.com) |
||
| 1785 | * @copyright (c) Instant Zero |
||
| 1786 | * @param $field |
||
| 1787 | * @param $table |
||
| 1788 | * @return mixed |
||
| 1789 | */ |
||
| 1790 | public static function addField($field, $table) |
||
| 1797 | |||
| 1798 | /** |
||
| 1799 | * @param $info |
||
| 1800 | * |
||
| 1801 | * @return string |
||
| 1802 | */ |
||
| 1803 | public function packingHtmlSelect($info) |
||
| 1819 | |||
| 1820 | /** |
||
| 1821 | * @param $info |
||
| 1822 | * |
||
| 1823 | * @return string |
||
| 1824 | */ |
||
| 1825 | public function deliveryHtmlSelect($info) |
||
| 1842 | |||
| 1843 | /** |
||
| 1844 | * @param $info |
||
| 1845 | * |
||
| 1846 | * @return string |
||
| 1847 | */ |
||
| 1848 | public function paymentHtmlSelect($info) |
||
| 1859 | |||
| 1860 | /** |
||
| 1861 | * @return array |
||
| 1862 | */ |
||
| 1863 | public function getCountriesList() |
||
| 1869 | |||
| 1870 | } |
||
| 1871 |
Loading history...
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.