@@ -268,6 +268,7 @@ discard block |
||
| 268 | 268 | /** |
| 269 | 269 | * @name: delete |
| 270 | 270 | * |
| 271 | + * @param string $from |
|
| 271 | 272 | */ |
| 272 | 273 | public function delete($from, $where = '', $orderby = '', $limit = '') |
| 273 | 274 | { |
@@ -414,6 +415,9 @@ discard block |
||
| 414 | 415 | } |
| 415 | 416 | } |
| 416 | 417 | |
| 418 | + /** |
|
| 419 | + * @param string $table |
|
| 420 | + */ |
|
| 417 | 421 | public function save($fields, $table, $where = '') |
| 418 | 422 | { |
| 419 | 423 | |
@@ -444,6 +448,7 @@ discard block |
||
| 444 | 448 | /** |
| 445 | 449 | * @name: freeResult |
| 446 | 450 | * |
| 451 | + * @param mysqli_result $rs |
|
| 447 | 452 | */ |
| 448 | 453 | public function freeResult($rs) |
| 449 | 454 | { |
@@ -554,6 +559,7 @@ discard block |
||
| 554 | 559 | * @name: getColumn |
| 555 | 560 | * @desc: returns an array of the values found on colun $name |
| 556 | 561 | * @param: $dsq - dataset or query string |
| 562 | + * @param string $name |
|
| 557 | 563 | */ |
| 558 | 564 | public function getColumn($name, $dsq) |
| 559 | 565 | { |
@@ -720,6 +726,9 @@ discard block |
||
| 720 | 726 | return $result; |
| 721 | 727 | } |
| 722 | 728 | |
| 729 | + /** |
|
| 730 | + * @param string $table_name |
|
| 731 | + */ |
|
| 723 | 732 | public function optimize($table_name) |
| 724 | 733 | { |
| 725 | 734 | $rs = $this->query("OPTIMIZE TABLE {$table_name}"); |
@@ -730,6 +739,9 @@ discard block |
||
| 730 | 739 | return $rs; |
| 731 | 740 | } |
| 732 | 741 | |
| 742 | + /** |
|
| 743 | + * @param string $table_name |
|
| 744 | + */ |
|
| 733 | 745 | public function truncate($table_name) |
| 734 | 746 | { |
| 735 | 747 | $rs = $this->query("TRUNCATE {$table_name}"); |
@@ -172,7 +172,7 @@ discard block |
||
| 172 | 172 | * |
| 173 | 173 | * @param string $param |
| 174 | 174 | * @param array $tvsArray |
| 175 | - * @return mixed |
|
| 175 | + * @return string |
|
| 176 | 176 | */ |
| 177 | 177 | function parseTvValues($param, $tvsArray) |
| 178 | 178 | { |
@@ -566,7 +566,7 @@ discard block |
||
| 566 | 566 | /** |
| 567 | 567 | * returns an array if a delimiter is present. returns array is a recordset is present |
| 568 | 568 | * |
| 569 | - * @param $src |
|
| 569 | + * @param string $src |
|
| 570 | 570 | * @param string $delim |
| 571 | 571 | * @param string $type |
| 572 | 572 | * @param bool $columns |
@@ -1022,7 +1022,7 @@ discard block |
||
| 1022 | 1022 | |
| 1023 | 1023 | if (! function_exists('ParseIntputOptions')) { |
| 1024 | 1024 | /** |
| 1025 | - * @param string|array|mysqli_result $v |
|
| 1025 | + * @param string $v |
|
| 1026 | 1026 | * @return array |
| 1027 | 1027 | */ |
| 1028 | 1028 | function ParseIntputOptions($v) |
@@ -63,7 +63,7 @@ |
||
| 63 | 63 | } |
| 64 | 64 | |
| 65 | 65 | /** |
| 66 | - * @return mixed |
|
| 66 | + * @return string |
|
| 67 | 67 | */ |
| 68 | 68 | public function getOutput() |
| 69 | 69 | { |
@@ -10,7 +10,7 @@ |
||
| 10 | 10 | * @param int $flags |
| 11 | 11 | * @param string $encode |
| 12 | 12 | * @param int $safecount |
| 13 | - * @return string|array |
|
| 13 | + * @return null|string |
|
| 14 | 14 | */ |
| 15 | 15 | public function htmlspecialchars($str = '', $flags = ENT_COMPAT, $encode = '', $safecount = 0) |
| 16 | 16 | { |
@@ -357,7 +357,7 @@ |
||
| 357 | 357 | if(!function_exists('getFileContent')) { |
| 358 | 358 | /** |
| 359 | 359 | * @param string $filepath |
| 360 | - * @return bool|string |
|
| 360 | + * @return null|string |
|
| 361 | 361 | */ |
| 362 | 362 | function getFileContent($filepath) |
| 363 | 363 | { |
@@ -266,7 +266,7 @@ discard block |
||
| 266 | 266 | * MODX_MANAGER_PATH."includes/extenders/ex_{$extname}.inc.php" |
| 267 | 267 | * $extname - extension name in lowercase |
| 268 | 268 | * |
| 269 | - * @param $extname |
|
| 269 | + * @param string $extname |
|
| 270 | 270 | * @param bool $reload |
| 271 | 271 | * @return bool |
| 272 | 272 | */ |
@@ -309,7 +309,7 @@ discard block |
||
| 309 | 309 | * @param int $count_attempts |
| 310 | 310 | * @param string $type $type |
| 311 | 311 | * @param string $responseCode |
| 312 | - * @return bool|null |
|
| 312 | + * @return false|null |
|
| 313 | 313 | * @global string $base_url |
| 314 | 314 | * @global string $site_url |
| 315 | 315 | */ |
@@ -1010,7 +1010,7 @@ discard block |
||
| 1010 | 1010 | } |
| 1011 | 1011 | |
| 1012 | 1012 | /** |
| 1013 | - * @param $contents |
|
| 1013 | + * @param string $contents |
|
| 1014 | 1014 | * @return mixed |
| 1015 | 1015 | */ |
| 1016 | 1016 | public function RecoveryEscapedTags($contents) |
@@ -1034,7 +1034,7 @@ discard block |
||
| 1034 | 1034 | } |
| 1035 | 1035 | |
| 1036 | 1036 | /** |
| 1037 | - * @param $tstart |
|
| 1037 | + * @param double $tstart |
|
| 1038 | 1038 | * @return array |
| 1039 | 1039 | */ |
| 1040 | 1040 | public function getTimerStats($tstart) |
@@ -1800,7 +1800,7 @@ discard block |
||
| 1800 | 1800 | |
| 1801 | 1801 | /** |
| 1802 | 1802 | * Remove Comment-Tags from output like <!--@- Comment -@--> |
| 1803 | - * @param $content |
|
| 1803 | + * @param string $content |
|
| 1804 | 1804 | * @param string $left |
| 1805 | 1805 | * @param string $right |
| 1806 | 1806 | * @return mixed |
@@ -1973,7 +1973,7 @@ discard block |
||
| 1973 | 1973 | /** |
| 1974 | 1974 | * Run snippets as per the tags in $documentSource and replace the tags with the returned values. |
| 1975 | 1975 | * |
| 1976 | - * @param $content |
|
| 1976 | + * @param string $content |
|
| 1977 | 1977 | * @return string |
| 1978 | 1978 | * @internal param string $documentSource |
| 1979 | 1979 | */ |
@@ -3008,7 +3008,7 @@ discard block |
||
| 3008 | 3008 | |
| 3009 | 3009 | /** |
| 3010 | 3010 | * @param $templateID |
| 3011 | - * @return mixed |
|
| 3011 | + * @return string |
|
| 3012 | 3012 | */ |
| 3013 | 3013 | public function _getTemplateCodeFromDB($templateID) |
| 3014 | 3014 | { |
@@ -3051,7 +3051,7 @@ discard block |
||
| 3051 | 3051 | /** |
| 3052 | 3052 | * @param $id |
| 3053 | 3053 | * @param int $top |
| 3054 | - * @return mixed |
|
| 3054 | + * @return string |
|
| 3055 | 3055 | */ |
| 3056 | 3056 | public function getUltimateParentId($id, $top = 0) |
| 3057 | 3057 | { |
@@ -3391,7 +3391,7 @@ discard block |
||
| 3391 | 3391 | * |
| 3392 | 3392 | * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role |
| 3393 | 3393 | * @param int $id Element- / Resource-id |
| 3394 | - * @return bool |
|
| 3394 | + * @return false|null |
|
| 3395 | 3395 | */ |
| 3396 | 3396 | public function lockElement($type, $id) |
| 3397 | 3397 | { |
@@ -3413,7 +3413,7 @@ discard block |
||
| 3413 | 3413 | * @param int $type Types: 1=template, 2=tv, 3=chunk, 4=snippet, 5=plugin, 6=module, 7=resource, 8=role |
| 3414 | 3414 | * @param int $id Element- / Resource-id |
| 3415 | 3415 | * @param bool $includeAllUsers true = Deletes not only own user-locks |
| 3416 | - * @return bool |
|
| 3416 | + * @return false|null |
|
| 3417 | 3417 | */ |
| 3418 | 3418 | public function unlockElement($type, $id, $includeAllUsers = false) |
| 3419 | 3419 | { |
@@ -3927,7 +3927,7 @@ discard block |
||
| 3927 | 3927 | * Default: 1 |
| 3928 | 3928 | * @param string $fields List of fields |
| 3929 | 3929 | * Default: id, pagetitle, description, alias |
| 3930 | - * @return boolean|array |
|
| 3930 | + * @return string |
|
| 3931 | 3931 | */ |
| 3932 | 3932 | public function getPageInfo($pageid = -1, $active = 1, $fields = 'id, pagetitle, description, alias') |
| 3933 | 3933 | { |
@@ -4019,7 +4019,7 @@ discard block |
||
| 4019 | 4019 | * |
| 4020 | 4020 | * @param string $type |
| 4021 | 4021 | * @param bool $report |
| 4022 | - * @return bool |
|
| 4022 | + * @return boolean|null |
|
| 4023 | 4023 | */ |
| 4024 | 4024 | public function clearCache($type = '', $report = false) |
| 4025 | 4025 | { |
@@ -4385,7 +4385,7 @@ discard block |
||
| 4385 | 4385 | * - Placeholders prefix. Default: '{'. |
| 4386 | 4386 | * @param string $suffix {string} |
| 4387 | 4387 | * - Placeholders suffix. Default: '}'. |
| 4388 | - * @return bool|mixed|string {string; false} - Parsed chunk or false if $chunkArr is not array. |
|
| 4388 | + * @return false|string {string; false} - Parsed chunk or false if $chunkArr is not array. |
|
| 4389 | 4389 | * - Parsed chunk or false if $chunkArr is not array. |
| 4390 | 4390 | */ |
| 4391 | 4391 | public function parseChunk($chunkName, $chunkArr, $prefix = '{', $suffix = '}') |
@@ -5357,7 +5357,7 @@ discard block |
||
| 5357 | 5357 | * Remove event listener - only for use within the current execution cycle |
| 5358 | 5358 | * |
| 5359 | 5359 | * @param string $evtName |
| 5360 | - * @return boolean |
|
| 5360 | + * @return false|null |
|
| 5361 | 5361 | */ |
| 5362 | 5362 | public function removeEventListener($evtName) |
| 5363 | 5363 | { |
@@ -5381,7 +5381,7 @@ discard block |
||
| 5381 | 5381 | * |
| 5382 | 5382 | * @param string $evtName |
| 5383 | 5383 | * @param array $extParams Parameters available to plugins. Each array key will be the PHP variable name, and the array value will be the variable value. |
| 5384 | - * @return boolean|array |
|
| 5384 | + * @return false|null |
|
| 5385 | 5385 | */ |
| 5386 | 5386 | public function invokeEvent($evtName, $extParams = array()) |
| 5387 | 5387 | { |
@@ -5976,7 +5976,7 @@ discard block |
||
| 5976 | 5976 | |
| 5977 | 5977 | /** |
| 5978 | 5978 | * @param string $str |
| 5979 | - * @return bool|mixed|string |
|
| 5979 | + * @return string |
|
| 5980 | 5980 | */ |
| 5981 | 5981 | public function atBindFileContent($str = '') |
| 5982 | 5982 | { |
@@ -6027,8 +6027,8 @@ discard block |
||
| 6027 | 6027 | } |
| 6028 | 6028 | |
| 6029 | 6029 | /** |
| 6030 | - * @param $str |
|
| 6031 | - * @return bool|string |
|
| 6030 | + * @param string $str |
|
| 6031 | + * @return false|string |
|
| 6032 | 6032 | */ |
| 6033 | 6033 | public function getExtFromFilename($str) |
| 6034 | 6034 | { |
@@ -6056,7 +6056,7 @@ discard block |
||
| 6056 | 6056 | * @param string $text Error message |
| 6057 | 6057 | * @param string $file File where the error was detected |
| 6058 | 6058 | * @param string $line Line number within $file |
| 6059 | - * @return boolean |
|
| 6059 | + * @return boolean|null |
|
| 6060 | 6060 | */ |
| 6061 | 6061 | public function phpError($nr, $text, $file, $line) |
| 6062 | 6062 | { |
@@ -6108,7 +6108,7 @@ discard block |
||
| 6108 | 6108 | * @param string $text |
| 6109 | 6109 | * @param string $line |
| 6110 | 6110 | * @param string $output |
| 6111 | - * @return bool |
|
| 6111 | + * @return null|boolean |
|
| 6112 | 6112 | */ |
| 6113 | 6113 | public function messageQuit($msg = 'unspecified error', $query = '', $is_error = true, $nr = '', $file = '', $source = '', $text = '', $line = '', $output = '') |
| 6114 | 6114 | { |
@@ -6523,7 +6523,7 @@ discard block |
||
| 6523 | 6523 | |
| 6524 | 6524 | /** |
| 6525 | 6525 | * @param string $str |
| 6526 | - * @return bool|mixed|string |
|
| 6526 | + * @return string |
|
| 6527 | 6527 | */ |
| 6528 | 6528 | public function atBindInclude($str = '') |
| 6529 | 6529 | { |
@@ -6574,7 +6574,7 @@ discard block |
||
| 6574 | 6574 | * @param $str |
| 6575 | 6575 | * @param int $flags |
| 6576 | 6576 | * @param string $encode |
| 6577 | - * @return mixed |
|
| 6577 | + * @return null|string |
|
| 6578 | 6578 | */ |
| 6579 | 6579 | public function htmlspecialchars($str, $flags = ENT_COMPAT, $encode = '') |
| 6580 | 6580 | { |
@@ -6583,7 +6583,7 @@ discard block |
||
| 6583 | 6583 | } |
| 6584 | 6584 | |
| 6585 | 6585 | /** |
| 6586 | - * @param $string |
|
| 6586 | + * @param string $string |
|
| 6587 | 6587 | * @param bool $returnData |
| 6588 | 6588 | * @return bool|mixed |
| 6589 | 6589 | */ |
@@ -188,7 +188,7 @@ discard block |
||
| 188 | 188 | if(!function_exists('removeLastPath')) { |
| 189 | 189 | /** |
| 190 | 190 | * @param string $string |
| 191 | - * @return bool|string |
|
| 191 | + * @return string|false |
|
| 192 | 192 | */ |
| 193 | 193 | function removeLastPath($string) |
| 194 | 194 | { |
@@ -206,7 +206,7 @@ discard block |
||
| 206 | 206 | if(!function_exists('getExtension')) { |
| 207 | 207 | /** |
| 208 | 208 | * @param string $string |
| 209 | - * @return bool|string |
|
| 209 | + * @return string|false |
|
| 210 | 210 | * |
| 211 | 211 | * @TODO: not work if $string contains folder name with dot |
| 212 | 212 | */ |