@@ -38,11 +38,11 @@ |
||
| 38 | 38 | */ |
| 39 | 39 | interface IUserBackend { |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Backend name to be shown in user management |
|
| 43 | - * @return string the name of the backend to be shown |
|
| 44 | - * @since 8.0.0 |
|
| 45 | - */ |
|
| 46 | - public function getBackendName(); |
|
| 41 | + /** |
|
| 42 | + * Backend name to be shown in user management |
|
| 43 | + * @return string the name of the backend to be shown |
|
| 44 | + * @since 8.0.0 |
|
| 45 | + */ |
|
| 46 | + public function getBackendName(); |
|
| 47 | 47 | |
| 48 | 48 | } |
@@ -50,179 +50,179 @@ |
||
| 50 | 50 | |
| 51 | 51 | interface ITags { |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Check if any tags are saved for this type and user. |
|
| 55 | - * |
|
| 56 | - * @return boolean |
|
| 57 | - * @since 6.0.0 |
|
| 58 | - */ |
|
| 59 | - public function isEmpty(); |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Returns an array mapping a given tag's properties to its values: |
|
| 63 | - * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype'] |
|
| 64 | - * |
|
| 65 | - * @param string $id The ID of the tag that is going to be mapped |
|
| 66 | - * @return array|false |
|
| 67 | - * @since 8.0.0 |
|
| 68 | - */ |
|
| 69 | - public function getTag($id); |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * Get the tags for a specific user. |
|
| 73 | - * |
|
| 74 | - * This returns an array with id/name maps: |
|
| 75 | - * [ |
|
| 76 | - * ['id' => 0, 'name' = 'First tag'], |
|
| 77 | - * ['id' => 1, 'name' = 'Second tag'], |
|
| 78 | - * ] |
|
| 79 | - * |
|
| 80 | - * @return array |
|
| 81 | - * @since 6.0.0 |
|
| 82 | - */ |
|
| 83 | - public function getTags(); |
|
| 84 | - |
|
| 85 | - /** |
|
| 86 | - * Get a list of tags for the given item ids. |
|
| 87 | - * |
|
| 88 | - * This returns an array with object id / tag names: |
|
| 89 | - * [ |
|
| 90 | - * 1 => array('First tag', 'Second tag'), |
|
| 91 | - * 2 => array('Second tag'), |
|
| 92 | - * 3 => array('Second tag', 'Third tag'), |
|
| 93 | - * ] |
|
| 94 | - * |
|
| 95 | - * @param array $objIds item ids |
|
| 96 | - * @return array|boolean with object id as key and an array |
|
| 97 | - * of tag names as value or false if an error occurred |
|
| 98 | - * @since 8.0.0 |
|
| 99 | - */ |
|
| 100 | - public function getTagsForObjects(array $objIds); |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Get a list of items tagged with $tag. |
|
| 104 | - * |
|
| 105 | - * Throws an exception if the tag could not be found. |
|
| 106 | - * |
|
| 107 | - * @param string|integer $tag Tag id or name. |
|
| 108 | - * @return array|false An array of object ids or false on error. |
|
| 109 | - * @since 6.0.0 |
|
| 110 | - */ |
|
| 111 | - public function getIdsForTag($tag); |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Checks whether a tag is already saved. |
|
| 115 | - * |
|
| 116 | - * @param string $name The name to check for. |
|
| 117 | - * @return bool |
|
| 118 | - * @since 6.0.0 |
|
| 119 | - */ |
|
| 120 | - public function hasTag($name); |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Checks whether a tag is saved for the given user, |
|
| 124 | - * disregarding the ones shared with him or her. |
|
| 125 | - * |
|
| 126 | - * @param string $name The tag name to check for. |
|
| 127 | - * @param string $user The user whose tags are to be checked. |
|
| 128 | - * @return bool |
|
| 129 | - * @since 8.0.0 |
|
| 130 | - */ |
|
| 131 | - public function userHasTag($name, $user); |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Add a new tag. |
|
| 135 | - * |
|
| 136 | - * @param string $name A string with a name of the tag |
|
| 137 | - * @return int|false the id of the added tag or false if it already exists. |
|
| 138 | - * @since 6.0.0 |
|
| 139 | - */ |
|
| 140 | - public function add($name); |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * Rename tag. |
|
| 144 | - * |
|
| 145 | - * @param string|integer $from The name or ID of the existing tag |
|
| 146 | - * @param string $to The new name of the tag. |
|
| 147 | - * @return bool |
|
| 148 | - * @since 6.0.0 |
|
| 149 | - */ |
|
| 150 | - public function rename($from, $to); |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * Add a list of new tags. |
|
| 154 | - * |
|
| 155 | - * @param string[] $names A string with a name or an array of strings containing |
|
| 156 | - * the name(s) of the to add. |
|
| 157 | - * @param bool $sync When true, save the tags |
|
| 158 | - * @param int|null $id int Optional object id to add to this|these tag(s) |
|
| 159 | - * @return bool Returns false on error. |
|
| 160 | - * @since 6.0.0 |
|
| 161 | - */ |
|
| 162 | - public function addMultiple($names, $sync=false, $id = null); |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Delete tag/object relations from the db |
|
| 166 | - * |
|
| 167 | - * @param array $ids The ids of the objects |
|
| 168 | - * @return boolean Returns false on error. |
|
| 169 | - * @since 6.0.0 |
|
| 170 | - */ |
|
| 171 | - public function purgeObjects(array $ids); |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Get favorites for an object type |
|
| 175 | - * |
|
| 176 | - * @return array|false An array of object ids. |
|
| 177 | - * @since 6.0.0 |
|
| 178 | - */ |
|
| 179 | - public function getFavorites(); |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Add an object to favorites |
|
| 183 | - * |
|
| 184 | - * @param int $objid The id of the object |
|
| 185 | - * @return boolean |
|
| 186 | - * @since 6.0.0 |
|
| 187 | - */ |
|
| 188 | - public function addToFavorites($objid); |
|
| 189 | - |
|
| 190 | - /** |
|
| 191 | - * Remove an object from favorites |
|
| 192 | - * |
|
| 193 | - * @param int $objid The id of the object |
|
| 194 | - * @return boolean |
|
| 195 | - * @since 6.0.0 |
|
| 196 | - */ |
|
| 197 | - public function removeFromFavorites($objid); |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * Creates a tag/object relation. |
|
| 201 | - * |
|
| 202 | - * @param int $objid The id of the object |
|
| 203 | - * @param string $tag The id or name of the tag |
|
| 204 | - * @return boolean Returns false on database error. |
|
| 205 | - * @since 6.0.0 |
|
| 206 | - */ |
|
| 207 | - public function tagAs($objid, $tag); |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * Delete single tag/object relation from the db |
|
| 211 | - * |
|
| 212 | - * @param int $objid The id of the object |
|
| 213 | - * @param string $tag The id or name of the tag |
|
| 214 | - * @return boolean |
|
| 215 | - * @since 6.0.0 |
|
| 216 | - */ |
|
| 217 | - public function unTag($objid, $tag); |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * Delete tags from the database |
|
| 221 | - * |
|
| 222 | - * @param string[]|integer[] $names An array of tags (names or IDs) to delete |
|
| 223 | - * @return bool Returns false on error |
|
| 224 | - * @since 6.0.0 |
|
| 225 | - */ |
|
| 226 | - public function delete($names); |
|
| 53 | + /** |
|
| 54 | + * Check if any tags are saved for this type and user. |
|
| 55 | + * |
|
| 56 | + * @return boolean |
|
| 57 | + * @since 6.0.0 |
|
| 58 | + */ |
|
| 59 | + public function isEmpty(); |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Returns an array mapping a given tag's properties to its values: |
|
| 63 | + * ['id' => 0, 'name' = 'Tag', 'owner' = 'User', 'type' => 'tagtype'] |
|
| 64 | + * |
|
| 65 | + * @param string $id The ID of the tag that is going to be mapped |
|
| 66 | + * @return array|false |
|
| 67 | + * @since 8.0.0 |
|
| 68 | + */ |
|
| 69 | + public function getTag($id); |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * Get the tags for a specific user. |
|
| 73 | + * |
|
| 74 | + * This returns an array with id/name maps: |
|
| 75 | + * [ |
|
| 76 | + * ['id' => 0, 'name' = 'First tag'], |
|
| 77 | + * ['id' => 1, 'name' = 'Second tag'], |
|
| 78 | + * ] |
|
| 79 | + * |
|
| 80 | + * @return array |
|
| 81 | + * @since 6.0.0 |
|
| 82 | + */ |
|
| 83 | + public function getTags(); |
|
| 84 | + |
|
| 85 | + /** |
|
| 86 | + * Get a list of tags for the given item ids. |
|
| 87 | + * |
|
| 88 | + * This returns an array with object id / tag names: |
|
| 89 | + * [ |
|
| 90 | + * 1 => array('First tag', 'Second tag'), |
|
| 91 | + * 2 => array('Second tag'), |
|
| 92 | + * 3 => array('Second tag', 'Third tag'), |
|
| 93 | + * ] |
|
| 94 | + * |
|
| 95 | + * @param array $objIds item ids |
|
| 96 | + * @return array|boolean with object id as key and an array |
|
| 97 | + * of tag names as value or false if an error occurred |
|
| 98 | + * @since 8.0.0 |
|
| 99 | + */ |
|
| 100 | + public function getTagsForObjects(array $objIds); |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Get a list of items tagged with $tag. |
|
| 104 | + * |
|
| 105 | + * Throws an exception if the tag could not be found. |
|
| 106 | + * |
|
| 107 | + * @param string|integer $tag Tag id or name. |
|
| 108 | + * @return array|false An array of object ids or false on error. |
|
| 109 | + * @since 6.0.0 |
|
| 110 | + */ |
|
| 111 | + public function getIdsForTag($tag); |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Checks whether a tag is already saved. |
|
| 115 | + * |
|
| 116 | + * @param string $name The name to check for. |
|
| 117 | + * @return bool |
|
| 118 | + * @since 6.0.0 |
|
| 119 | + */ |
|
| 120 | + public function hasTag($name); |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Checks whether a tag is saved for the given user, |
|
| 124 | + * disregarding the ones shared with him or her. |
|
| 125 | + * |
|
| 126 | + * @param string $name The tag name to check for. |
|
| 127 | + * @param string $user The user whose tags are to be checked. |
|
| 128 | + * @return bool |
|
| 129 | + * @since 8.0.0 |
|
| 130 | + */ |
|
| 131 | + public function userHasTag($name, $user); |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Add a new tag. |
|
| 135 | + * |
|
| 136 | + * @param string $name A string with a name of the tag |
|
| 137 | + * @return int|false the id of the added tag or false if it already exists. |
|
| 138 | + * @since 6.0.0 |
|
| 139 | + */ |
|
| 140 | + public function add($name); |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * Rename tag. |
|
| 144 | + * |
|
| 145 | + * @param string|integer $from The name or ID of the existing tag |
|
| 146 | + * @param string $to The new name of the tag. |
|
| 147 | + * @return bool |
|
| 148 | + * @since 6.0.0 |
|
| 149 | + */ |
|
| 150 | + public function rename($from, $to); |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * Add a list of new tags. |
|
| 154 | + * |
|
| 155 | + * @param string[] $names A string with a name or an array of strings containing |
|
| 156 | + * the name(s) of the to add. |
|
| 157 | + * @param bool $sync When true, save the tags |
|
| 158 | + * @param int|null $id int Optional object id to add to this|these tag(s) |
|
| 159 | + * @return bool Returns false on error. |
|
| 160 | + * @since 6.0.0 |
|
| 161 | + */ |
|
| 162 | + public function addMultiple($names, $sync=false, $id = null); |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Delete tag/object relations from the db |
|
| 166 | + * |
|
| 167 | + * @param array $ids The ids of the objects |
|
| 168 | + * @return boolean Returns false on error. |
|
| 169 | + * @since 6.0.0 |
|
| 170 | + */ |
|
| 171 | + public function purgeObjects(array $ids); |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Get favorites for an object type |
|
| 175 | + * |
|
| 176 | + * @return array|false An array of object ids. |
|
| 177 | + * @since 6.0.0 |
|
| 178 | + */ |
|
| 179 | + public function getFavorites(); |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Add an object to favorites |
|
| 183 | + * |
|
| 184 | + * @param int $objid The id of the object |
|
| 185 | + * @return boolean |
|
| 186 | + * @since 6.0.0 |
|
| 187 | + */ |
|
| 188 | + public function addToFavorites($objid); |
|
| 189 | + |
|
| 190 | + /** |
|
| 191 | + * Remove an object from favorites |
|
| 192 | + * |
|
| 193 | + * @param int $objid The id of the object |
|
| 194 | + * @return boolean |
|
| 195 | + * @since 6.0.0 |
|
| 196 | + */ |
|
| 197 | + public function removeFromFavorites($objid); |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * Creates a tag/object relation. |
|
| 201 | + * |
|
| 202 | + * @param int $objid The id of the object |
|
| 203 | + * @param string $tag The id or name of the tag |
|
| 204 | + * @return boolean Returns false on database error. |
|
| 205 | + * @since 6.0.0 |
|
| 206 | + */ |
|
| 207 | + public function tagAs($objid, $tag); |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * Delete single tag/object relation from the db |
|
| 211 | + * |
|
| 212 | + * @param int $objid The id of the object |
|
| 213 | + * @param string $tag The id or name of the tag |
|
| 214 | + * @return boolean |
|
| 215 | + * @since 6.0.0 |
|
| 216 | + */ |
|
| 217 | + public function unTag($objid, $tag); |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Delete tags from the database |
|
| 221 | + * |
|
| 222 | + * @param string[]|integer[] $names An array of tags (names or IDs) to delete |
|
| 223 | + * @return bool Returns false on error |
|
| 224 | + * @since 6.0.0 |
|
| 225 | + */ |
|
| 226 | + public function delete($names); |
|
| 227 | 227 | |
| 228 | 228 | } |
@@ -159,7 +159,7 @@ |
||
| 159 | 159 | * @return bool Returns false on error. |
| 160 | 160 | * @since 6.0.0 |
| 161 | 161 | */ |
| 162 | - public function addMultiple($names, $sync=false, $id = null); |
|
| 162 | + public function addMultiple($names, $sync = false, $id = null); |
|
| 163 | 163 | |
| 164 | 164 | /** |
| 165 | 165 | * Delete tag/object relations from the db |
@@ -30,33 +30,33 @@ |
||
| 30 | 30 | * @since 8.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IEvent { |
| 33 | - /** |
|
| 34 | - * @return string |
|
| 35 | - * @since 8.0.0 |
|
| 36 | - */ |
|
| 37 | - public function getId(); |
|
| 33 | + /** |
|
| 34 | + * @return string |
|
| 35 | + * @since 8.0.0 |
|
| 36 | + */ |
|
| 37 | + public function getId(); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @return string |
|
| 41 | - * @since 8.0.0 |
|
| 42 | - */ |
|
| 43 | - public function getDescription(); |
|
| 39 | + /** |
|
| 40 | + * @return string |
|
| 41 | + * @since 8.0.0 |
|
| 42 | + */ |
|
| 43 | + public function getDescription(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @return float |
|
| 47 | - * @since 8.0.0 |
|
| 48 | - */ |
|
| 49 | - public function getStart(); |
|
| 45 | + /** |
|
| 46 | + * @return float |
|
| 47 | + * @since 8.0.0 |
|
| 48 | + */ |
|
| 49 | + public function getStart(); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @return float |
|
| 53 | - * @since 8.0.0 |
|
| 54 | - */ |
|
| 55 | - public function getEnd(); |
|
| 51 | + /** |
|
| 52 | + * @return float |
|
| 53 | + * @since 8.0.0 |
|
| 54 | + */ |
|
| 55 | + public function getEnd(); |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @return float |
|
| 59 | - * @since 8.0.0 |
|
| 60 | - */ |
|
| 61 | - public function getDuration(); |
|
| 57 | + /** |
|
| 58 | + * @return float |
|
| 59 | + * @since 8.0.0 |
|
| 60 | + */ |
|
| 61 | + public function getDuration(); |
|
| 62 | 62 | } |
@@ -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 | } |
@@ -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 | } |
@@ -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 | } |