@@ -254,11 +254,8 @@ |
||
254 | 254 | /** |
255 | 255 | * Updates tags and favorites properties, if applicable. |
256 | 256 | * |
257 | - * @param string $path |
|
258 | 257 | * @param \Sabre\DAV\INode $node |
259 | - * @param array $requestedProperties |
|
260 | - * @param array $returnedProperties |
|
261 | - * @return bool success status |
|
258 | + * @return null|boolean success status |
|
262 | 259 | */ |
263 | 260 | public function updateProperties(array &$properties, array &$result, \Sabre\DAV\INode $node) { |
264 | 261 | if (!($node instanceof \OC_Connector_Sabre_Node)) { |
@@ -141,7 +141,7 @@ |
||
141 | 141 | * columns or sequences. |
142 | 142 | * |
143 | 143 | * @param string $seqName Name of the sequence object from which the ID should be returned. |
144 | - * @return string A string representation of the last inserted ID. |
|
144 | + * @return integer A string representation of the last inserted ID. |
|
145 | 145 | */ |
146 | 146 | public function lastInsertId($seqName = null) |
147 | 147 | { |
@@ -144,6 +144,9 @@ |
||
144 | 144 | return true; |
145 | 145 | } |
146 | 146 | |
147 | + /** |
|
148 | + * @param string $path |
|
149 | + */ |
|
147 | 150 | public function url_stat($path) { |
148 | 151 | if (isset(self::$data[$path])) { |
149 | 152 | $size = strlen(self::$data[$path]); |
@@ -247,7 +247,7 @@ |
||
247 | 247 | * use the one with the highest id gives the best result with the background scanner, since that is most |
248 | 248 | * likely the folder where we stopped scanning previously |
249 | 249 | * |
250 | - * @return string|bool the path of the folder or false when no folder matched |
|
250 | + * @return boolean the path of the folder or false when no folder matched |
|
251 | 251 | */ |
252 | 252 | public function getIncomplete() { |
253 | 253 | // not supported |
@@ -173,6 +173,7 @@ discard block |
||
173 | 173 | |
174 | 174 | /** |
175 | 175 | * @param callable $wrapper |
176 | + * @param string $wrapperName |
|
176 | 177 | */ |
177 | 178 | public static function addStorageWrapper($wrapperName, $wrapper) { |
178 | 179 | $mounts = self::getMountManager()->getAll(); |
@@ -299,6 +300,9 @@ discard block |
||
299 | 300 | } |
300 | 301 | } |
301 | 302 | |
303 | + /** |
|
304 | + * @param string $root |
|
305 | + */ |
|
302 | 306 | static public function init($user, $root) { |
303 | 307 | if (self::$defaultInstance) { |
304 | 308 | return false; |
@@ -565,11 +569,15 @@ discard block |
||
565 | 569 | |
566 | 570 | /** |
567 | 571 | * following functions are equivalent to their php builtin equivalents for arguments/return values. |
572 | + * @param string $path |
|
568 | 573 | */ |
569 | 574 | static public function mkdir($path) { |
570 | 575 | return self::$defaultInstance->mkdir($path); |
571 | 576 | } |
572 | 577 | |
578 | + /** |
|
579 | + * @param string $path |
|
580 | + */ |
|
573 | 581 | static public function rmdir($path) { |
574 | 582 | return self::$defaultInstance->rmdir($path); |
575 | 583 | } |
@@ -582,10 +590,16 @@ discard block |
||
582 | 590 | return self::$defaultInstance->readdir($path); |
583 | 591 | } |
584 | 592 | |
593 | + /** |
|
594 | + * @param string|null $path |
|
595 | + */ |
|
585 | 596 | static public function is_dir($path) { |
586 | 597 | return self::$defaultInstance->is_dir($path); |
587 | 598 | } |
588 | 599 | |
600 | + /** |
|
601 | + * @param string $path |
|
602 | + */ |
|
589 | 603 | static public function is_file($path) { |
590 | 604 | return self::$defaultInstance->is_file($path); |
591 | 605 | } |
@@ -598,10 +612,16 @@ discard block |
||
598 | 612 | return self::$defaultInstance->filetype($path); |
599 | 613 | } |
600 | 614 | |
615 | + /** |
|
616 | + * @param string $path |
|
617 | + */ |
|
601 | 618 | static public function filesize($path) { |
602 | 619 | return self::$defaultInstance->filesize($path); |
603 | 620 | } |
604 | 621 | |
622 | + /** |
|
623 | + * @param string $path |
|
624 | + */ |
|
605 | 625 | static public function readfile($path) { |
606 | 626 | return self::$defaultInstance->readfile($path); |
607 | 627 | } |
@@ -610,6 +630,9 @@ discard block |
||
610 | 630 | return self::$defaultInstance->isCreatable($path); |
611 | 631 | } |
612 | 632 | |
633 | + /** |
|
634 | + * @param string $path |
|
635 | + */ |
|
613 | 636 | static public function isReadable($path) { |
614 | 637 | return self::$defaultInstance->isReadable($path); |
615 | 638 | } |
@@ -622,6 +645,9 @@ discard block |
||
622 | 645 | return self::$defaultInstance->isDeletable($path); |
623 | 646 | } |
624 | 647 | |
648 | + /** |
|
649 | + * @param string $path |
|
650 | + */ |
|
625 | 651 | static public function isSharable($path) { |
626 | 652 | return self::$defaultInstance->isSharable($path); |
627 | 653 | } |
@@ -634,33 +660,56 @@ discard block |
||
634 | 660 | return self::$defaultInstance->filemtime($path); |
635 | 661 | } |
636 | 662 | |
663 | + /** |
|
664 | + * @param string $path |
|
665 | + * @param integer $mtime |
|
666 | + */ |
|
637 | 667 | static public function touch($path, $mtime = null) { |
638 | 668 | return self::$defaultInstance->touch($path, $mtime); |
639 | 669 | } |
640 | 670 | |
641 | 671 | /** |
672 | + * @param string $path |
|
642 | 673 | * @return string |
643 | 674 | */ |
644 | 675 | static public function file_get_contents($path) { |
645 | 676 | return self::$defaultInstance->file_get_contents($path); |
646 | 677 | } |
647 | 678 | |
679 | + /** |
|
680 | + * @param string $path |
|
681 | + * @param string $data |
|
682 | + */ |
|
648 | 683 | static public function file_put_contents($path, $data) { |
649 | 684 | return self::$defaultInstance->file_put_contents($path, $data); |
650 | 685 | } |
651 | 686 | |
687 | + /** |
|
688 | + * @param string $path |
|
689 | + */ |
|
652 | 690 | static public function unlink($path) { |
653 | 691 | return self::$defaultInstance->unlink($path); |
654 | 692 | } |
655 | 693 | |
694 | + /** |
|
695 | + * @param string $path1 |
|
696 | + * @param string $path2 |
|
697 | + */ |
|
656 | 698 | static public function rename($path1, $path2) { |
657 | 699 | return self::$defaultInstance->rename($path1, $path2); |
658 | 700 | } |
659 | 701 | |
702 | + /** |
|
703 | + * @param string $path2 |
|
704 | + */ |
|
660 | 705 | static public function copy($path1, $path2) { |
661 | 706 | return self::$defaultInstance->copy($path1, $path2); |
662 | 707 | } |
663 | 708 | |
709 | + /** |
|
710 | + * @param string|null $path |
|
711 | + * @param string $mode |
|
712 | + */ |
|
664 | 713 | static public function fopen($path, $mode) { |
665 | 714 | return self::$defaultInstance->fopen($path, $mode); |
666 | 715 | } |
@@ -676,6 +725,9 @@ discard block |
||
676 | 725 | return self::$defaultInstance->fromTmpFile($tmpFile, $path); |
677 | 726 | } |
678 | 727 | |
728 | + /** |
|
729 | + * @param string $path |
|
730 | + */ |
|
679 | 731 | static public function getMimeType($path) { |
680 | 732 | return self::$defaultInstance->getMimeType($path); |
681 | 733 | } |
@@ -688,6 +740,9 @@ discard block |
||
688 | 740 | return self::$defaultInstance->free_space($path); |
689 | 741 | } |
690 | 742 | |
743 | + /** |
|
744 | + * @param string $query |
|
745 | + */ |
|
691 | 746 | static public function search($query) { |
692 | 747 | return self::$defaultInstance->search($query); |
693 | 748 | } |
@@ -562,7 +562,7 @@ |
||
562 | 562 | * This will either throw StorageInvalidException, StorageNotAvailableException |
563 | 563 | * or do nothing. |
564 | 564 | * |
565 | - * @param \Sabre\Dav\Exception $e sabre exception |
|
565 | + * @param \Exception $e sabre exception |
|
566 | 566 | * |
567 | 567 | * @throws StorageInvalidException if the storage is invalid, for example |
568 | 568 | * when the authentication expired or is invalid |
@@ -134,7 +134,7 @@ discard block |
||
134 | 134 | * and doesn't take the chroot into account ) |
135 | 135 | * |
136 | 136 | * @param string $path |
137 | - * @return \OCP\Files\Mount\IMountPoint |
|
137 | + * @return Mount\MountPoint|null |
|
138 | 138 | */ |
139 | 139 | public function getMount($path) { |
140 | 140 | return Filesystem::getMountManager()->find($this->getAbsolutePath($path)); |
@@ -366,6 +366,10 @@ discard block |
||
366 | 366 | return $this->basicOperation('file_get_contents', $path, array('read')); |
367 | 367 | } |
368 | 368 | |
369 | + /** |
|
370 | + * @param string|null $path |
|
371 | + * @param boolean $run |
|
372 | + */ |
|
369 | 373 | protected function emit_file_hooks_pre($exists, $path, &$run) { |
370 | 374 | if (!$exists) { |
371 | 375 | \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_create, array( |
@@ -384,6 +388,9 @@ discard block |
||
384 | 388 | )); |
385 | 389 | } |
386 | 390 | |
391 | + /** |
|
392 | + * @param string|null $path |
|
393 | + */ |
|
387 | 394 | protected function emit_file_hooks_post($exists, $path) { |
388 | 395 | if (!$exists) { |
389 | 396 | \OC_Hook::emit(Filesystem::CLASSNAME, Filesystem::signal_post_create, array( |
@@ -591,7 +598,7 @@ discard block |
||
591 | 598 | * @param string $path2 target path |
592 | 599 | * @param bool $preserveMtime whether to preserve mtime on the copy |
593 | 600 | * |
594 | - * @return bool|mixed |
|
601 | + * @return string |
|
595 | 602 | */ |
596 | 603 | public function copy($path1, $path2, $preserveMtime = false) { |
597 | 604 | $postFix1 = (substr($path1, -1, 1) === '/') ? '/' : ''; |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | * @param string $route |
104 | 104 | * @param array $parameters |
105 | 105 | * @return |
106 | - * @internal param array $args with param=>value, will be appended to the returned url |
|
106 | + string @internal param array $args with param=>value, will be appended to the returned url |
|
107 | 107 | * @return string the url |
108 | 108 | * |
109 | 109 | * Returns a url to the given app and file. |
@@ -277,6 +277,9 @@ discard block |
||
277 | 277 | return self::linkToRoute( 'core_ajax_preview', array('x' => 36, 'y' => 36, 'file' => $path )); |
278 | 278 | } |
279 | 279 | |
280 | + /** |
|
281 | + * @param string $path |
|
282 | + */ |
|
280 | 283 | public static function publicPreviewIcon( $path, $token ) { |
281 | 284 | return self::linkToRoute( 'core_ajax_public_preview', array('x' => 36, 'y' => 36, 'file' => $path, 't' => $token)); |
282 | 285 | } |
@@ -360,7 +363,7 @@ discard block |
||
360 | 363 | /** |
361 | 364 | * Make a computer file size |
362 | 365 | * @param string $str file size in human readable format |
363 | - * @return int a file size in bytes |
|
366 | + * @return double a file size in bytes |
|
364 | 367 | * |
365 | 368 | * Makes 2kB to 2048. |
366 | 369 | * |
@@ -913,7 +916,7 @@ discard block |
||
913 | 916 | * |
914 | 917 | * @param string $path |
915 | 918 | * @param \OCP\Files\FileInfo $rootInfo (optional) |
916 | - * @return array |
|
919 | + * @return string |
|
917 | 920 | */ |
918 | 921 | public static function getStorageInfo($path, $rootInfo = null) { |
919 | 922 | // return storage info without adding mount points |
@@ -80,7 +80,7 @@ |
||
80 | 80 | } |
81 | 81 | |
82 | 82 | /** |
83 | - * @param $transFile |
|
83 | + * @param string $transFile |
|
84 | 84 | * @param bool $mergeTranslations |
85 | 85 | * @return bool |
86 | 86 | */ |