@@ -270,6 +270,9 @@ discard block |
||
270 | 270 | return self::mb_detect_encoding($var, array($encoding)) || false !== @iconv($encoding, $encoding, $var); |
271 | 271 | } |
272 | 272 | |
273 | + /** |
|
274 | + * @return string |
|
275 | + */ |
|
273 | 276 | public static function mb_detect_encoding($str, $encodingList = null, $strict = false) |
274 | 277 | { |
275 | 278 | if (null === $encodingList) { |
@@ -574,6 +577,9 @@ discard block |
||
574 | 577 | return $code; |
575 | 578 | } |
576 | 579 | |
580 | + /** |
|
581 | + * @param boolean $part |
|
582 | + */ |
|
577 | 583 | private static function getSubpart($pos, $part, $haystack, $encoding) |
578 | 584 | { |
579 | 585 | if (false === $pos) { |
@@ -621,6 +627,9 @@ discard block |
||
621 | 627 | return self::mb_convert_case($s[0], MB_CASE_UPPER, 'UTF-8'); |
622 | 628 | } |
623 | 629 | |
630 | + /** |
|
631 | + * @param string $file |
|
632 | + */ |
|
624 | 633 | private static function getData($file) |
625 | 634 | { |
626 | 635 | if (file_exists($file = __DIR__.'/Resources/unidata/'.$file.'.php')) { |
@@ -222,7 +222,7 @@ discard block |
||
222 | 222 | /** |
223 | 223 | * Access the only instance of this class |
224 | 224 | * |
225 | - * @return object |
|
225 | + * @return MyTextSanitizer |
|
226 | 226 | * @static |
227 | 227 | * @staticvar object |
228 | 228 | */ |
@@ -394,7 +394,7 @@ discard block |
||
394 | 394 | * Replace XoopsCodes with their equivalent HTML formatting |
395 | 395 | * |
396 | 396 | * @param string $text |
397 | - * @param bool|int $allowimage Allow images in the text? |
|
397 | + * @param integer $allowimage Allow images in the text? |
|
398 | 398 | * On FALSE, uses links to images. |
399 | 399 | * @return string |
400 | 400 | */ |
@@ -480,7 +480,7 @@ discard block |
||
480 | 480 | * A quick solution for filtering XSS scripts |
481 | 481 | * |
482 | 482 | * @TODO : To be improved |
483 | - * @param $text |
|
483 | + * @param string $text |
|
484 | 484 | * @return mixed |
485 | 485 | */ |
486 | 486 | public function filterXss($text) |
@@ -576,11 +576,11 @@ discard block |
||
576 | 576 | * Filters textarea form data in DB for display |
577 | 577 | * |
578 | 578 | * @param string $text |
579 | - * @param bool|int $html allow html? |
|
580 | - * @param bool|int $smiley allow smileys? |
|
581 | - * @param bool|int $xcode allow xoopscode? |
|
582 | - * @param bool|int $image allow inline images? |
|
583 | - * @param bool|int $br convert linebreaks? |
|
579 | + * @param integer $html allow html? |
|
580 | + * @param integer $smiley allow smileys? |
|
581 | + * @param integer $xcode allow xoopscode? |
|
582 | + * @param integer $image allow inline images? |
|
583 | + * @param integer $br convert linebreaks? |
|
584 | 584 | * @return string |
585 | 585 | */ |
586 | 586 | public function &displayTarea($text, $html = 0, $smiley = 1, $xcode = 1, $image = 1, $br = 1) |
@@ -624,11 +624,11 @@ discard block |
||
624 | 624 | * Filters textarea form data submitted for preview |
625 | 625 | * |
626 | 626 | * @param string $text |
627 | - * @param bool|int $html allow html? |
|
628 | - * @param bool|int $smiley allow smileys? |
|
629 | - * @param bool|int $xcode allow xoopscode? |
|
630 | - * @param bool|int $image allow inline images? |
|
631 | - * @param bool|int $br convert linebreaks? |
|
627 | + * @param integer $html allow html? |
|
628 | + * @param integer $smiley allow smileys? |
|
629 | + * @param integer $xcode allow xoopscode? |
|
630 | + * @param integer $image allow inline images? |
|
631 | + * @param integer $br convert linebreaks? |
|
632 | 632 | * @return string |
633 | 633 | */ |
634 | 634 | public function &previewTarea($text, $html = 0, $smiley = 1, $xcode = 1, $image = 1, $br = 1) |
@@ -660,7 +660,7 @@ discard block |
||
660 | 660 | * MyTextSanitizer::codePreConv() |
661 | 661 | * |
662 | 662 | * @param mixed $text |
663 | - * @param mixed $xcode |
|
663 | + * @param integer $xcode |
|
664 | 664 | * @return mixed |
665 | 665 | */ |
666 | 666 | public function codePreConv($text, $xcode = 1) |
@@ -696,8 +696,8 @@ discard block |
||
696 | 696 | * MyTextSanitizer::codeConv() |
697 | 697 | * |
698 | 698 | * @param mixed $text |
699 | - * @param mixed $xcode |
|
700 | - * @return mixed |
|
699 | + * @param integer $xcode |
|
700 | + * @return string |
|
701 | 701 | */ |
702 | 702 | public function codeConv($text, $xcode = 1) |
703 | 703 | { |
@@ -713,7 +713,7 @@ discard block |
||
713 | 713 | /** |
714 | 714 | * MyTextSanitizer::executeExtensions() |
715 | 715 | * |
716 | - * @return bool |
|
716 | + * @return boolean|null |
|
717 | 717 | */ |
718 | 718 | public function executeExtensions() |
719 | 719 | { |
@@ -798,8 +798,8 @@ discard block |
||
798 | 798 | * MyTextSanitizer::codeSanitizer() |
799 | 799 | * |
800 | 800 | * @param mixed $str |
801 | - * @param mixed $image |
|
802 | - * @return mixed|string |
|
801 | + * @param integer $image |
|
802 | + * @return string |
|
803 | 803 | */ |
804 | 804 | public function codeSanitizer($str, $image = 1) |
805 | 805 | { |
@@ -816,8 +816,8 @@ discard block |
||
816 | 816 | * @param mixed $text |
817 | 817 | * @param integer $allowhtml |
818 | 818 | * @param integer $smiley |
819 | - * @param mixed $bbcode |
|
820 | - * @return mixed|string |
|
819 | + * @param integer $bbcode |
|
820 | + * @return string |
|
821 | 821 | */ |
822 | 822 | public function sanitizeForDisplay($text, $allowhtml = 0, $smiley = 1, $bbcode = 1) |
823 | 823 | { |
@@ -847,8 +847,8 @@ discard block |
||
847 | 847 | * @param mixed $text |
848 | 848 | * @param integer $allowhtml |
849 | 849 | * @param integer $smiley |
850 | - * @param mixed $bbcode |
|
851 | - * @return mixed|string |
|
850 | + * @param integer $bbcode |
|
851 | + * @return string |
|
852 | 852 | */ |
853 | 853 | public function sanitizeForPreview($text, $allowhtml = 0, $smiley = 1, $bbcode = 1) |
854 | 854 | { |
@@ -891,8 +891,8 @@ discard block |
||
891 | 891 | * MyTextSanitizer::makeTboxData4Show() |
892 | 892 | * |
893 | 893 | * @param mixed $text |
894 | - * @param mixed $smiley |
|
895 | - * @return mixed|string |
|
894 | + * @param integer $smiley |
|
895 | + * @return string |
|
896 | 896 | */ |
897 | 897 | public function makeTboxData4Show($text, $smiley = 0) |
898 | 898 | { |
@@ -919,8 +919,8 @@ discard block |
||
919 | 919 | * MyTextSanitizer::makeTboxData4Preview() |
920 | 920 | * |
921 | 921 | * @param mixed $text |
922 | - * @param mixed $smiley |
|
923 | - * @return mixed|string |
|
922 | + * @param integer $smiley |
|
923 | + * @return string |
|
924 | 924 | */ |
925 | 925 | public function makeTboxData4Preview($text, $smiley = 0) |
926 | 926 | { |
@@ -964,8 +964,8 @@ discard block |
||
964 | 964 | * @param mixed $text |
965 | 965 | * @param integer $html |
966 | 966 | * @param integer $smiley |
967 | - * @param mixed $xcode |
|
968 | - * @return mixed|string |
|
967 | + * @param integer $xcode |
|
968 | + * @return string |
|
969 | 969 | */ |
970 | 970 | public function &makeTareaData4Show(&$text, $html = 1, $smiley = 1, $xcode = 1) |
971 | 971 | { |
@@ -994,8 +994,8 @@ discard block |
||
994 | 994 | * @param mixed $text |
995 | 995 | * @param integer $html |
996 | 996 | * @param integer $smiley |
997 | - * @param mixed $xcode |
|
998 | - * @return mixed|string |
|
997 | + * @param integer $xcode |
|
998 | + * @return string |
|
999 | 999 | */ |
1000 | 1000 | public function &makeTareaData4Preview(&$text, $html = 1, $smiley = 1, $xcode = 1) |
1001 | 1001 | { |
@@ -79,7 +79,7 @@ discard block |
||
79 | 79 | * Tries to find and include a file for a cache engine and returns object instance |
80 | 80 | * |
81 | 81 | * @param $name Name of the engine |
82 | - * @return mixed $engine object or null |
|
82 | + * @return boolean $engine object or null |
|
83 | 83 | * @access private |
84 | 84 | */ |
85 | 85 | private function loadEngine($name) |
@@ -206,7 +206,7 @@ discard block |
||
206 | 206 | * |
207 | 207 | * @param string $key Identifier for the data |
208 | 208 | * @param mixed $value Data to be cached - anything except a resource |
209 | - * @param mixed $duration Optional - string configuration name OR how long to cache the data, either in seconds or a |
|
209 | + * @param string $duration Optional - string configuration name OR how long to cache the data, either in seconds or a |
|
210 | 210 | * string that can be parsed by the strtotime() function OR array('config' => 'default', 'duration' => '3600') |
211 | 211 | * @return boolean True if the data was successfully cached, false on failure |
212 | 212 | * @access public |
@@ -384,7 +384,7 @@ discard block |
||
384 | 384 | * generates a safe key |
385 | 385 | * |
386 | 386 | * @param string $key the key passed over |
387 | - * @return mixed string $key or false |
|
387 | + * @return false|string string $key or false |
|
388 | 388 | * @access private |
389 | 389 | */ |
390 | 390 | public function key($key) |
@@ -449,7 +449,7 @@ discard block |
||
449 | 449 | * @param string $key Identifier for the data |
450 | 450 | * @param mixed $value Data to be cached |
451 | 451 | * @param mixed $duration How long to cache the data, in seconds |
452 | - * @return boolean True if the data was successfully cached, false on failure |
|
452 | + * @return boolean|null True if the data was successfully cached, false on failure |
|
453 | 453 | * @access public |
454 | 454 | */ |
455 | 455 | public function write($key, $value, $duration = null) |
@@ -473,7 +473,7 @@ discard block |
||
473 | 473 | * Delete a key from the cache |
474 | 474 | * |
475 | 475 | * @param string $key Identifier for the data |
476 | - * @return boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed |
|
476 | + * @return boolean|null True if the value was successfully deleted, false if it didn't exist or couldn't be removed |
|
477 | 477 | * @access public |
478 | 478 | */ |
479 | 479 | public function delete($key) |
@@ -484,7 +484,7 @@ discard block |
||
484 | 484 | * Delete all keys from the cache |
485 | 485 | * |
486 | 486 | * @param boolean $check if true will check expiration, otherwise delete all |
487 | - * @return boolean True if the cache was successfully cleared, false otherwise |
|
487 | + * @return boolean|null True if the cache was successfully cleared, false otherwise |
|
488 | 488 | * @access public |
489 | 489 | */ |
490 | 490 | public function clear($check) |
@@ -494,7 +494,7 @@ discard block |
||
494 | 494 | /** |
495 | 495 | * Cache Engine settings |
496 | 496 | * |
497 | - * @return array settings |
|
497 | + * @return integer settings |
|
498 | 498 | * @access public |
499 | 499 | */ |
500 | 500 | public function settings() |
@@ -363,6 +363,9 @@ discard block |
||
363 | 363 | } |
364 | 364 | } |
365 | 365 | |
366 | + /** |
|
367 | + * @param integer $value |
|
368 | + */ |
|
366 | 369 | public static function eq($value, $value2, $message = '') |
367 | 370 | { |
368 | 371 | if ($value2 != $value) { |
@@ -937,6 +940,9 @@ discard block |
||
937 | 940 | return mb_strwidth($value, $encoding); |
938 | 941 | } |
939 | 942 | |
943 | + /** |
|
944 | + * @param string $message |
|
945 | + */ |
|
940 | 946 | protected static function reportInvalidArgument($message) |
941 | 947 | { |
942 | 948 | throw new InvalidArgumentException($message); |
@@ -160,6 +160,9 @@ discard block |
||
160 | 160 | } |
161 | 161 | |
162 | 162 | |
163 | + /** |
|
164 | + * @param string $type |
|
165 | + */ |
|
163 | 166 | private static function _colorize( $text, $type, $nlAfter = true ) |
164 | 167 | { |
165 | 168 | $nlAfter = $nlAfter ? PHP_EOL : ''; |
@@ -201,6 +204,10 @@ discard block |
||
201 | 204 | } |
202 | 205 | |
203 | 206 | |
207 | + /** |
|
208 | + * @param string $char |
|
209 | + * @param integer $repeat |
|
210 | + */ |
|
204 | 211 | private static function _char( $char, $repeat = null ) |
205 | 212 | { |
206 | 213 | switch ( Kint::enabled() ) { |
@@ -221,6 +228,9 @@ discard block |
||
221 | 228 | return $repeat ? str_repeat( $char, $repeat ) : $char; |
222 | 229 | } |
223 | 230 | |
231 | + /** |
|
232 | + * @param string $text |
|
233 | + */ |
|
224 | 234 | private static function _title( $text ) |
225 | 235 | { |
226 | 236 | $escaped = kintParser::escape( $text ); |
@@ -171,7 +171,6 @@ |
||
171 | 171 | /** |
172 | 172 | * called for each dump, opens the html tag |
173 | 173 | * |
174 | - * @param array $callee caller information taken from debug backtrace |
|
175 | 174 | * |
176 | 175 | * @return string |
177 | 176 | */ |
@@ -234,6 +234,9 @@ |
||
234 | 234 | } |
235 | 235 | |
236 | 236 | |
237 | + /** |
|
238 | + * @return string|null |
|
239 | + */ |
|
237 | 240 | public static function escape( $value, $encoding = null ) |
238 | 241 | { |
239 | 242 | if ( empty( $value ) ) return $value; |
@@ -90,6 +90,9 @@ |
||
90 | 90 | } |
91 | 91 | } |
92 | 92 | |
93 | + /** |
|
94 | + * @param integer $start |
|
95 | + */ |
|
93 | 96 | protected static function _substr( $string, $start, $end, $encoding = null ) |
94 | 97 | { |
95 | 98 | if ( function_exists( 'mb_substr' ) ) { |
@@ -107,7 +107,7 @@ discard block |
||
107 | 107 | * |
108 | 108 | * @param array $trace [OPTIONAL] you can pass your own trace, otherwise, `debug_backtrace` will be called |
109 | 109 | * |
110 | - * @return mixed |
|
110 | + * @return string|null |
|
111 | 111 | */ |
112 | 112 | public static function trace( $trace = null ) |
113 | 113 | { |
@@ -305,6 +305,9 @@ discard block |
||
305 | 305 | return $shortenedName; |
306 | 306 | } |
307 | 307 | |
308 | + /** |
|
309 | + * @return string |
|
310 | + */ |
|
308 | 311 | public static function getIdeLink( $file, $line ) |
309 | 312 | { |
310 | 313 | return str_replace( array( '%f', '%l' ), array( $file, $line ), self::$fileLinkFormat ); |
@@ -317,7 +320,7 @@ discard block |
||
317 | 320 | * @param int $lineNumber the line to display |
318 | 321 | * @param int $padding surrounding lines to show besides the main one |
319 | 322 | * |
320 | - * @return bool|string |
|
323 | + * @return false|string |
|
321 | 324 | */ |
322 | 325 | private static function _showSource( $file, $lineNumber, $padding = 7 ) |
323 | 326 | { |
@@ -590,7 +593,7 @@ discard block |
||
590 | 593 | * |
591 | 594 | * @param $step |
592 | 595 | * |
593 | - * @return array |
|
596 | + * @return boolean |
|
594 | 597 | */ |
595 | 598 | private static function _stepIsInternal( $step ) |
596 | 599 | { |