@@ -31,41 +31,41 @@ |
||
31 | 31 | * @since 8.0.0 |
32 | 32 | */ |
33 | 33 | interface ITempManager { |
34 | - /** |
|
35 | - * Create a temporary file and return the path |
|
36 | - * |
|
37 | - * @param string $postFix |
|
38 | - * @return string |
|
39 | - * @since 8.0.0 |
|
40 | - */ |
|
41 | - public function getTemporaryFile($postFix = ''); |
|
34 | + /** |
|
35 | + * Create a temporary file and return the path |
|
36 | + * |
|
37 | + * @param string $postFix |
|
38 | + * @return string |
|
39 | + * @since 8.0.0 |
|
40 | + */ |
|
41 | + public function getTemporaryFile($postFix = ''); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Create a temporary folder and return the path |
|
45 | - * |
|
46 | - * @param string $postFix |
|
47 | - * @return string |
|
48 | - * @since 8.0.0 |
|
49 | - */ |
|
50 | - public function getTemporaryFolder($postFix = ''); |
|
43 | + /** |
|
44 | + * Create a temporary folder and return the path |
|
45 | + * |
|
46 | + * @param string $postFix |
|
47 | + * @return string |
|
48 | + * @since 8.0.0 |
|
49 | + */ |
|
50 | + public function getTemporaryFolder($postFix = ''); |
|
51 | 51 | |
52 | - /** |
|
53 | - * Remove the temporary files and folders generated during this request |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function clean(); |
|
52 | + /** |
|
53 | + * Remove the temporary files and folders generated during this request |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function clean(); |
|
57 | 57 | |
58 | - /** |
|
59 | - * Remove old temporary files and folders that were failed to be cleaned |
|
60 | - * @since 8.0.0 |
|
61 | - */ |
|
62 | - public function cleanOld(); |
|
58 | + /** |
|
59 | + * Remove old temporary files and folders that were failed to be cleaned |
|
60 | + * @since 8.0.0 |
|
61 | + */ |
|
62 | + public function cleanOld(); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Get the temporary base directory |
|
66 | - * |
|
67 | - * @return string |
|
68 | - * @since 8.2.0 |
|
69 | - */ |
|
70 | - public function getTempBaseDir(); |
|
64 | + /** |
|
65 | + * Get the temporary base directory |
|
66 | + * |
|
67 | + * @return string |
|
68 | + * @since 8.2.0 |
|
69 | + */ |
|
70 | + public function getTempBaseDir(); |
|
71 | 71 | } |
@@ -45,92 +45,92 @@ |
||
45 | 45 | * @since 5.0.0 |
46 | 46 | */ |
47 | 47 | class Files { |
48 | - /** |
|
49 | - * Recusive deletion of folders |
|
50 | - * @return bool |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - static function rmdirr( $dir ) { |
|
54 | - return \OC_Helper::rmdirr( $dir ); |
|
55 | - } |
|
48 | + /** |
|
49 | + * Recusive deletion of folders |
|
50 | + * @return bool |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + static function rmdirr( $dir ) { |
|
54 | + return \OC_Helper::rmdirr( $dir ); |
|
55 | + } |
|
56 | 56 | |
57 | - /** |
|
58 | - * Get the mimetype form a local file |
|
59 | - * @param string $path |
|
60 | - * @return string |
|
61 | - * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead |
|
62 | - * @since 5.0.0 |
|
63 | - */ |
|
64 | - static function getMimeType( $path ) { |
|
65 | - return \OC::$server->getMimeTypeDetector()->detect($path); |
|
66 | - } |
|
57 | + /** |
|
58 | + * Get the mimetype form a local file |
|
59 | + * @param string $path |
|
60 | + * @return string |
|
61 | + * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead |
|
62 | + * @since 5.0.0 |
|
63 | + */ |
|
64 | + static function getMimeType( $path ) { |
|
65 | + return \OC::$server->getMimeTypeDetector()->detect($path); |
|
66 | + } |
|
67 | 67 | |
68 | - /** |
|
69 | - * Search for files by mimetype |
|
70 | - * @param string $mimetype |
|
71 | - * @return array |
|
72 | - * @since 6.0.0 |
|
73 | - */ |
|
74 | - static public function searchByMime( $mimetype ) { |
|
75 | - return(\OC\Files\Filesystem::searchByMime( $mimetype )); |
|
76 | - } |
|
68 | + /** |
|
69 | + * Search for files by mimetype |
|
70 | + * @param string $mimetype |
|
71 | + * @return array |
|
72 | + * @since 6.0.0 |
|
73 | + */ |
|
74 | + static public function searchByMime( $mimetype ) { |
|
75 | + return(\OC\Files\Filesystem::searchByMime( $mimetype )); |
|
76 | + } |
|
77 | 77 | |
78 | - /** |
|
79 | - * Copy the contents of one stream to another |
|
80 | - * @param resource $source |
|
81 | - * @param resource $target |
|
82 | - * @return int the number of bytes copied |
|
83 | - * @since 5.0.0 |
|
84 | - */ |
|
85 | - public static function streamCopy( $source, $target ) { |
|
86 | - list($count, ) = \OC_Helper::streamCopy( $source, $target ); |
|
87 | - return $count; |
|
88 | - } |
|
78 | + /** |
|
79 | + * Copy the contents of one stream to another |
|
80 | + * @param resource $source |
|
81 | + * @param resource $target |
|
82 | + * @return int the number of bytes copied |
|
83 | + * @since 5.0.0 |
|
84 | + */ |
|
85 | + public static function streamCopy( $source, $target ) { |
|
86 | + list($count, ) = \OC_Helper::streamCopy( $source, $target ); |
|
87 | + return $count; |
|
88 | + } |
|
89 | 89 | |
90 | - /** |
|
91 | - * Create a temporary file with an unique filename |
|
92 | - * @param string $postfix |
|
93 | - * @return string |
|
94 | - * |
|
95 | - * temporary files are automatically cleaned up after the script is finished |
|
96 | - * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager() |
|
97 | - * @since 5.0.0 |
|
98 | - */ |
|
99 | - public static function tmpFile( $postfix='' ) { |
|
100 | - return \OC::$server->getTempManager()->getTemporaryFile($postfix); |
|
101 | - } |
|
90 | + /** |
|
91 | + * Create a temporary file with an unique filename |
|
92 | + * @param string $postfix |
|
93 | + * @return string |
|
94 | + * |
|
95 | + * temporary files are automatically cleaned up after the script is finished |
|
96 | + * @deprecated 8.1.0 use getTemporaryFile() of \OCP\ITempManager - \OC::$server->getTempManager() |
|
97 | + * @since 5.0.0 |
|
98 | + */ |
|
99 | + public static function tmpFile( $postfix='' ) { |
|
100 | + return \OC::$server->getTempManager()->getTemporaryFile($postfix); |
|
101 | + } |
|
102 | 102 | |
103 | - /** |
|
104 | - * Create a temporary folder with an unique filename |
|
105 | - * @return string |
|
106 | - * |
|
107 | - * temporary files are automatically cleaned up after the script is finished |
|
108 | - * @deprecated 8.1.0 use getTemporaryFolder() of \OCP\ITempManager - \OC::$server->getTempManager() |
|
109 | - * @since 5.0.0 |
|
110 | - */ |
|
111 | - public static function tmpFolder() { |
|
112 | - return \OC::$server->getTempManager()->getTemporaryFolder(); |
|
113 | - } |
|
103 | + /** |
|
104 | + * Create a temporary folder with an unique filename |
|
105 | + * @return string |
|
106 | + * |
|
107 | + * temporary files are automatically cleaned up after the script is finished |
|
108 | + * @deprecated 8.1.0 use getTemporaryFolder() of \OCP\ITempManager - \OC::$server->getTempManager() |
|
109 | + * @since 5.0.0 |
|
110 | + */ |
|
111 | + public static function tmpFolder() { |
|
112 | + return \OC::$server->getTempManager()->getTemporaryFolder(); |
|
113 | + } |
|
114 | 114 | |
115 | - /** |
|
116 | - * Adds a suffix to the name in case the file exists |
|
117 | - * @param string $path |
|
118 | - * @param string $filename |
|
119 | - * @return string |
|
120 | - * @since 5.0.0 |
|
121 | - */ |
|
122 | - public static function buildNotExistingFileName( $path, $filename ) { |
|
123 | - return(\OC_Helper::buildNotExistingFileName( $path, $filename )); |
|
124 | - } |
|
115 | + /** |
|
116 | + * Adds a suffix to the name in case the file exists |
|
117 | + * @param string $path |
|
118 | + * @param string $filename |
|
119 | + * @return string |
|
120 | + * @since 5.0.0 |
|
121 | + */ |
|
122 | + public static function buildNotExistingFileName( $path, $filename ) { |
|
123 | + return(\OC_Helper::buildNotExistingFileName( $path, $filename )); |
|
124 | + } |
|
125 | 125 | |
126 | - /** |
|
127 | - * Gets the Storage for an app - creates the needed folder if they are not |
|
128 | - * existent |
|
129 | - * @param string $app |
|
130 | - * @return \OC\Files\View |
|
131 | - * @since 5.0.0 |
|
132 | - */ |
|
133 | - public static function getStorage( $app ) { |
|
134 | - return \OC_App::getStorage( $app ); |
|
135 | - } |
|
126 | + /** |
|
127 | + * Gets the Storage for an app - creates the needed folder if they are not |
|
128 | + * existent |
|
129 | + * @param string $app |
|
130 | + * @return \OC\Files\View |
|
131 | + * @since 5.0.0 |
|
132 | + */ |
|
133 | + public static function getStorage( $app ) { |
|
134 | + return \OC_App::getStorage( $app ); |
|
135 | + } |
|
136 | 136 | } |
@@ -31,18 +31,18 @@ |
||
31 | 31 | * @since 9.1 |
32 | 32 | */ |
33 | 33 | interface IManager { |
34 | - /** |
|
35 | - * @param IStorage $storage |
|
36 | - * @param string $path |
|
37 | - * @since 9.1 |
|
38 | - */ |
|
39 | - public function setFileInfo(IStorage $storage, $path); |
|
34 | + /** |
|
35 | + * @param IStorage $storage |
|
36 | + * @param string $path |
|
37 | + * @since 9.1 |
|
38 | + */ |
|
39 | + public function setFileInfo(IStorage $storage, $path); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @param string $class |
|
43 | - * @param bool $returnFirstMatchingOperationOnly |
|
44 | - * @return array |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function getMatchingOperations($class, $returnFirstMatchingOperationOnly = true); |
|
41 | + /** |
|
42 | + * @param string $class |
|
43 | + * @param bool $returnFirstMatchingOperationOnly |
|
44 | + * @return array |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function getMatchingOperations($class, $returnFirstMatchingOperationOnly = true); |
|
48 | 48 | } |
@@ -28,12 +28,12 @@ |
||
28 | 28 | * @since 9.1 |
29 | 29 | */ |
30 | 30 | interface IOperation { |
31 | - /** |
|
32 | - * @param string $name |
|
33 | - * @param array[] $checks |
|
34 | - * @param string $operation |
|
35 | - * @throws \UnexpectedValueException |
|
36 | - * @since 9.1 |
|
37 | - */ |
|
38 | - public function validateOperation($name, array $checks, $operation); |
|
31 | + /** |
|
32 | + * @param string $name |
|
33 | + * @param array[] $checks |
|
34 | + * @param string $operation |
|
35 | + * @throws \UnexpectedValueException |
|
36 | + * @since 9.1 |
|
37 | + */ |
|
38 | + public function validateOperation($name, array $checks, $operation); |
|
39 | 39 | } |
@@ -31,26 +31,26 @@ |
||
31 | 31 | * @since 9.1 |
32 | 32 | */ |
33 | 33 | interface ICheck { |
34 | - /** |
|
35 | - * @param IStorage $storage |
|
36 | - * @param string $path |
|
37 | - * @since 9.1 |
|
38 | - */ |
|
39 | - public function setFileInfo(IStorage $storage, $path); |
|
34 | + /** |
|
35 | + * @param IStorage $storage |
|
36 | + * @param string $path |
|
37 | + * @since 9.1 |
|
38 | + */ |
|
39 | + public function setFileInfo(IStorage $storage, $path); |
|
40 | 40 | |
41 | - /** |
|
42 | - * @param string $operator |
|
43 | - * @param string $value |
|
44 | - * @return bool |
|
45 | - * @since 9.1 |
|
46 | - */ |
|
47 | - public function executeCheck($operator, $value); |
|
41 | + /** |
|
42 | + * @param string $operator |
|
43 | + * @param string $value |
|
44 | + * @return bool |
|
45 | + * @since 9.1 |
|
46 | + */ |
|
47 | + public function executeCheck($operator, $value); |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $operator |
|
51 | - * @param string $value |
|
52 | - * @throws \UnexpectedValueException |
|
53 | - * @since 9.1 |
|
54 | - */ |
|
55 | - public function validateCheck($operator, $value); |
|
49 | + /** |
|
50 | + * @param string $operator |
|
51 | + * @param string $value |
|
52 | + * @throws \UnexpectedValueException |
|
53 | + * @since 9.1 |
|
54 | + */ |
|
55 | + public function validateCheck($operator, $value); |
|
56 | 56 | } |
@@ -45,102 +45,102 @@ |
||
45 | 45 | * @since 4.5.0 |
46 | 46 | */ |
47 | 47 | class DB { |
48 | - /** |
|
49 | - * Prepare a SQL query |
|
50 | - * @param string $query Query string |
|
51 | - * @param int $limit Limit of the SQL statement |
|
52 | - * @param int $offset Offset of the SQL statement |
|
53 | - * @return \OC_DB_StatementWrapper prepared SQL query |
|
54 | - * |
|
55 | - * SQL query via Doctrine prepare(), needs to be execute()'d! |
|
56 | - * @deprecated 8.1.0 use prepare() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
57 | - * @since 4.5.0 |
|
58 | - */ |
|
59 | - static public function prepare( $query, $limit=null, $offset=null ) { |
|
60 | - return(\OC_DB::prepare($query, $limit, $offset)); |
|
61 | - } |
|
48 | + /** |
|
49 | + * Prepare a SQL query |
|
50 | + * @param string $query Query string |
|
51 | + * @param int $limit Limit of the SQL statement |
|
52 | + * @param int $offset Offset of the SQL statement |
|
53 | + * @return \OC_DB_StatementWrapper prepared SQL query |
|
54 | + * |
|
55 | + * SQL query via Doctrine prepare(), needs to be execute()'d! |
|
56 | + * @deprecated 8.1.0 use prepare() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
57 | + * @since 4.5.0 |
|
58 | + */ |
|
59 | + static public function prepare( $query, $limit=null, $offset=null ) { |
|
60 | + return(\OC_DB::prepare($query, $limit, $offset)); |
|
61 | + } |
|
62 | 62 | |
63 | - /** |
|
64 | - * Insert a row if the matching row does not exists. |
|
65 | - * |
|
66 | - * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
67 | - * @param array $input data that should be inserted into the table (column name => value) |
|
68 | - * @param array|null $compare List of values that should be checked for "if not exists" |
|
69 | - * If this is null or an empty array, all keys of $input will be compared |
|
70 | - * @return int number of inserted rows |
|
71 | - * @throws \Doctrine\DBAL\DBALException |
|
72 | - * @deprecated 8.1.0 use insertIfNotExist() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
73 | - * @since 5.0.0 - parameter $compare was added in 8.1.0 |
|
74 | - * |
|
75 | - */ |
|
76 | - public static function insertIfNotExist($table, $input, array $compare = null) { |
|
77 | - return \OC::$server->getDatabaseConnection()->insertIfNotExist($table, $input, $compare); |
|
78 | - } |
|
63 | + /** |
|
64 | + * Insert a row if the matching row does not exists. |
|
65 | + * |
|
66 | + * @param string $table The table name (will replace *PREFIX* with the actual prefix) |
|
67 | + * @param array $input data that should be inserted into the table (column name => value) |
|
68 | + * @param array|null $compare List of values that should be checked for "if not exists" |
|
69 | + * If this is null or an empty array, all keys of $input will be compared |
|
70 | + * @return int number of inserted rows |
|
71 | + * @throws \Doctrine\DBAL\DBALException |
|
72 | + * @deprecated 8.1.0 use insertIfNotExist() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
73 | + * @since 5.0.0 - parameter $compare was added in 8.1.0 |
|
74 | + * |
|
75 | + */ |
|
76 | + public static function insertIfNotExist($table, $input, array $compare = null) { |
|
77 | + return \OC::$server->getDatabaseConnection()->insertIfNotExist($table, $input, $compare); |
|
78 | + } |
|
79 | 79 | |
80 | - /** |
|
81 | - * Gets last value of autoincrement |
|
82 | - * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix |
|
83 | - * @return string |
|
84 | - * |
|
85 | - * \Doctrine\DBAL\Connection lastInsertID() |
|
86 | - * |
|
87 | - * Call this method right after the insert command or other functions may |
|
88 | - * cause trouble! |
|
89 | - * @deprecated 8.1.0 use lastInsertId() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
90 | - * @since 4.5.0 |
|
91 | - */ |
|
92 | - public static function insertid($table=null) { |
|
93 | - return \OC::$server->getDatabaseConnection()->lastInsertId($table); |
|
94 | - } |
|
80 | + /** |
|
81 | + * Gets last value of autoincrement |
|
82 | + * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix |
|
83 | + * @return string |
|
84 | + * |
|
85 | + * \Doctrine\DBAL\Connection lastInsertID() |
|
86 | + * |
|
87 | + * Call this method right after the insert command or other functions may |
|
88 | + * cause trouble! |
|
89 | + * @deprecated 8.1.0 use lastInsertId() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
90 | + * @since 4.5.0 |
|
91 | + */ |
|
92 | + public static function insertid($table=null) { |
|
93 | + return \OC::$server->getDatabaseConnection()->lastInsertId($table); |
|
94 | + } |
|
95 | 95 | |
96 | - /** |
|
97 | - * Start a transaction |
|
98 | - * @deprecated 8.1.0 use beginTransaction() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
99 | - * @since 4.5.0 |
|
100 | - */ |
|
101 | - public static function beginTransaction() { |
|
102 | - \OC::$server->getDatabaseConnection()->beginTransaction(); |
|
103 | - } |
|
96 | + /** |
|
97 | + * Start a transaction |
|
98 | + * @deprecated 8.1.0 use beginTransaction() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
99 | + * @since 4.5.0 |
|
100 | + */ |
|
101 | + public static function beginTransaction() { |
|
102 | + \OC::$server->getDatabaseConnection()->beginTransaction(); |
|
103 | + } |
|
104 | 104 | |
105 | - /** |
|
106 | - * Commit the database changes done during a transaction that is in progress |
|
107 | - * @deprecated 8.1.0 use commit() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
108 | - * @since 4.5.0 |
|
109 | - */ |
|
110 | - public static function commit() { |
|
111 | - \OC::$server->getDatabaseConnection()->commit(); |
|
112 | - } |
|
105 | + /** |
|
106 | + * Commit the database changes done during a transaction that is in progress |
|
107 | + * @deprecated 8.1.0 use commit() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
108 | + * @since 4.5.0 |
|
109 | + */ |
|
110 | + public static function commit() { |
|
111 | + \OC::$server->getDatabaseConnection()->commit(); |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Rollback the database changes done during a transaction that is in progress |
|
116 | - * @deprecated 8.1.0 use rollback() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
117 | - * @since 8.0.0 |
|
118 | - */ |
|
119 | - public static function rollback() { |
|
120 | - \OC::$server->getDatabaseConnection()->rollback(); |
|
121 | - } |
|
114 | + /** |
|
115 | + * Rollback the database changes done during a transaction that is in progress |
|
116 | + * @deprecated 8.1.0 use rollback() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
117 | + * @since 8.0.0 |
|
118 | + */ |
|
119 | + public static function rollback() { |
|
120 | + \OC::$server->getDatabaseConnection()->rollback(); |
|
121 | + } |
|
122 | 122 | |
123 | - /** |
|
124 | - * Check if a result is an error, works with Doctrine |
|
125 | - * @param mixed $result |
|
126 | - * @return bool |
|
127 | - * @deprecated 8.1.0 Doctrine returns false on error (and throws an exception) |
|
128 | - * @since 4.5.0 |
|
129 | - */ |
|
130 | - public static function isError($result) { |
|
131 | - // Doctrine returns false on error (and throws an exception) |
|
132 | - return $result === false; |
|
133 | - } |
|
123 | + /** |
|
124 | + * Check if a result is an error, works with Doctrine |
|
125 | + * @param mixed $result |
|
126 | + * @return bool |
|
127 | + * @deprecated 8.1.0 Doctrine returns false on error (and throws an exception) |
|
128 | + * @since 4.5.0 |
|
129 | + */ |
|
130 | + public static function isError($result) { |
|
131 | + // Doctrine returns false on error (and throws an exception) |
|
132 | + return $result === false; |
|
133 | + } |
|
134 | 134 | |
135 | - /** |
|
136 | - * returns the error code and message as a string for logging |
|
137 | - * works with DoctrineException |
|
138 | - * @return string |
|
139 | - * @deprecated 8.1.0 use getError() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
140 | - * @since 6.0.0 |
|
141 | - */ |
|
142 | - public static function getErrorMessage() { |
|
143 | - return \OC::$server->getDatabaseConnection()->getError(); |
|
144 | - } |
|
135 | + /** |
|
136 | + * returns the error code and message as a string for logging |
|
137 | + * works with DoctrineException |
|
138 | + * @return string |
|
139 | + * @deprecated 8.1.0 use getError() of \OCP\IDBConnection - \OC::$server->getDatabaseConnection() |
|
140 | + * @since 6.0.0 |
|
141 | + */ |
|
142 | + public static function getErrorMessage() { |
|
143 | + return \OC::$server->getDatabaseConnection()->getError(); |
|
144 | + } |
|
145 | 145 | |
146 | 146 | } |
@@ -36,92 +36,92 @@ |
||
36 | 36 | */ |
37 | 37 | interface IRouter { |
38 | 38 | |
39 | - /** |
|
40 | - * Get the files to load the routes from |
|
41 | - * |
|
42 | - * @return string[] |
|
43 | - * @since 7.0.0 |
|
44 | - * @deprecated 9.0.0 |
|
45 | - */ |
|
46 | - public function getRoutingFiles(); |
|
39 | + /** |
|
40 | + * Get the files to load the routes from |
|
41 | + * |
|
42 | + * @return string[] |
|
43 | + * @since 7.0.0 |
|
44 | + * @deprecated 9.0.0 |
|
45 | + */ |
|
46 | + public function getRoutingFiles(); |
|
47 | 47 | |
48 | - /** |
|
49 | - * @return string |
|
50 | - * @since 7.0.0 |
|
51 | - * @deprecated 9.0.0 |
|
52 | - */ |
|
53 | - public function getCacheKey(); |
|
48 | + /** |
|
49 | + * @return string |
|
50 | + * @since 7.0.0 |
|
51 | + * @deprecated 9.0.0 |
|
52 | + */ |
|
53 | + public function getCacheKey(); |
|
54 | 54 | |
55 | - /** |
|
56 | - * Loads the routes |
|
57 | - * |
|
58 | - * @param null|string $app |
|
59 | - * @since 7.0.0 |
|
60 | - * @deprecated 9.0.0 |
|
61 | - */ |
|
62 | - public function loadRoutes($app = null); |
|
55 | + /** |
|
56 | + * Loads the routes |
|
57 | + * |
|
58 | + * @param null|string $app |
|
59 | + * @since 7.0.0 |
|
60 | + * @deprecated 9.0.0 |
|
61 | + */ |
|
62 | + public function loadRoutes($app = null); |
|
63 | 63 | |
64 | - /** |
|
65 | - * Sets the collection to use for adding routes |
|
66 | - * |
|
67 | - * @param string $name Name of the collection to use. |
|
68 | - * @return void |
|
69 | - * @since 7.0.0 |
|
70 | - * @deprecated 9.0.0 |
|
71 | - */ |
|
72 | - public function useCollection($name); |
|
64 | + /** |
|
65 | + * Sets the collection to use for adding routes |
|
66 | + * |
|
67 | + * @param string $name Name of the collection to use. |
|
68 | + * @return void |
|
69 | + * @since 7.0.0 |
|
70 | + * @deprecated 9.0.0 |
|
71 | + */ |
|
72 | + public function useCollection($name); |
|
73 | 73 | |
74 | - /** |
|
75 | - * returns the current collection name in use for adding routes |
|
76 | - * |
|
77 | - * @return string the collection name |
|
78 | - * @since 8.0.0 |
|
79 | - * @deprecated 9.0.0 |
|
80 | - */ |
|
81 | - public function getCurrentCollection(); |
|
74 | + /** |
|
75 | + * returns the current collection name in use for adding routes |
|
76 | + * |
|
77 | + * @return string the collection name |
|
78 | + * @since 8.0.0 |
|
79 | + * @deprecated 9.0.0 |
|
80 | + */ |
|
81 | + public function getCurrentCollection(); |
|
82 | 82 | |
83 | - /** |
|
84 | - * Create a \OCP\Route\IRoute. |
|
85 | - * |
|
86 | - * @param string $name Name of the route to create. |
|
87 | - * @param string $pattern The pattern to match |
|
88 | - * @param array $defaults An array of default parameter values |
|
89 | - * @param array $requirements An array of requirements for parameters (regexes) |
|
90 | - * @return \OCP\Route\IRoute |
|
91 | - * @since 7.0.0 |
|
92 | - * @deprecated 9.0.0 |
|
93 | - */ |
|
94 | - public function create($name, $pattern, array $defaults = array(), array $requirements = array()); |
|
83 | + /** |
|
84 | + * Create a \OCP\Route\IRoute. |
|
85 | + * |
|
86 | + * @param string $name Name of the route to create. |
|
87 | + * @param string $pattern The pattern to match |
|
88 | + * @param array $defaults An array of default parameter values |
|
89 | + * @param array $requirements An array of requirements for parameters (regexes) |
|
90 | + * @return \OCP\Route\IRoute |
|
91 | + * @since 7.0.0 |
|
92 | + * @deprecated 9.0.0 |
|
93 | + */ |
|
94 | + public function create($name, $pattern, array $defaults = array(), array $requirements = array()); |
|
95 | 95 | |
96 | - /** |
|
97 | - * Find the route matching $url. |
|
98 | - * |
|
99 | - * @param string $url The url to find |
|
100 | - * @throws \Exception |
|
101 | - * @return void |
|
102 | - * @since 7.0.0 |
|
103 | - * @deprecated 9.0.0 |
|
104 | - */ |
|
105 | - public function match($url); |
|
96 | + /** |
|
97 | + * Find the route matching $url. |
|
98 | + * |
|
99 | + * @param string $url The url to find |
|
100 | + * @throws \Exception |
|
101 | + * @return void |
|
102 | + * @since 7.0.0 |
|
103 | + * @deprecated 9.0.0 |
|
104 | + */ |
|
105 | + public function match($url); |
|
106 | 106 | |
107 | - /** |
|
108 | - * Get the url generator |
|
109 | - * |
|
110 | - * @since 7.0.0 |
|
111 | - * @deprecated 9.0.0 |
|
112 | - */ |
|
113 | - public function getGenerator(); |
|
107 | + /** |
|
108 | + * Get the url generator |
|
109 | + * |
|
110 | + * @since 7.0.0 |
|
111 | + * @deprecated 9.0.0 |
|
112 | + */ |
|
113 | + public function getGenerator(); |
|
114 | 114 | |
115 | - /** |
|
116 | - * Generate url based on $name and $parameters |
|
117 | - * |
|
118 | - * @param string $name Name of the route to use. |
|
119 | - * @param array $parameters Parameters for the route |
|
120 | - * @param bool $absolute |
|
121 | - * @return string |
|
122 | - * @since 7.0.0 |
|
123 | - * @deprecated 9.0.0 |
|
124 | - */ |
|
125 | - public function generate($name, $parameters = array(), $absolute = false); |
|
115 | + /** |
|
116 | + * Generate url based on $name and $parameters |
|
117 | + * |
|
118 | + * @param string $name Name of the route to use. |
|
119 | + * @param array $parameters Parameters for the route |
|
120 | + * @param bool $absolute |
|
121 | + * @return string |
|
122 | + * @since 7.0.0 |
|
123 | + * @deprecated 9.0.0 |
|
124 | + */ |
|
125 | + public function generate($name, $parameters = array(), $absolute = false); |
|
126 | 126 | |
127 | 127 | } |
@@ -31,88 +31,88 @@ |
||
31 | 31 | * @since 7.0.0 |
32 | 32 | */ |
33 | 33 | interface IRoute { |
34 | - /** |
|
35 | - * Specify PATCH as the method to use with this route |
|
36 | - * @return \OCP\Route\IRoute |
|
37 | - * @since 7.0.0 |
|
38 | - */ |
|
39 | - public function patch(); |
|
34 | + /** |
|
35 | + * Specify PATCH as the method to use with this route |
|
36 | + * @return \OCP\Route\IRoute |
|
37 | + * @since 7.0.0 |
|
38 | + */ |
|
39 | + public function patch(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Specify the method when this route is to be used |
|
43 | - * |
|
44 | - * @param string $method HTTP method (uppercase) |
|
45 | - * @return \OCP\Route\IRoute |
|
46 | - * @since 7.0.0 |
|
47 | - */ |
|
48 | - public function method($method); |
|
41 | + /** |
|
42 | + * Specify the method when this route is to be used |
|
43 | + * |
|
44 | + * @param string $method HTTP method (uppercase) |
|
45 | + * @return \OCP\Route\IRoute |
|
46 | + * @since 7.0.0 |
|
47 | + */ |
|
48 | + public function method($method); |
|
49 | 49 | |
50 | - /** |
|
51 | - * The action to execute when this route matches, includes a file like |
|
52 | - * it is called directly |
|
53 | - * |
|
54 | - * @param string $file |
|
55 | - * @return void |
|
56 | - * @since 7.0.0 |
|
57 | - */ |
|
58 | - public function actionInclude($file); |
|
50 | + /** |
|
51 | + * The action to execute when this route matches, includes a file like |
|
52 | + * it is called directly |
|
53 | + * |
|
54 | + * @param string $file |
|
55 | + * @return void |
|
56 | + * @since 7.0.0 |
|
57 | + */ |
|
58 | + public function actionInclude($file); |
|
59 | 59 | |
60 | - /** |
|
61 | - * Specify GET as the method to use with this route |
|
62 | - * @return \OCP\Route\IRoute |
|
63 | - * @since 7.0.0 |
|
64 | - */ |
|
65 | - public function get(); |
|
60 | + /** |
|
61 | + * Specify GET as the method to use with this route |
|
62 | + * @return \OCP\Route\IRoute |
|
63 | + * @since 7.0.0 |
|
64 | + */ |
|
65 | + public function get(); |
|
66 | 66 | |
67 | - /** |
|
68 | - * Specify POST as the method to use with this route |
|
69 | - * @return \OCP\Route\IRoute |
|
70 | - * @since 7.0.0 |
|
71 | - */ |
|
72 | - public function post(); |
|
67 | + /** |
|
68 | + * Specify POST as the method to use with this route |
|
69 | + * @return \OCP\Route\IRoute |
|
70 | + * @since 7.0.0 |
|
71 | + */ |
|
72 | + public function post(); |
|
73 | 73 | |
74 | - /** |
|
75 | - * Specify DELETE as the method to use with this route |
|
76 | - * @return \OCP\Route\IRoute |
|
77 | - * @since 7.0.0 |
|
78 | - */ |
|
79 | - public function delete(); |
|
74 | + /** |
|
75 | + * Specify DELETE as the method to use with this route |
|
76 | + * @return \OCP\Route\IRoute |
|
77 | + * @since 7.0.0 |
|
78 | + */ |
|
79 | + public function delete(); |
|
80 | 80 | |
81 | - /** |
|
82 | - * The action to execute when this route matches |
|
83 | - * |
|
84 | - * @param string|callable $class the class or a callable |
|
85 | - * @param string $function the function to use with the class |
|
86 | - * @return \OCP\Route\IRoute |
|
87 | - * |
|
88 | - * This function is called with $class set to a callable or |
|
89 | - * to the class with $function |
|
90 | - * @since 7.0.0 |
|
91 | - */ |
|
92 | - public function action($class, $function = null); |
|
81 | + /** |
|
82 | + * The action to execute when this route matches |
|
83 | + * |
|
84 | + * @param string|callable $class the class or a callable |
|
85 | + * @param string $function the function to use with the class |
|
86 | + * @return \OCP\Route\IRoute |
|
87 | + * |
|
88 | + * This function is called with $class set to a callable or |
|
89 | + * to the class with $function |
|
90 | + * @since 7.0.0 |
|
91 | + */ |
|
92 | + public function action($class, $function = null); |
|
93 | 93 | |
94 | - /** |
|
95 | - * Defaults to use for this route |
|
96 | - * |
|
97 | - * @param array $defaults The defaults |
|
98 | - * @return \OCP\Route\IRoute |
|
99 | - * @since 7.0.0 |
|
100 | - */ |
|
101 | - public function defaults($defaults); |
|
94 | + /** |
|
95 | + * Defaults to use for this route |
|
96 | + * |
|
97 | + * @param array $defaults The defaults |
|
98 | + * @return \OCP\Route\IRoute |
|
99 | + * @since 7.0.0 |
|
100 | + */ |
|
101 | + public function defaults($defaults); |
|
102 | 102 | |
103 | - /** |
|
104 | - * Requirements for this route |
|
105 | - * |
|
106 | - * @param array $requirements The requirements |
|
107 | - * @return \OCP\Route\IRoute |
|
108 | - * @since 7.0.0 |
|
109 | - */ |
|
110 | - public function requirements($requirements); |
|
103 | + /** |
|
104 | + * Requirements for this route |
|
105 | + * |
|
106 | + * @param array $requirements The requirements |
|
107 | + * @return \OCP\Route\IRoute |
|
108 | + * @since 7.0.0 |
|
109 | + */ |
|
110 | + public function requirements($requirements); |
|
111 | 111 | |
112 | - /** |
|
113 | - * Specify PUT as the method to use with this route |
|
114 | - * @return \OCP\Route\IRoute |
|
115 | - * @since 7.0.0 |
|
116 | - */ |
|
117 | - public function put(); |
|
112 | + /** |
|
113 | + * Specify PUT as the method to use with this route |
|
114 | + * @return \OCP\Route\IRoute |
|
115 | + * @since 7.0.0 |
|
116 | + */ |
|
117 | + public function put(); |
|
118 | 118 | } |
@@ -44,93 +44,93 @@ |
||
44 | 44 | * @deprecated 8.1.0 - Use AppFramework controllers instead and modify the response object |
45 | 45 | */ |
46 | 46 | class Response { |
47 | - /** |
|
48 | - * Enable response caching by sending correct HTTP headers |
|
49 | - * @param int $cache_time time to cache the response |
|
50 | - * >0 cache time in seconds |
|
51 | - * 0 and <0 enable default browser caching |
|
52 | - * null cache indefinitely |
|
53 | - * @since 4.0.0 |
|
54 | - */ |
|
55 | - static public function enableCaching( $cache_time = null ) { |
|
56 | - \OC_Response::enableCaching( $cache_time ); |
|
57 | - } |
|
47 | + /** |
|
48 | + * Enable response caching by sending correct HTTP headers |
|
49 | + * @param int $cache_time time to cache the response |
|
50 | + * >0 cache time in seconds |
|
51 | + * 0 and <0 enable default browser caching |
|
52 | + * null cache indefinitely |
|
53 | + * @since 4.0.0 |
|
54 | + */ |
|
55 | + static public function enableCaching( $cache_time = null ) { |
|
56 | + \OC_Response::enableCaching( $cache_time ); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * Checks and set Last-Modified header, when the request matches sends a |
|
61 | - * 'not modified' response |
|
62 | - * @param string $lastModified time when the response was last modified |
|
63 | - * @since 4.0.0 |
|
64 | - */ |
|
65 | - static public function setLastModifiedHeader( $lastModified ) { |
|
66 | - \OC_Response::setLastModifiedHeader( $lastModified ); |
|
67 | - } |
|
59 | + /** |
|
60 | + * Checks and set Last-Modified header, when the request matches sends a |
|
61 | + * 'not modified' response |
|
62 | + * @param string $lastModified time when the response was last modified |
|
63 | + * @since 4.0.0 |
|
64 | + */ |
|
65 | + static public function setLastModifiedHeader( $lastModified ) { |
|
66 | + \OC_Response::setLastModifiedHeader( $lastModified ); |
|
67 | + } |
|
68 | 68 | |
69 | - /** |
|
70 | - * Sets the content disposition header (with possible workarounds) |
|
71 | - * @param string $filename file name |
|
72 | - * @param string $type disposition type, either 'attachment' or 'inline' |
|
73 | - * @since 7.0.0 |
|
74 | - */ |
|
75 | - static public function setContentDispositionHeader( $filename, $type = 'attachment' ) { |
|
76 | - \OC_Response::setContentDispositionHeader( $filename, $type ); |
|
77 | - } |
|
69 | + /** |
|
70 | + * Sets the content disposition header (with possible workarounds) |
|
71 | + * @param string $filename file name |
|
72 | + * @param string $type disposition type, either 'attachment' or 'inline' |
|
73 | + * @since 7.0.0 |
|
74 | + */ |
|
75 | + static public function setContentDispositionHeader( $filename, $type = 'attachment' ) { |
|
76 | + \OC_Response::setContentDispositionHeader( $filename, $type ); |
|
77 | + } |
|
78 | 78 | |
79 | - /** |
|
80 | - * Sets the content length header (with possible workarounds) |
|
81 | - * @param string|int|float $length Length to be sent |
|
82 | - * @since 8.1.0 |
|
83 | - */ |
|
84 | - static public function setContentLengthHeader($length) { |
|
85 | - \OC_Response::setContentLengthHeader($length); |
|
86 | - } |
|
79 | + /** |
|
80 | + * Sets the content length header (with possible workarounds) |
|
81 | + * @param string|int|float $length Length to be sent |
|
82 | + * @since 8.1.0 |
|
83 | + */ |
|
84 | + static public function setContentLengthHeader($length) { |
|
85 | + \OC_Response::setContentLengthHeader($length); |
|
86 | + } |
|
87 | 87 | |
88 | - /** |
|
89 | - * Disable browser caching |
|
90 | - * @see enableCaching with cache_time = 0 |
|
91 | - * @since 4.0.0 |
|
92 | - */ |
|
93 | - static public function disableCaching() { |
|
94 | - \OC_Response::disableCaching(); |
|
95 | - } |
|
88 | + /** |
|
89 | + * Disable browser caching |
|
90 | + * @see enableCaching with cache_time = 0 |
|
91 | + * @since 4.0.0 |
|
92 | + */ |
|
93 | + static public function disableCaching() { |
|
94 | + \OC_Response::disableCaching(); |
|
95 | + } |
|
96 | 96 | |
97 | - /** |
|
98 | - * Checks and set ETag header, when the request matches sends a |
|
99 | - * 'not modified' response |
|
100 | - * @param string $etag token to use for modification check |
|
101 | - * @since 4.0.0 |
|
102 | - */ |
|
103 | - static public function setETagHeader( $etag ) { |
|
104 | - \OC_Response::setETagHeader( $etag ); |
|
105 | - } |
|
97 | + /** |
|
98 | + * Checks and set ETag header, when the request matches sends a |
|
99 | + * 'not modified' response |
|
100 | + * @param string $etag token to use for modification check |
|
101 | + * @since 4.0.0 |
|
102 | + */ |
|
103 | + static public function setETagHeader( $etag ) { |
|
104 | + \OC_Response::setETagHeader( $etag ); |
|
105 | + } |
|
106 | 106 | |
107 | - /** |
|
108 | - * Send file as response, checking and setting caching headers |
|
109 | - * @param string $filepath of file to send |
|
110 | - * @since 4.0.0 |
|
111 | - * @deprecated 8.1.0 - Use \OCP\AppFramework\Http\StreamResponse or another AppFramework controller instead |
|
112 | - */ |
|
113 | - static public function sendFile( $filepath ) { |
|
114 | - \OC_Response::sendFile( $filepath ); |
|
115 | - } |
|
107 | + /** |
|
108 | + * Send file as response, checking and setting caching headers |
|
109 | + * @param string $filepath of file to send |
|
110 | + * @since 4.0.0 |
|
111 | + * @deprecated 8.1.0 - Use \OCP\AppFramework\Http\StreamResponse or another AppFramework controller instead |
|
112 | + */ |
|
113 | + static public function sendFile( $filepath ) { |
|
114 | + \OC_Response::sendFile( $filepath ); |
|
115 | + } |
|
116 | 116 | |
117 | - /** |
|
118 | - * Set response expire time |
|
119 | - * @param string|\DateTime $expires date-time when the response expires |
|
120 | - * string for DateInterval from now |
|
121 | - * DateTime object when to expire response |
|
122 | - * @since 4.0.0 |
|
123 | - */ |
|
124 | - static public function setExpiresHeader( $expires ) { |
|
125 | - \OC_Response::setExpiresHeader( $expires ); |
|
126 | - } |
|
117 | + /** |
|
118 | + * Set response expire time |
|
119 | + * @param string|\DateTime $expires date-time when the response expires |
|
120 | + * string for DateInterval from now |
|
121 | + * DateTime object when to expire response |
|
122 | + * @since 4.0.0 |
|
123 | + */ |
|
124 | + static public function setExpiresHeader( $expires ) { |
|
125 | + \OC_Response::setExpiresHeader( $expires ); |
|
126 | + } |
|
127 | 127 | |
128 | - /** |
|
129 | - * Send redirect response |
|
130 | - * @param string $location to redirect to |
|
131 | - * @since 4.0.0 |
|
132 | - */ |
|
133 | - static public function redirect( $location ) { |
|
134 | - \OC_Response::redirect( $location ); |
|
135 | - } |
|
128 | + /** |
|
129 | + * Send redirect response |
|
130 | + * @param string $location to redirect to |
|
131 | + * @since 4.0.0 |
|
132 | + */ |
|
133 | + static public function redirect( $location ) { |
|
134 | + \OC_Response::redirect( $location ); |
|
135 | + } |
|
136 | 136 | } |