Completed
Branch master (fd4772)
by Pierre-Henry
37:10
created
_protected/framework/File/File.class.php 1 patch
Doc Comments   +9 added lines, -5 removed lines patch added patch discarded remove patch
@@ -125,6 +125,7 @@  discard block
 block discarded – undo
125 125
      * Check if file exists.
126 126
      *
127 127
      * @param mixed (array | string) $mFile
128
+     * @param string $mFile
128 129
      * @return boolean TRUE if file exists, FALSE otherwise.
129 130
      */
130 131
     public function existFile($mFile)
@@ -278,6 +279,7 @@  discard block
 block discarded – undo
278 279
      *
279 280
      * @param mixed (string | array) $mDir
280 281
      * @param integer (octal) $iMode Default: 0777
282
+     * @param string $mDir
281 283
      * @return void
282 284
      * @throws Exception If the file cannot be created.
283 285
      */
@@ -326,7 +328,7 @@  discard block
 block discarded – undo
326 328
      *
327 329
      * @param string $sFrom File or directory.
328 330
      * @param string $sTo File or directory.
329
-     * @return mixed (integer | boolean) Returns the last line on success, and FALSE on failure.
331
+     * @return string|false (integer | boolean) Returns the last line on success, and FALSE on failure.
330 332
      */
331 333
     public function systemCopy($sFrom, $sTo)
332 334
     {
@@ -368,7 +370,7 @@  discard block
 block discarded – undo
368 370
      *
369 371
      * @param string $sFrom File or directory.
370 372
      * @param string $sTo File or directory.
371
-     * @return mixed (integer | boolean) Returns the last line on success, and FALSE on failure.
373
+     * @return string|false (integer | boolean) Returns the last line on success, and FALSE on failure.
372 374
      */
373 375
     public function systemRename($sFrom, $sTo)
374 376
     {
@@ -422,6 +424,7 @@  discard block
 block discarded – undo
422 424
      * Get the creation/modification time of a file in the Unix timestamp.
423 425
      *
424 426
      * @param string Full path of the file.
427
+     * @param string $sFile
425 428
      * @return mixed (integer | boolean) Returns the time the file was last modified, or FALSE if it not found.
426 429
      */
427 430
     public function getModifTime($sFile)
@@ -434,6 +437,7 @@  discard block
 block discarded – undo
434 437
      * Shortened form of self::getModifTime()
435 438
      *
436 439
      * @param string Full path of the file.
440
+     * @param string $sFile
437 441
      * @return integer Returns the latest modification time of the file in Unix timestamp.
438 442
      */
439 443
     public static function version($sFile)
@@ -445,7 +449,7 @@  discard block
 block discarded – undo
445 449
      * Delay script execution.
446 450
      *
447 451
      * @param integer $iSleep Halt time in seconds. Optional parameter, default value is 5.
448
-     * @return mixed (integer | boolean) Returns "0" on success, or "false" on error.
452
+     * @return integer (integer | boolean) Returns "0" on success, or "false" on error.
449 453
      */
450 454
     public function sleep($iSleep = null)
451 455
     {
@@ -689,7 +693,7 @@  discard block
 block discarded – undo
689 693
      * Get the URL contents (For URLs, it is better to use CURL because it is faster than file_get_contents function).
690 694
      *
691 695
      * @param string $sUrl URL to be read contents.
692
-     * @return mixed (string | boolean) Return the result content on success, FALSE on failure.
696
+     * @return string (string | boolean) Return the result content on success, FALSE on failure.
693 697
      */
694 698
     public function getUrlContents($sUrl)
695 699
     {
@@ -763,7 +767,7 @@  discard block
 block discarded – undo
763 767
      * Create a recurive directory iterator for a given directory.
764 768
      *
765 769
      * @param string $sPath
766
-     * @return string The directory.
770
+     * @return \RecursiveDirectoryIterator The directory.
767 771
      */
768 772
     public function getDirIterator($sPath)
769 773
     {
Please login to merge, or discard this patch.