@@ -217,7 +217,7 @@ discard block |
||
| 217 | 217 | } |
| 218 | 218 | |
| 219 | 219 | /** |
| 220 | - * @return mixed |
|
| 220 | + * @return boolean |
|
| 221 | 221 | */ |
| 222 | 222 | public function getEnableGeolocation() |
| 223 | 223 | { |
@@ -445,7 +445,7 @@ discard block |
||
| 445 | 445 | * |
| 446 | 446 | * @param string $address an address |
| 447 | 447 | * |
| 448 | - * @return array array with precision, lat & lng |
|
| 448 | + * @return string array with precision, lat & lng |
|
| 449 | 449 | */ |
| 450 | 450 | public function geocoding($address) |
| 451 | 451 | { |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | /** |
| 92 | 92 | * @static |
| 93 | 93 | * @param integer $iStatus The "code" for the HTTP status |
| 94 | - * @return mixed (string | boolean) $iStatus Returns the "HTTP status code" if found otherwise returns "false" |
|
| 94 | + * @return integer (string | boolean) $iStatus Returns the "HTTP status code" if found otherwise returns "false" |
|
| 95 | 95 | */ |
| 96 | 96 | public static function getStatusCodes($iStatus) |
| 97 | 97 | { |
@@ -129,6 +129,7 @@ discard block |
||
| 129 | 129 | * |
| 130 | 130 | * @static |
| 131 | 131 | * @param mixed (string | array) $mHeaders Headers to send. |
| 132 | + * @param string $mHeaders |
|
| 132 | 133 | * @throws \PH7\Framework\Http\Exception |
| 133 | 134 | */ |
| 134 | 135 | public static function setHeaders($mHeaders) |
@@ -188,7 +189,7 @@ discard block |
||
| 188 | 189 | * @static |
| 189 | 190 | * @param string $sUsr |
| 190 | 191 | * @param string $sPwd |
| 191 | - * @return boolean TRUE if the authentication is correct, otherwise FALSE. |
|
| 192 | + * @return null|boolean TRUE if the authentication is correct, otherwise FALSE. |
|
| 192 | 193 | */ |
| 193 | 194 | public static function requireAuth($sUsr, $sPwd) |
| 194 | 195 | { |
@@ -283,6 +283,10 @@ discard block |
||
| 283 | 283 | } |
| 284 | 284 | |
| 285 | 285 | /*This method restores the serialized form instance.*/ |
| 286 | + |
|
| 287 | + /** |
|
| 288 | + * @param string $id |
|
| 289 | + */ |
|
| 286 | 290 | private static function recover($id) |
| 287 | 291 | { |
| 288 | 292 | if(!empty($_SESSION['pfbc'][$id]['form'])) |
@@ -483,6 +487,10 @@ discard block |
||
| 483 | 487 | |
| 484 | 488 | /*Valldation errors are saved in the session after the form submission, and will be displayed to the user |
| 485 | 489 | when redirected back to the form.*/ |
| 490 | + |
|
| 491 | + /** |
|
| 492 | + * @param string $id |
|
| 493 | + */ |
|
| 486 | 494 | public static function setError($id, $messages, $element = '') |
| 487 | 495 | { |
| 488 | 496 | if (!is_array($messages)) |
@@ -496,11 +504,18 @@ discard block |
||
| 496 | 504 | } |
| 497 | 505 | |
| 498 | 506 | /*setSuccess*/ |
| 507 | + |
|
| 508 | + /** |
|
| 509 | + * @param string $id |
|
| 510 | + */ |
|
| 499 | 511 | public static function setSuccess($id, $message, $element = '') |
| 500 | 512 | { |
| 501 | 513 | return (new Design)->setFlashMsg($message, Design::SUCCESS_TYPE); |
| 502 | 514 | } |
| 503 | 515 | |
| 516 | + /** |
|
| 517 | + * @param string $id |
|
| 518 | + */ |
|
| 504 | 519 | public static function setSessionValue($id, $element, $value) |
| 505 | 520 | { |
| 506 | 521 | $_SESSION['pfbc'][$id]['values'][$element] = $value; |
@@ -35,7 +35,7 @@ |
||
| 35 | 35 | * @see get() |
| 36 | 36 | * |
| 37 | 37 | * @param boolean $bPrint Default FALSE |
| 38 | - * @return void |
|
| 38 | + * @return null|string |
|
| 39 | 39 | */ |
| 40 | 40 | public function display($bPrint = false) |
| 41 | 41 | { |
@@ -108,6 +108,7 @@ discard block |
||
| 108 | 108 | * |
| 109 | 109 | * @param mixed (array or string) $mKey The key of the request or an array with the list of key of the variables request. |
| 110 | 110 | * @param string $sParam Optional parameter, check the type of the request variable | Value type is: str, int, float, bool |
| 111 | + * @param string $mKey |
|
| 111 | 112 | * @return boolean |
| 112 | 113 | */ |
| 113 | 114 | public function postExists($mKey, $sParam = null) |
@@ -280,6 +281,7 @@ discard block |
||
| 280 | 281 | } |
| 281 | 282 | |
| 282 | 283 | /** |
| 284 | + * @param string $sUrl |
|
| 283 | 285 | * @return string The correct pH7's URL. |
| 284 | 286 | */ |
| 285 | 287 | public function pH7Url($sUrl) |
@@ -77,7 +77,7 @@ discard block |
||
| 77 | 77 | * Count the length of a string and supports the special characters (Asian, Latin, ...). |
| 78 | 78 | * |
| 79 | 79 | * @param string $sText |
| 80 | - * @return string |
|
| 80 | + * @return integer |
|
| 81 | 81 | */ |
| 82 | 82 | public function length($sText) |
| 83 | 83 | { |
@@ -115,8 +115,8 @@ discard block |
||
| 115 | 115 | * Test the equality of two strings. |
| 116 | 116 | * |
| 117 | 117 | * @personal For the PHP AND C functions, strcmp and strcasecmp returns a positive or negative integer value if they are different and 0 if they are equal. |
| 118 | - * @param string $text1 |
|
| 119 | - * @param string $text2 |
|
| 118 | + * @param string $sText1 |
|
| 119 | + * @param string $sText2 |
|
| 120 | 120 | * @return boolean |
| 121 | 121 | */ |
| 122 | 122 | public function equals($sText1, $sText2) |
@@ -298,7 +298,7 @@ discard block |
||
| 298 | 298 | * @access protected |
| 299 | 299 | * @param string $sText |
| 300 | 300 | * @param boolean $bStrip |
| 301 | - * @return The text parsed with Str::stripTags() method if $bStrip parameter is TRUE, otherwise with Str::htmlSpecialChars method. |
|
| 301 | + * @return string text parsed with Str::stripTags() method if $bStrip parameter is TRUE, otherwise with Str::htmlSpecialChars method. |
|
| 302 | 302 | */ |
| 303 | 303 | protected function cEscape($sText, $bStrip) |
| 304 | 304 | { |
@@ -325,6 +325,9 @@ discard block |
||
| 325 | 325 | return htmlspecialchars($sText, ENT_QUOTES, 'utf-8'); |
| 326 | 326 | } |
| 327 | 327 | |
| 328 | + /** |
|
| 329 | + * @param string $sPattern |
|
| 330 | + */ |
|
| 328 | 331 | private static function _regexNormalize($sPattern) |
| 329 | 332 | { |
| 330 | 333 | return self::$_sRegexDelimiter . trim($sPattern, self::$_sRegexDelimiter) . self::$_sRegexDelimiter; |
@@ -78,6 +78,9 @@ discard block |
||
| 78 | 78 | } |
| 79 | 79 | } |
| 80 | 80 | |
| 81 | + /** |
|
| 82 | + * @param integer $bytes |
|
| 83 | + */ |
|
| 81 | 84 | function read($bytes) { |
| 82 | 85 | return $this->STREAM->read($bytes); |
| 83 | 86 | } |
@@ -86,6 +89,7 @@ discard block |
||
| 86 | 89 | * Reads an array of Integers from the Stream |
| 87 | 90 | * |
| 88 | 91 | * @param int count How many elements should be read |
| 92 | + * @param integer $count |
|
| 89 | 93 | * @return Array of Integers |
| 90 | 94 | */ |
| 91 | 95 | function readintarray($count) { |
@@ -103,6 +107,7 @@ discard block |
||
| 103 | 107 | * |
| 104 | 108 | * @param object Reader the StreamReader object |
| 105 | 109 | * @param boolean enable_cache Enable or disable caching of strings (default on) |
| 110 | + * @param FileReader|null $Reader |
|
| 106 | 111 | */ |
| 107 | 112 | public function __construct($Reader, $enable_cache = true) { |
| 108 | 113 | // If there isn't a StreamReader, turn on short circuit mode. |
@@ -177,6 +182,7 @@ discard block |
||
| 177 | 182 | * |
| 178 | 183 | * @access private |
| 179 | 184 | * @param int num Offset number of original string |
| 185 | + * @param integer $num |
|
| 180 | 186 | * @return string Requested string if found, otherwise '' |
| 181 | 187 | */ |
| 182 | 188 | function get_original_string($num) { |
@@ -194,6 +200,7 @@ discard block |
||
| 194 | 200 | * |
| 195 | 201 | * @access private |
| 196 | 202 | * @param int num Offset number of original string |
| 203 | + * @param integer $num |
|
| 197 | 204 | * @return string Requested string if found, otherwise '' |
| 198 | 205 | */ |
| 199 | 206 | function get_translation_string($num) { |
@@ -279,6 +286,7 @@ discard block |
||
| 279 | 286 | * Sanitize plural form expression for use in PHP eval call. |
| 280 | 287 | * |
| 281 | 288 | * @access private |
| 289 | + * @param string $expr |
|
| 282 | 290 | * @return string sanitized plural form expression |
| 283 | 291 | */ |
| 284 | 292 | function sanitize_plural_expression($expr) { |
@@ -380,7 +388,8 @@ discard block |
||
| 380 | 388 | * @param string single |
| 381 | 389 | * @param string plural |
| 382 | 390 | * @param string number |
| 383 | - * @return translated plural form |
|
| 391 | + * @param string $single |
|
| 392 | + * @return string plural form |
|
| 384 | 393 | */ |
| 385 | 394 | function ngettext($single, $plural, $number) { |
| 386 | 395 | if ($this->short_circuit) { |
@@ -92,6 +92,9 @@ |
||
| 92 | 92 | var $_fd; |
| 93 | 93 | var $_length; |
| 94 | 94 | |
| 95 | + /** |
|
| 96 | + * @param string $filename |
|
| 97 | + */ |
|
| 95 | 98 | public function __construct($filename) { |
| 96 | 99 | if (file_exists($filename)) { |
| 97 | 100 | |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | * Get image type if it is one of: .gif, .jpg or .png |
| 62 | 62 | * |
| 63 | 63 | * @param string $file Full path to file |
| 64 | - * @return string|boolean |
|
| 64 | + * @return string|false |
|
| 65 | 65 | */ |
| 66 | 66 | static public function type($file) { |
| 67 | 67 | $type = getimagesize($file); |