@@ -316,7 +316,7 @@ |
||
| 316 | 316 | * |
| 317 | 317 | * @param string $url URL that was passed to opendir() and that this object is expected to explore. |
| 318 | 318 | * @param $options |
| 319 | - * @return booelan |
|
| 319 | + * @return boolean |
|
| 320 | 320 | */ |
| 321 | 321 | function dir_opendir ( $url, $options ) |
| 322 | 322 | { |
@@ -98,7 +98,6 @@ discard block |
||
| 98 | 98 | /** |
| 99 | 99 | * Protected constructor called via self::create_session |
| 100 | 100 | * |
| 101 | - * @param string $token |
|
| 102 | 101 | * @param array $share |
| 103 | 102 | */ |
| 104 | 103 | protected function __construct(array $share) |
@@ -109,6 +108,7 @@ discard block |
||
| 109 | 108 | |
| 110 | 109 | /** |
| 111 | 110 | * Get token from url |
| 111 | + * @return string |
|
| 112 | 112 | */ |
| 113 | 113 | public static function get_token() |
| 114 | 114 | { |
@@ -506,7 +506,7 @@ discard block |
||
| 506 | 506 | * |
| 507 | 507 | * If you have cached data in your stream but not yet stored it into the underlying storage, you should do so now. |
| 508 | 508 | * |
| 509 | - * @return booelan TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored. |
|
| 509 | + * @return boolean TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored. |
|
| 510 | 510 | */ |
| 511 | 511 | function stream_flush ( ) |
| 512 | 512 | { |
@@ -547,6 +547,7 @@ discard block |
||
| 547 | 547 | * In order for the appropriate error message to be returned, do not define this method if your wrapper does not support unlinking! |
| 548 | 548 | * |
| 549 | 549 | * @param string $url |
| 550 | + * @param integer $parent_stat |
|
| 550 | 551 | * @return boolean TRUE on success or FALSE on failure |
| 551 | 552 | */ |
| 552 | 553 | static function unlink ( $url, $parent_stat=null ) |
@@ -675,6 +676,8 @@ discard block |
||
| 675 | 676 | |
| 676 | 677 | /** |
| 677 | 678 | * due to problems with recursive directory creation, we have our own here |
| 679 | + * @param false|string $pathname |
|
| 680 | + * @param integer $mode |
|
| 678 | 681 | */ |
| 679 | 682 | protected static function mkdir_recursive($pathname, $mode, $depth=0) |
| 680 | 683 | { |
@@ -1005,7 +1008,7 @@ discard block |
||
| 1005 | 1008 | * |
| 1006 | 1009 | * @param string $url URL that was passed to opendir() and that this object is expected to explore. |
| 1007 | 1010 | * @param int $options |
| 1008 | - * @return booelan |
|
| 1011 | + * @return boolean |
|
| 1009 | 1012 | */ |
| 1010 | 1013 | function dir_opendir ( $url, $options ) |
| 1011 | 1014 | { |
@@ -1405,7 +1408,7 @@ discard block |
||
| 1405 | 1408 | * |
| 1406 | 1409 | * @param string $path string with path |
| 1407 | 1410 | * @param int $rights =null rights to set, or null to delete the entry |
| 1408 | - * @param int|boolean $owner =null owner for whom to set the rights, null for the current user, or false to delete all rights for $path |
|
| 1411 | + * @param boolean $owner =null owner for whom to set the rights, null for the current user, or false to delete all rights for $path |
|
| 1409 | 1412 | * @param int $fs_id =null fs_id to use, to not query it again (eg. because it's already deleted) |
| 1410 | 1413 | * @return boolean true if acl is set/deleted, false on error |
| 1411 | 1414 | */ |
@@ -1707,7 +1710,7 @@ discard block |
||
| 1707 | 1710 | /** |
| 1708 | 1711 | * Just a little abstration 'til I know how to organise stuff like that with PDO |
| 1709 | 1712 | * |
| 1710 | - * @param mixed $time |
|
| 1713 | + * @param integer $time |
|
| 1711 | 1714 | * @return string Y-m-d H:i:s |
| 1712 | 1715 | */ |
| 1713 | 1716 | static protected function _pdo_timestamp($time) |
@@ -1792,6 +1795,7 @@ discard block |
||
| 1792 | 1795 | * Replace the password of an url with '...' for error messages |
| 1793 | 1796 | * |
| 1794 | 1797 | * @param string &$url |
| 1798 | + * @param string $url |
|
| 1795 | 1799 | */ |
| 1796 | 1800 | static protected function _remove_password(&$url) |
| 1797 | 1801 | { |
@@ -1807,7 +1811,7 @@ discard block |
||
| 1807 | 1811 | /** |
| 1808 | 1812 | * Get storage mode from url (get parameter 'storage', eg. ?storage=db) |
| 1809 | 1813 | * |
| 1810 | - * @param string|array $url complete url or array of url-parts from parse_url |
|
| 1814 | + * @param string $url complete url or array of url-parts from parse_url |
|
| 1811 | 1815 | * @return int self::STORE2FS or self::STORE2DB |
| 1812 | 1816 | */ |
| 1813 | 1817 | static function url2operation($url) |
@@ -454,7 +454,7 @@ discard block |
||
| 454 | 454 | * |
| 455 | 455 | * If you have cached data in your stream but not yet stored it into the underlying storage, you should do so now. |
| 456 | 456 | * |
| 457 | - * @return booelan TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored. |
|
| 457 | + * @return boolean TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored. |
|
| 458 | 458 | */ |
| 459 | 459 | function stream_flush ( ) |
| 460 | 460 | { |
@@ -856,7 +856,7 @@ discard block |
||
| 856 | 856 | * This method is called immediately when your stream object is created for examining directory contents with opendir(). |
| 857 | 857 | * |
| 858 | 858 | * @param string $path URL that was passed to opendir() and that this object is expected to explore. |
| 859 | - * @return booelan |
|
| 859 | + * @return boolean |
|
| 860 | 860 | */ |
| 861 | 861 | function dir_opendir ( $path, $options ) |
| 862 | 862 | { |
@@ -1213,7 +1213,7 @@ discard block |
||
| 1213 | 1213 | * It should reset the output generated by dir_readdir(). i.e.: |
| 1214 | 1214 | * The next call to dir_readdir() should return the first entry in the location returned by dir_opendir(). |
| 1215 | 1215 | * |
| 1216 | - * @return boolean |
|
| 1216 | + * @return boolean|null |
|
| 1217 | 1217 | */ |
| 1218 | 1218 | function dir_rewinddir ( ) |
| 1219 | 1219 | { |
@@ -1227,7 +1227,7 @@ discard block |
||
| 1227 | 1227 | * |
| 1228 | 1228 | * You should release any resources which were locked or allocated during the opening and use of the directory stream. |
| 1229 | 1229 | * |
| 1230 | - * @return boolean |
|
| 1230 | + * @return boolean|null |
|
| 1231 | 1231 | */ |
| 1232 | 1232 | function dir_closedir ( ) |
| 1233 | 1233 | { |
@@ -45,6 +45,7 @@ discard block |
||
| 45 | 45 | * This method is called when the stream is closed, using fclose(). |
| 46 | 46 | * |
| 47 | 47 | * You must release any resources that were locked or allocated by the stream. |
| 48 | + * @return boolean |
|
| 48 | 49 | */ |
| 49 | 50 | function stream_close ( ); |
| 50 | 51 | |
@@ -57,7 +58,7 @@ discard block |
||
| 57 | 58 | * You must also update the read/write position of the stream by the number of bytes that were successfully read. |
| 58 | 59 | * |
| 59 | 60 | * @param int $count |
| 60 | - * @return string/false up to count bytes read or false on EOF |
|
| 61 | + * @return string|false up to count bytes read or false on EOF |
|
| 61 | 62 | */ |
| 62 | 63 | function stream_read ( $count ); |
| 63 | 64 | |
@@ -114,7 +115,7 @@ discard block |
||
| 114 | 115 | * |
| 115 | 116 | * If you have cached data in your stream but not yet stored it into the underlying storage, you should do so now. |
| 116 | 117 | * |
| 117 | - * @return booelan TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored. |
|
| 118 | + * @return boolean TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored. |
|
| 118 | 119 | */ |
| 119 | 120 | function stream_flush ( ); |
| 120 | 121 | |
@@ -188,7 +189,7 @@ discard block |
||
| 188 | 189 | * This method is called immediately when your stream object is created for examining directory contents with opendir(). |
| 189 | 190 | * |
| 190 | 191 | * @param string $path URL that was passed to opendir() and that this object is expected to explore. |
| 191 | - * @return booelan |
|
| 192 | + * @return boolean |
|
| 192 | 193 | */ |
| 193 | 194 | function dir_opendir ( $path, $options ); |
| 194 | 195 | |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | * Reimplemented to not check our vfs base path with realpath and connect to mysql DB |
| 58 | 58 | * |
| 59 | 59 | * @access public |
| 60 | - * @param $prefix =null prefix filesystem path with given path, eg. "/webdav" for owncloud 4.5 remote.php |
|
| 60 | + * @param string $prefix =null prefix filesystem path with given path, eg. "/webdav" for owncloud 4.5 remote.php |
|
| 61 | 61 | */ |
| 62 | 62 | function ServeRequest($prefix=null) |
| 63 | 63 | { |
@@ -76,7 +76,7 @@ discard block |
||
| 76 | 76 | * DELETE method handler |
| 77 | 77 | * |
| 78 | 78 | * @param array general parameter passing array |
| 79 | - * @return bool true on success |
|
| 79 | + * @return string true on success |
|
| 80 | 80 | */ |
| 81 | 81 | function DELETE($options) |
| 82 | 82 | { |
@@ -116,7 +116,7 @@ discard block |
||
| 116 | 116 | * Reimplemented to NOT use dirname/basename, which has problems with utf-8 chars |
| 117 | 117 | * |
| 118 | 118 | * @param array general parameter passing array |
| 119 | - * @return bool true on success |
|
| 119 | + * @return string true on success |
|
| 120 | 120 | */ |
| 121 | 121 | function MKCOL($options) |
| 122 | 122 | { |
@@ -151,7 +151,7 @@ discard block |
||
| 151 | 151 | * COPY method handler |
| 152 | 152 | * |
| 153 | 153 | * @param array general parameter passing array |
| 154 | - * @return bool true on success |
|
| 154 | + * @return string true on success |
|
| 155 | 155 | */ |
| 156 | 156 | function COPY($options, $del=false) |
| 157 | 157 | { |
@@ -477,7 +477,7 @@ discard block |
||
| 477 | 477 | * but in the regular vfs attributes. |
| 478 | 478 | * |
| 479 | 479 | * @param array general parameter passing array |
| 480 | - * @return bool true on success |
|
| 480 | + * @return string true on success |
|
| 481 | 481 | */ |
| 482 | 482 | function PROPPATCH(&$options) |
| 483 | 483 | { |
@@ -557,7 +557,7 @@ discard block |
||
| 557 | 557 | * LOCK method handler |
| 558 | 558 | * |
| 559 | 559 | * @param array general parameter passing array |
| 560 | - * @return bool true on success |
|
| 560 | + * @return string|boolean true on success |
|
| 561 | 561 | */ |
| 562 | 562 | function LOCK(&$options) |
| 563 | 563 | { |
@@ -583,7 +583,7 @@ discard block |
||
| 583 | 583 | * UNLOCK method handler |
| 584 | 584 | * |
| 585 | 585 | * @param array general parameter passing array |
| 586 | - * @return bool true on success |
|
| 586 | + * @return string true on success |
|
| 587 | 587 | */ |
| 588 | 588 | function UNLOCK(&$options) |
| 589 | 589 | { |
@@ -640,7 +640,7 @@ discard block |
||
| 640 | 640 | * Reimplement to add a Content-Disposition header, if ?download is appended to the REQUEST_URI |
| 641 | 641 | * |
| 642 | 642 | * @param array parameter passing array |
| 643 | - * @return bool true on success |
|
| 643 | + * @return boolean|null true on success |
|
| 644 | 644 | */ |
| 645 | 645 | function GET(&$options) |
| 646 | 646 | { |
@@ -2170,6 +2170,9 @@ discard block |
||
| 2170 | 2170 | |
| 2171 | 2171 | // {{{ _copymove() |
| 2172 | 2172 | |
| 2173 | + /** |
|
| 2174 | + * @param string $what |
|
| 2175 | + */ |
|
| 2173 | 2176 | function _copymove($what) |
| 2174 | 2177 | { |
| 2175 | 2178 | $options = Array(); |
@@ -2509,7 +2512,7 @@ discard block |
||
| 2509 | 2512 | * defined in RFC 2518 section 9.4 |
| 2510 | 2513 | * |
| 2511 | 2514 | * @param void |
| 2512 | - * @return void |
|
| 2515 | + * @return boolean |
|
| 2513 | 2516 | */ |
| 2514 | 2517 | function _check_if_header_conditions() |
| 2515 | 2518 | { |
@@ -2581,6 +2584,7 @@ discard block |
||
| 2581 | 2584 | * |
| 2582 | 2585 | * @param string path of resource to check |
| 2583 | 2586 | * @param bool exclusive lock? |
| 2587 | + * @param string $path |
|
| 2584 | 2588 | */ |
| 2585 | 2589 | function _check_lock_status($path, $exclusive_only = false) |
| 2586 | 2590 | { |
@@ -2733,6 +2737,7 @@ discard block |
||
| 2733 | 2737 | * not really needed but added for completenes |
| 2734 | 2738 | * |
| 2735 | 2739 | * @param string URL to decode |
| 2740 | + * @param string $path |
|
| 2736 | 2741 | * @return string decoded URL |
| 2737 | 2742 | */ |
| 2738 | 2743 | public static function _urldecode($path) |
@@ -2835,6 +2840,7 @@ discard block |
||
| 2835 | 2840 | * UTF-8 encode property values if not already done so |
| 2836 | 2841 | * |
| 2837 | 2842 | * @param string text to encode |
| 2843 | + * @param string $text |
|
| 2838 | 2844 | * @return string utf-8 encoded text |
| 2839 | 2845 | */ |
| 2840 | 2846 | function _prop_encode($text) |
@@ -2876,6 +2882,7 @@ discard block |
||
| 2876 | 2882 | * |
| 2877 | 2883 | * @param string directory path |
| 2878 | 2884 | * @returns string directory path wihtout trailing slash |
| 2885 | + * @return string |
|
| 2879 | 2886 | */ |
| 2880 | 2887 | public static function _unslashify($path) |
| 2881 | 2888 | { |
@@ -2892,6 +2899,7 @@ discard block |
||
| 2892 | 2899 | * |
| 2893 | 2900 | * @param string parent path |
| 2894 | 2901 | * @param string child path |
| 2902 | + * @param string $child |
|
| 2895 | 2903 | * @return string merged path |
| 2896 | 2904 | */ |
| 2897 | 2905 | public static function _mergePaths($parent, $child) |
@@ -254,6 +254,7 @@ discard block |
||
| 254 | 254 | * |
| 255 | 255 | * @param string program name |
| 256 | 256 | * @param string optional search path, defaults to $PATH |
| 257 | + * @param string $name |
|
| 257 | 258 | * @return bool true if executable program found in path |
| 258 | 259 | */ |
| 259 | 260 | function _can_execute($name, $path = false) |
@@ -319,6 +320,7 @@ discard block |
||
| 319 | 320 | * try to detect the mime type of a file |
| 320 | 321 | * |
| 321 | 322 | * @param string file path |
| 323 | + * @param string $fspath |
|
| 322 | 324 | * @return string guessed mime type |
| 323 | 325 | */ |
| 324 | 326 | function _mimetype($fspath) |
@@ -416,7 +418,7 @@ discard block |
||
| 416 | 418 | * GET method handler |
| 417 | 419 | * |
| 418 | 420 | * @param array parameter passing array |
| 419 | - * @return bool true on success |
|
| 421 | + * @return null|boolean true on success |
|
| 420 | 422 | */ |
| 421 | 423 | function GET(&$options) |
| 422 | 424 | { |
@@ -446,7 +448,7 @@ discard block |
||
| 446 | 448 | * See RFC 2518, Section 8.4 on GET/HEAD for collections |
| 447 | 449 | * |
| 448 | 450 | * @param string directory path |
| 449 | - * @return void function has to handle HTTP response itself |
|
| 451 | + * @return null|false function has to handle HTTP response itself |
|
| 450 | 452 | */ |
| 451 | 453 | function GetDir($fspath, &$options) |
| 452 | 454 | { |
@@ -533,7 +535,7 @@ discard block |
||
| 533 | 535 | * MKCOL method handler |
| 534 | 536 | * |
| 535 | 537 | * @param array general parameter passing array |
| 536 | - * @return bool true on success |
|
| 538 | + * @return string true on success |
|
| 537 | 539 | */ |
| 538 | 540 | function MKCOL($options) |
| 539 | 541 | { |
@@ -570,7 +572,7 @@ discard block |
||
| 570 | 572 | * DELETE method handler |
| 571 | 573 | * |
| 572 | 574 | * @param array general parameter passing array |
| 573 | - * @return bool true on success |
|
| 575 | + * @return string true on success |
|
| 574 | 576 | */ |
| 575 | 577 | function DELETE($options) |
| 576 | 578 | { |
@@ -600,7 +602,7 @@ discard block |
||
| 600 | 602 | * MOVE method handler |
| 601 | 603 | * |
| 602 | 604 | * @param array general parameter passing array |
| 603 | - * @return bool true on success |
|
| 605 | + * @return string true on success |
|
| 604 | 606 | */ |
| 605 | 607 | function MOVE($options) |
| 606 | 608 | { |
@@ -611,7 +613,7 @@ discard block |
||
| 611 | 613 | * COPY method handler |
| 612 | 614 | * |
| 613 | 615 | * @param array general parameter passing array |
| 614 | - * @return bool true on success |
|
| 616 | + * @return string true on success |
|
| 615 | 617 | */ |
| 616 | 618 | function COPY($options, $del=false) |
| 617 | 619 | { |
@@ -751,7 +753,7 @@ discard block |
||
| 751 | 753 | * PROPPATCH method handler |
| 752 | 754 | * |
| 753 | 755 | * @param array general parameter passing array |
| 754 | - * @return bool true on success |
|
| 756 | + * @return string true on success |
|
| 755 | 757 | */ |
| 756 | 758 | function PROPPATCH(&$options) |
| 757 | 759 | { |
@@ -790,7 +792,7 @@ discard block |
||
| 790 | 792 | * LOCK method handler |
| 791 | 793 | * |
| 792 | 794 | * @param array general parameter passing array |
| 793 | - * @return bool true on success |
|
| 795 | + * @return string|boolean true on success |
|
| 794 | 796 | */ |
| 795 | 797 | function LOCK(&$options) |
| 796 | 798 | { |
@@ -848,7 +850,7 @@ discard block |
||
| 848 | 850 | * UNLOCK method handler |
| 849 | 851 | * |
| 850 | 852 | * @param array general parameter passing array |
| 851 | - * @return bool true on success |
|
| 853 | + * @return string true on success |
|
| 852 | 854 | */ |
| 853 | 855 | function UNLOCK(&$options) |
| 854 | 856 | { |
@@ -95,6 +95,7 @@ |
||
| 95 | 95 | * |
| 96 | 96 | * @param string path of input stream |
| 97 | 97 | * @param boolean $store_request =false if true whole request data will be made available in $this->request |
| 98 | + * @param string $path |
|
| 98 | 99 | * @access public |
| 99 | 100 | */ |
| 100 | 101 | function __construct($path, $store_request=false) |