@@ -76,6 +76,12 @@ discard block |
||
| 76 | 76 | // prepare EMail-From |
| 77 | 77 | $emailheaders = 'From: "' . $emailaddr . '" <' . $emailaddr . '>'; |
| 78 | 78 | |
| 79 | +/** |
|
| 80 | + * @param string $module |
|
| 81 | + * @param integer $eventid |
|
| 82 | + * @param integer $objectid2 |
|
| 83 | + * @param string $logtext |
|
| 84 | + */ |
|
| 79 | 85 | function logentry($module, $eventid, $userid, $objectid1, $objectid2, $logtext, $details) |
| 80 | 86 | { |
| 81 | 87 | sql( |
@@ -148,6 +154,9 @@ discard block |
||
| 148 | 154 | return $start; |
| 149 | 155 | } |
| 150 | 156 | |
| 157 | +/** |
|
| 158 | + * @return string |
|
| 159 | + */ |
|
| 151 | 160 | function escape_javascript($text) |
| 152 | 161 | { |
| 153 | 162 | return str_replace('\'', '\\\'', str_replace('"', '"', $text)); |
@@ -159,6 +168,9 @@ discard block |
||
| 159 | 168 | sql_error(); |
| 160 | 169 | } |
| 161 | 170 | |
| 171 | +/** |
|
| 172 | + * @param string $sql |
|
| 173 | + */ |
|
| 162 | 174 | function sqlValue($sql, $default) |
| 163 | 175 | { |
| 164 | 176 | $rs = sql($sql); |
@@ -187,11 +199,21 @@ discard block |
||
| 187 | 199 | } |
| 188 | 200 | } |
| 189 | 201 | |
| 202 | +/** |
|
| 203 | + * @param string $name |
|
| 204 | + * @param string $default |
|
| 205 | + * |
|
| 206 | + * @return string |
|
| 207 | + */ |
|
| 190 | 208 | function getSysConfig($name, $default) |
| 191 | 209 | { |
| 192 | 210 | return sqlValue('SELECT `value` FROM `sysconfig` WHERE `name`=\'' . sql_escape($name) . '\'', $default); |
| 193 | 211 | } |
| 194 | 212 | |
| 213 | +/** |
|
| 214 | + * @param string $name |
|
| 215 | + * @param string $value |
|
| 216 | + */ |
|
| 195 | 217 | function setSysConfig($name, $value) |
| 196 | 218 | { |
| 197 | 219 | if (sqlValue('SELECT COUNT(*) FROM sysconfig WHERE name=\'' . sql_escape($name) . '\'', 0) == 1) { |
@@ -516,6 +538,9 @@ discard block |
||
| 516 | 538 | die('sql_error'); |
| 517 | 539 | } |
| 518 | 540 | |
| 541 | +/** |
|
| 542 | + * @param string $warnmessage |
|
| 543 | + */ |
|
| 519 | 544 | function sql_warn($warnmessage) |
| 520 | 545 | { |
| 521 | 546 | global $sql_errormail; |
@@ -549,6 +574,9 @@ discard block |
||
| 549 | 574 | return mysql_fetch_row($rs); |
| 550 | 575 | } |
| 551 | 576 | |
| 577 | +/** |
|
| 578 | + * @param resource $rs |
|
| 579 | + */ |
|
| 552 | 580 | function sql_fetch_column($rs) |
| 553 | 581 | { |
| 554 | 582 | $col = []; |
@@ -758,6 +786,9 @@ discard block |
||
| 758 | 786 | ]; |
| 759 | 787 | } |
| 760 | 788 | |
| 789 | +/** |
|
| 790 | + * @param string $filename |
|
| 791 | + */ |
|
| 761 | 792 | function fetch_email_template($filename, $language, $domain) |
| 762 | 793 | { |
| 763 | 794 | global $opt, $rootpath; |
@@ -323,6 +323,9 @@ discard block |
||
| 323 | 323 | //set no_eval true to prevent this contents from php-parsing. |
| 324 | 324 | //Important when replacing something that the user has posted |
| 325 | 325 | //in HTML code and could contain \<\? php-Code \?\> |
| 326 | +/** |
|
| 327 | + * @param string $name |
|
| 328 | + */ |
|
| 326 | 329 | function tpl_set_var($name, $value, $no_eval = true) |
| 327 | 330 | { |
| 328 | 331 | global $vars, $no_eval_vars; |
@@ -543,6 +546,9 @@ discard block |
||
| 543 | 546 | } |
| 544 | 547 | |
| 545 | 548 | //redirect to another site to display, i.e. to view a cache after logging |
| 549 | +/** |
|
| 550 | + * @param string $page |
|
| 551 | + */ |
|
| 546 | 552 | function tpl_redirect($page) |
| 547 | 553 | { |
| 548 | 554 | global $absolute_server_URI; |
@@ -562,6 +568,9 @@ discard block |
||
| 562 | 568 | //process the template replacements |
| 563 | 569 | //no_eval_replace - if true, variables will be replaced that are |
| 564 | 570 | // marked as "no_eval" |
| 571 | +/** |
|
| 572 | + * @param string $str |
|
| 573 | + */ |
|
| 565 | 574 | function tpl_do_replace($str) |
| 566 | 575 | { |
| 567 | 576 | global $vars, $no_eval_vars; |
@@ -589,6 +598,10 @@ discard block |
||
| 589 | 598 | return $str; |
| 590 | 599 | } |
| 591 | 600 | |
| 601 | +/** |
|
| 602 | + * @param string $tplnameError |
|
| 603 | + * @param string $msg |
|
| 604 | + */ |
|
| 592 | 605 | function tpl_errorMsg($tplnameError, $msg) |
| 593 | 606 | { |
| 594 | 607 | global $tplname; |
@@ -617,6 +630,9 @@ discard block |
||
| 617 | 630 | textdomain('messages'); |
| 618 | 631 | } |
| 619 | 632 | |
| 633 | +/** |
|
| 634 | + * @param string $sCode |
|
| 635 | + */ |
|
| 620 | 636 | function tpl_do_translation($sCode) |
| 621 | 637 | { |
| 622 | 638 | global $opt, $style, $tplname; |
@@ -645,6 +661,9 @@ discard block |
||
| 645 | 661 | return $sResultCode; |
| 646 | 662 | } |
| 647 | 663 | |
| 664 | +/** |
|
| 665 | + * @param string $sCode |
|
| 666 | + */ |
|
| 648 | 667 | function gettext_do_html($sCode) |
| 649 | 668 | { |
| 650 | 669 | $sResultCode = ''; |
@@ -674,6 +693,9 @@ discard block |
||
| 674 | 693 | return $sResultCode; |
| 675 | 694 | } |
| 676 | 695 | |
| 696 | +/** |
|
| 697 | + * @return string |
|
| 698 | + */ |
|
| 677 | 699 | function t($str) |
| 678 | 700 | { |
| 679 | 701 | global $translate; |
@@ -149,6 +149,9 @@ |
||
| 149 | 149 | <?php |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | +/** |
|
| 153 | + * @param string $sql |
|
| 154 | + */ |
|
| 152 | 155 | function sqldbg_execute($sql, $bSlave) |
| 153 | 156 | { |
| 154 | 157 | global $dblink; |
@@ -341,6 +341,9 @@ discard block |
||
| 341 | 341 | return $result; |
| 342 | 342 | } |
| 343 | 343 | |
| 344 | +/** |
|
| 345 | + * @param string $sql |
|
| 346 | + */ |
|
| 344 | 347 | function sqlf($sql) |
| 345 | 348 | { |
| 346 | 349 | global $db; |
@@ -354,6 +357,9 @@ discard block |
||
| 354 | 357 | return $result; |
| 355 | 358 | } |
| 356 | 359 | |
| 360 | +/** |
|
| 361 | + * @param string $sql |
|
| 362 | + */ |
|
| 357 | 363 | function sqlf_slave($sql) |
| 358 | 364 | { |
| 359 | 365 | global $db; |
@@ -367,6 +373,9 @@ discard block |
||
| 367 | 373 | return $result; |
| 368 | 374 | } |
| 369 | 375 | |
| 376 | +/** |
|
| 377 | + * @param string $sql |
|
| 378 | + */ |
|
| 370 | 379 | function sqll($sql) |
| 371 | 380 | { |
| 372 | 381 | global $db; |
@@ -380,6 +389,10 @@ discard block |
||
| 380 | 389 | return $result; |
| 381 | 390 | } |
| 382 | 391 | |
| 392 | +/** |
|
| 393 | + * @param string $sql |
|
| 394 | + * @param integer $default |
|
| 395 | + */ |
|
| 383 | 396 | function sqlf_value($sql, $default) |
| 384 | 397 | { |
| 385 | 398 | global $db; |
@@ -394,6 +407,10 @@ discard block |
||
| 394 | 407 | return $result; |
| 395 | 408 | } |
| 396 | 409 | |
| 410 | +/** |
|
| 411 | + * @param string $sql |
|
| 412 | + * @param integer $default |
|
| 413 | + */ |
|
| 397 | 414 | function sqll_value($sql, $default) |
| 398 | 415 | { |
| 399 | 416 | global $db; |
@@ -474,6 +491,9 @@ discard block |
||
| 474 | 491 | return sql_value_internal(true, $sql, $default, $args); |
| 475 | 492 | } |
| 476 | 493 | |
| 494 | +/** |
|
| 495 | + * @param boolean $bQuerySlave |
|
| 496 | + */ |
|
| 477 | 497 | function sql_value_internal($bQuerySlave, $sql, $default) |
| 478 | 498 | { |
| 479 | 499 | $args = func_get_args(); |
@@ -576,6 +596,9 @@ discard block |
||
| 576 | 596 | return $retval; |
| 577 | 597 | } |
| 578 | 598 | |
| 599 | +/** |
|
| 600 | + * @param resource $rs |
|
| 601 | + */ |
|
| 579 | 602 | function sql_fetch_column($rs) |
| 580 | 603 | { |
| 581 | 604 | global $opt; |
@@ -625,11 +648,17 @@ discard block |
||
| 625 | 648 | return mysql_insert_id($db['dblink_slave']); |
| 626 | 649 | } |
| 627 | 650 | |
| 651 | +/** |
|
| 652 | + * @param resource $rs |
|
| 653 | + */ |
|
| 628 | 654 | function sql_num_rows($rs) |
| 629 | 655 | { |
| 630 | 656 | return mysql_num_rows($rs); |
| 631 | 657 | } |
| 632 | 658 | |
| 659 | +/** |
|
| 660 | + * @param string $table |
|
| 661 | + */ |
|
| 633 | 662 | function sql_temp_table($table) |
| 634 | 663 | { |
| 635 | 664 | global $db, $opt; |
@@ -659,6 +688,9 @@ discard block |
||
| 659 | 688 | $db['temptables'][$table] = $table; |
| 660 | 689 | } |
| 661 | 690 | |
| 691 | +/** |
|
| 692 | + * @param string $table |
|
| 693 | + */ |
|
| 662 | 694 | function sql_temp_table_slave($table) |
| 663 | 695 | { |
| 664 | 696 | global $db, $opt; |
@@ -679,6 +711,9 @@ discard block |
||
| 679 | 711 | $db['temptables_slave'][$table] = $table; |
| 680 | 712 | } |
| 681 | 713 | |
| 714 | +/** |
|
| 715 | + * @param string $table |
|
| 716 | + */ |
|
| 682 | 717 | function sql_drop_temp_table($table) |
| 683 | 718 | { |
| 684 | 719 | global $db, $opt; |
@@ -715,6 +750,9 @@ discard block |
||
| 715 | 750 | $db['temptables'][$newname] = $newname; |
| 716 | 751 | } |
| 717 | 752 | |
| 753 | +/** |
|
| 754 | + * @param string $table |
|
| 755 | + */ |
|
| 718 | 756 | function sql_drop_temp_table_slave($table) |
| 719 | 757 | { |
| 720 | 758 | global $db, $opt; |
@@ -1079,6 +1117,9 @@ discard block |
||
| 1079 | 1117 | } |
| 1080 | 1118 | } |
| 1081 | 1119 | |
| 1120 | +/** |
|
| 1121 | + * @param string $warnmessage |
|
| 1122 | + */ |
|
| 1082 | 1123 | function sql_warn($warnmessage) |
| 1083 | 1124 | { |
| 1084 | 1125 | global $opt; |
@@ -1105,6 +1146,9 @@ discard block |
||
| 1105 | 1146 | } |
| 1106 | 1147 | } |
| 1107 | 1148 | |
| 1149 | +/** |
|
| 1150 | + * @param resource $rs |
|
| 1151 | + */ |
|
| 1108 | 1152 | function sql_export_recordset($f, $rs, $table, $truncate = true) |
| 1109 | 1153 | { |
| 1110 | 1154 | fwrite($f, "SET NAMES 'utf8';\n"); |
@@ -1135,6 +1179,9 @@ discard block |
||
| 1135 | 1179 | } |
| 1136 | 1180 | } |
| 1137 | 1181 | |
| 1182 | +/** |
|
| 1183 | + * @param resource $f |
|
| 1184 | + */ |
|
| 1138 | 1185 | function sql_export_table($f, $table) |
| 1139 | 1186 | { |
| 1140 | 1187 | $primary = array(); |
@@ -1156,6 +1203,10 @@ discard block |
||
| 1156 | 1203 | sql_free_result($rs); |
| 1157 | 1204 | } |
| 1158 | 1205 | |
| 1206 | +/** |
|
| 1207 | + * @param string $filename |
|
| 1208 | + * @param string[] $tables |
|
| 1209 | + */ |
|
| 1159 | 1210 | function sql_export_tables_to_file($filename, $tables) |
| 1160 | 1211 | { |
| 1161 | 1212 | $f = fopen($filename, 'w'); |
@@ -1183,6 +1234,9 @@ discard block |
||
| 1183 | 1234 | fclose($f); |
| 1184 | 1235 | } |
| 1185 | 1236 | |
| 1237 | +/** |
|
| 1238 | + * @param resource $f |
|
| 1239 | + */ |
|
| 1186 | 1240 | function sql_export_structure($f, $table) |
| 1187 | 1241 | { |
| 1188 | 1242 | $rs = sql("SHOW CREATE TABLE `&1`", $table); |
@@ -1198,6 +1252,9 @@ discard block |
||
| 1198 | 1252 | fwrite($f, $sTableSql . " ;\n"); |
| 1199 | 1253 | } |
| 1200 | 1254 | |
| 1255 | +/** |
|
| 1256 | + * @param string $filename |
|
| 1257 | + */ |
|
| 1201 | 1258 | function sql_export_structure_to_file($filename, $table) |
| 1202 | 1259 | { |
| 1203 | 1260 | $f = fopen($filename, 'w'); |
@@ -1271,6 +1328,9 @@ discard block |
||
| 1271 | 1328 | } |
| 1272 | 1329 | |
| 1273 | 1330 | // test if a function or procedure exists |
| 1331 | +/** |
|
| 1332 | + * @param string $type |
|
| 1333 | + */ |
|
| 1274 | 1334 | function sql_fp_exists($type, $name) |
| 1275 | 1335 | { |
| 1276 | 1336 | global $opt; |
@@ -58,6 +58,9 @@ |
||
| 58 | 58 | // |
| 59 | 59 | // If $wrap is > 0, longer lines will be wrapped to new lines. |
| 60 | 60 | |
| 61 | +/** |
|
| 62 | + * @param integer $wrap |
|
| 63 | + */ |
|
| 61 | 64 | function html2plaintext($text, $texthtml0, $wrap) |
| 62 | 65 | { |
| 63 | 66 | global $opt, $smiley; |
@@ -106,6 +106,10 @@ |
||
| 106 | 106 | // throttle admin error mails; |
| 107 | 107 | // currently used only for SQL errors and warnings |
| 108 | 108 | |
| 109 | +/** |
|
| 110 | + * @param string $errortype |
|
| 111 | + * @param string $message |
|
| 112 | + */ |
|
| 109 | 113 | function admin_errormail($to, $errortype, $message, $headers) |
| 110 | 114 | { |
| 111 | 115 | global $opt; |
@@ -26,6 +26,9 @@ discard block |
||
| 26 | 26 | * Returns: if $file specified - true if OK |
| 27 | 27 | if $file not specified - image data |
| 28 | 28 | */ |
| 29 | +/** |
|
| 30 | + * @param resource $img |
|
| 31 | + */ |
|
| 29 | 32 | function imagebmp($img,$file="",$RLE=0) |
| 30 | 33 | { |
| 31 | 34 | |
@@ -463,6 +466,9 @@ discard block |
||
| 463 | 466 | |
| 464 | 467 | |
| 465 | 468 | |
| 469 | +/** |
|
| 470 | + * @param integer $byte |
|
| 471 | + */ |
|
| 466 | 472 | function RetBits($byte,$start,$len) |
| 467 | 473 | { |
| 468 | 474 | $bin=decbin8($byte); |
@@ -474,6 +480,10 @@ discard block |
||
| 474 | 480 | |
| 475 | 481 | |
| 476 | 482 | $CurrentBit=0; |
| 483 | +/** |
|
| 484 | + * @param resource $f |
|
| 485 | + * @param integer $count |
|
| 486 | + */ |
|
| 477 | 487 | function freadbits($f,$count) |
| 478 | 488 | { |
| 479 | 489 | global $CurrentBit,$SMode; |
@@ -505,6 +515,10 @@ discard block |
||
| 505 | 515 | { |
| 506 | 516 | return chr($n & 255).chr(($n >> 8) & 255).chr(($n >> 16) & 255).chr(($n >> 24) & 255); |
| 507 | 517 | } |
| 518 | + |
|
| 519 | + /** |
|
| 520 | + * @param integer $n |
|
| 521 | + */ |
|
| 508 | 522 | function int_to_word($n) |
| 509 | 523 | { |
| 510 | 524 | return chr($n & 255).chr(($n >> 8) & 255); |
@@ -516,6 +530,9 @@ discard block |
||
| 516 | 530 | return decbinx($d,8); |
| 517 | 531 | }; |
| 518 | 532 | |
| 533 | +/** |
|
| 534 | + * @param integer $n |
|
| 535 | + */ |
|
| 519 | 536 | function decbinx($d,$n) |
| 520 | 537 | { |
| 521 | 538 | $bin=decbin($d); |
@@ -23,6 +23,10 @@ |
||
| 23 | 23 | return self::getAttrbutesListArrayInternal($cacheId, false, $firstLetterUppercase); |
| 24 | 24 | } |
| 25 | 25 | |
| 26 | + /** |
|
| 27 | + * @param boolean $bOnlySelectable |
|
| 28 | + * @param boolean $firstLetterUppercase |
|
| 29 | + */ |
|
| 26 | 30 | public static function getAttrbutesListArrayInternal($cacheId, $bOnlySelectable, $firstLetterUppercase) |
| 27 | 31 | { |
| 28 | 32 | global $opt; |
@@ -411,9 +411,9 @@ |
||
| 411 | 411 | } |
| 412 | 412 | |
| 413 | 413 | /** |
| 414 | - * @param $cacheId |
|
| 415 | - * @param $start |
|
| 416 | - * @param $count |
|
| 414 | + * @param integer $cacheId |
|
| 415 | + * @param integer $start |
|
| 416 | + * @param integer $count |
|
| 417 | 417 | * @param bool $deleted |
| 418 | 418 | * @param bool $protect_old_coords |
| 419 | 419 | * |