@@ -30,10 +30,10 @@ |
||
| 30 | 30 | * @since 8.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IDateTimeZone { |
| 33 | - /** |
|
| 34 | - * @param bool|int $timestamp |
|
| 35 | - * @return \DateTimeZone |
|
| 36 | - * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
| 37 | - */ |
|
| 38 | - public function getTimeZone($timestamp = false); |
|
| 33 | + /** |
|
| 34 | + * @param bool|int $timestamp |
|
| 35 | + * @return \DateTimeZone |
|
| 36 | + * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
| 37 | + */ |
|
| 38 | + public function getTimeZone($timestamp = false); |
|
| 39 | 39 | } |
@@ -68,7 +68,7 @@ |
||
| 68 | 68 | * remove all user backends |
| 69 | 69 | * @since 8.0.0 |
| 70 | 70 | */ |
| 71 | - public function clearBackends() ; |
|
| 71 | + public function clearBackends(); |
|
| 72 | 72 | |
| 73 | 73 | /** |
| 74 | 74 | * get a user by user id |
@@ -46,183 +46,183 @@ |
||
| 46 | 46 | * @since 8.0.0 |
| 47 | 47 | */ |
| 48 | 48 | interface IUserManager { |
| 49 | - /** |
|
| 50 | - * @since 26.0.0 |
|
| 51 | - */ |
|
| 52 | - public const MAX_PASSWORD_LENGTH = 469; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * register a user backend |
|
| 56 | - * |
|
| 57 | - * @param \OCP\UserInterface $backend |
|
| 58 | - * @since 8.0.0 |
|
| 59 | - */ |
|
| 60 | - public function registerBackend($backend); |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * Get the active backends |
|
| 64 | - * @return \OCP\UserInterface[] |
|
| 65 | - * @since 8.0.0 |
|
| 66 | - */ |
|
| 67 | - public function getBackends(); |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * remove a user backend |
|
| 71 | - * |
|
| 72 | - * @param \OCP\UserInterface $backend |
|
| 73 | - * @since 8.0.0 |
|
| 74 | - */ |
|
| 75 | - public function removeBackend($backend); |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * remove all user backends |
|
| 79 | - * @since 8.0.0 |
|
| 80 | - */ |
|
| 81 | - public function clearBackends() ; |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * get a user by user id |
|
| 85 | - * |
|
| 86 | - * @param string $uid |
|
| 87 | - * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
| 88 | - * @since 8.0.0 |
|
| 89 | - */ |
|
| 90 | - public function get($uid); |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Get the display name of a user |
|
| 94 | - * |
|
| 95 | - * @param string $uid |
|
| 96 | - * @return string|null |
|
| 97 | - * @since 25.0.0 |
|
| 98 | - */ |
|
| 99 | - public function getDisplayName(string $uid): ?string; |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * check if a user exists |
|
| 103 | - * |
|
| 104 | - * @param string $uid |
|
| 105 | - * @return bool |
|
| 106 | - * @since 8.0.0 |
|
| 107 | - */ |
|
| 108 | - public function userExists($uid); |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Check if the password is valid for the user |
|
| 112 | - * |
|
| 113 | - * @param string $loginName |
|
| 114 | - * @param string $password |
|
| 115 | - * @return IUser|false the User object on success, false otherwise |
|
| 116 | - * @since 8.0.0 |
|
| 117 | - */ |
|
| 118 | - public function checkPassword($loginName, $password); |
|
| 119 | - |
|
| 120 | - /** |
|
| 121 | - * search by user id |
|
| 122 | - * |
|
| 123 | - * @param string $pattern |
|
| 124 | - * @param int $limit |
|
| 125 | - * @param int $offset |
|
| 126 | - * @return \OCP\IUser[] |
|
| 127 | - * @since 8.0.0 |
|
| 128 | - */ |
|
| 129 | - public function search($pattern, $limit = null, $offset = null); |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * search by displayName |
|
| 133 | - * |
|
| 134 | - * @param string $pattern |
|
| 135 | - * @param int $limit |
|
| 136 | - * @param int $offset |
|
| 137 | - * @return \OCP\IUser[] |
|
| 138 | - * @since 8.0.0 |
|
| 139 | - */ |
|
| 140 | - public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * Search known users (from phonebook sync) by displayName |
|
| 144 | - * |
|
| 145 | - * @param string $searcher |
|
| 146 | - * @param string $pattern |
|
| 147 | - * @param int|null $limit |
|
| 148 | - * @param int|null $offset |
|
| 149 | - * @return IUser[] |
|
| 150 | - * @since 21.0.1 |
|
| 151 | - */ |
|
| 152 | - public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array; |
|
| 153 | - |
|
| 154 | - /** |
|
| 155 | - * @param string $uid |
|
| 156 | - * @param string $password |
|
| 157 | - * @throws \InvalidArgumentException |
|
| 158 | - * @return false|\OCP\IUser the created user or false |
|
| 159 | - * @since 8.0.0 |
|
| 160 | - */ |
|
| 161 | - public function createUser($uid, $password); |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * @param string $uid |
|
| 165 | - * @param string $password |
|
| 166 | - * @param UserInterface $backend |
|
| 167 | - * @return IUser|null |
|
| 168 | - * @throws \InvalidArgumentException |
|
| 169 | - * @since 12.0.0 |
|
| 170 | - */ |
|
| 171 | - public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * Get how many users per backend exist (if supported by backend) |
|
| 175 | - * |
|
| 176 | - * @return array<string, int> an array of backend class name as key and count number as value |
|
| 177 | - * @since 8.0.0 |
|
| 178 | - */ |
|
| 179 | - public function countUsers(); |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * @param \Closure $callback |
|
| 183 | - * @psalm-param \Closure(\OCP\IUser):void $callback |
|
| 184 | - * @param string $search |
|
| 185 | - * @since 9.0.0 |
|
| 186 | - */ |
|
| 187 | - public function callForAllUsers(\Closure $callback, $search = ''); |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * returns how many users have logged in once |
|
| 191 | - * |
|
| 192 | - * @return int |
|
| 193 | - * @since 11.0.0 |
|
| 194 | - */ |
|
| 195 | - public function countDisabledUsers(); |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * returns how many users have logged in once |
|
| 199 | - * |
|
| 200 | - * @return int |
|
| 201 | - * @since 11.0.0 |
|
| 202 | - */ |
|
| 203 | - public function countSeenUsers(); |
|
| 204 | - |
|
| 205 | - /** |
|
| 206 | - * @param \Closure $callback |
|
| 207 | - * @psalm-param \Closure(\OCP\IUser):?bool $callback |
|
| 208 | - * @since 11.0.0 |
|
| 209 | - */ |
|
| 210 | - public function callForSeenUsers(\Closure $callback); |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * returns all users having the provided email set as system email address |
|
| 214 | - * |
|
| 215 | - * @param string $email |
|
| 216 | - * @return IUser[] |
|
| 217 | - * @since 9.1.0 |
|
| 218 | - */ |
|
| 219 | - public function getByEmail($email); |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * @param string $uid The user ID to validate |
|
| 223 | - * @param bool $checkDataDirectory Whether it should be checked if files for the ID exist inside the data directory |
|
| 224 | - * @throws \InvalidArgumentException Message is an already translated string with a reason why the ID is not valid |
|
| 225 | - * @since 26.0.0 |
|
| 226 | - */ |
|
| 227 | - public function validateUserId(string $uid, bool $checkDataDirectory = false): void; |
|
| 49 | + /** |
|
| 50 | + * @since 26.0.0 |
|
| 51 | + */ |
|
| 52 | + public const MAX_PASSWORD_LENGTH = 469; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * register a user backend |
|
| 56 | + * |
|
| 57 | + * @param \OCP\UserInterface $backend |
|
| 58 | + * @since 8.0.0 |
|
| 59 | + */ |
|
| 60 | + public function registerBackend($backend); |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * Get the active backends |
|
| 64 | + * @return \OCP\UserInterface[] |
|
| 65 | + * @since 8.0.0 |
|
| 66 | + */ |
|
| 67 | + public function getBackends(); |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * remove a user backend |
|
| 71 | + * |
|
| 72 | + * @param \OCP\UserInterface $backend |
|
| 73 | + * @since 8.0.0 |
|
| 74 | + */ |
|
| 75 | + public function removeBackend($backend); |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * remove all user backends |
|
| 79 | + * @since 8.0.0 |
|
| 80 | + */ |
|
| 81 | + public function clearBackends() ; |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * get a user by user id |
|
| 85 | + * |
|
| 86 | + * @param string $uid |
|
| 87 | + * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
| 88 | + * @since 8.0.0 |
|
| 89 | + */ |
|
| 90 | + public function get($uid); |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Get the display name of a user |
|
| 94 | + * |
|
| 95 | + * @param string $uid |
|
| 96 | + * @return string|null |
|
| 97 | + * @since 25.0.0 |
|
| 98 | + */ |
|
| 99 | + public function getDisplayName(string $uid): ?string; |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * check if a user exists |
|
| 103 | + * |
|
| 104 | + * @param string $uid |
|
| 105 | + * @return bool |
|
| 106 | + * @since 8.0.0 |
|
| 107 | + */ |
|
| 108 | + public function userExists($uid); |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Check if the password is valid for the user |
|
| 112 | + * |
|
| 113 | + * @param string $loginName |
|
| 114 | + * @param string $password |
|
| 115 | + * @return IUser|false the User object on success, false otherwise |
|
| 116 | + * @since 8.0.0 |
|
| 117 | + */ |
|
| 118 | + public function checkPassword($loginName, $password); |
|
| 119 | + |
|
| 120 | + /** |
|
| 121 | + * search by user id |
|
| 122 | + * |
|
| 123 | + * @param string $pattern |
|
| 124 | + * @param int $limit |
|
| 125 | + * @param int $offset |
|
| 126 | + * @return \OCP\IUser[] |
|
| 127 | + * @since 8.0.0 |
|
| 128 | + */ |
|
| 129 | + public function search($pattern, $limit = null, $offset = null); |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * search by displayName |
|
| 133 | + * |
|
| 134 | + * @param string $pattern |
|
| 135 | + * @param int $limit |
|
| 136 | + * @param int $offset |
|
| 137 | + * @return \OCP\IUser[] |
|
| 138 | + * @since 8.0.0 |
|
| 139 | + */ |
|
| 140 | + public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * Search known users (from phonebook sync) by displayName |
|
| 144 | + * |
|
| 145 | + * @param string $searcher |
|
| 146 | + * @param string $pattern |
|
| 147 | + * @param int|null $limit |
|
| 148 | + * @param int|null $offset |
|
| 149 | + * @return IUser[] |
|
| 150 | + * @since 21.0.1 |
|
| 151 | + */ |
|
| 152 | + public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array; |
|
| 153 | + |
|
| 154 | + /** |
|
| 155 | + * @param string $uid |
|
| 156 | + * @param string $password |
|
| 157 | + * @throws \InvalidArgumentException |
|
| 158 | + * @return false|\OCP\IUser the created user or false |
|
| 159 | + * @since 8.0.0 |
|
| 160 | + */ |
|
| 161 | + public function createUser($uid, $password); |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * @param string $uid |
|
| 165 | + * @param string $password |
|
| 166 | + * @param UserInterface $backend |
|
| 167 | + * @return IUser|null |
|
| 168 | + * @throws \InvalidArgumentException |
|
| 169 | + * @since 12.0.0 |
|
| 170 | + */ |
|
| 171 | + public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * Get how many users per backend exist (if supported by backend) |
|
| 175 | + * |
|
| 176 | + * @return array<string, int> an array of backend class name as key and count number as value |
|
| 177 | + * @since 8.0.0 |
|
| 178 | + */ |
|
| 179 | + public function countUsers(); |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * @param \Closure $callback |
|
| 183 | + * @psalm-param \Closure(\OCP\IUser):void $callback |
|
| 184 | + * @param string $search |
|
| 185 | + * @since 9.0.0 |
|
| 186 | + */ |
|
| 187 | + public function callForAllUsers(\Closure $callback, $search = ''); |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * returns how many users have logged in once |
|
| 191 | + * |
|
| 192 | + * @return int |
|
| 193 | + * @since 11.0.0 |
|
| 194 | + */ |
|
| 195 | + public function countDisabledUsers(); |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * returns how many users have logged in once |
|
| 199 | + * |
|
| 200 | + * @return int |
|
| 201 | + * @since 11.0.0 |
|
| 202 | + */ |
|
| 203 | + public function countSeenUsers(); |
|
| 204 | + |
|
| 205 | + /** |
|
| 206 | + * @param \Closure $callback |
|
| 207 | + * @psalm-param \Closure(\OCP\IUser):?bool $callback |
|
| 208 | + * @since 11.0.0 |
|
| 209 | + */ |
|
| 210 | + public function callForSeenUsers(\Closure $callback); |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * returns all users having the provided email set as system email address |
|
| 214 | + * |
|
| 215 | + * @param string $email |
|
| 216 | + * @return IUser[] |
|
| 217 | + * @since 9.1.0 |
|
| 218 | + */ |
|
| 219 | + public function getByEmail($email); |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * @param string $uid The user ID to validate |
|
| 223 | + * @param bool $checkDataDirectory Whether it should be checked if files for the ID exist inside the data directory |
|
| 224 | + * @throws \InvalidArgumentException Message is an already translated string with a reason why the ID is not valid |
|
| 225 | + * @since 26.0.0 |
|
| 226 | + */ |
|
| 227 | + public function validateUserId(string $uid, bool $checkDataDirectory = false): void; |
|
| 228 | 228 | } |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | */ |
| 62 | 62 | public function addEntityCollection($name, \Closure $entityExistsFunction) { |
| 63 | 63 | if (isset($this->collections[$name])) { |
| 64 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
| 64 | + throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"'); |
|
| 65 | 65 | } |
| 66 | 66 | |
| 67 | 67 | $this->collections[$name] = $entityExistsFunction; |
@@ -32,49 +32,49 @@ |
||
| 32 | 32 | * @since 9.1.0 |
| 33 | 33 | */ |
| 34 | 34 | class CommentsEntityEvent extends Event { |
| 35 | - /** |
|
| 36 | - * @deprecated 22.0.0 |
|
| 37 | - */ |
|
| 38 | - public const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
| 35 | + /** |
|
| 36 | + * @deprecated 22.0.0 |
|
| 37 | + */ |
|
| 38 | + public const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity'; |
|
| 39 | 39 | |
| 40 | - /** @var string */ |
|
| 41 | - protected $event; |
|
| 42 | - /** @var \Closure[] */ |
|
| 43 | - protected $collections; |
|
| 40 | + /** @var string */ |
|
| 41 | + protected $event; |
|
| 42 | + /** @var \Closure[] */ |
|
| 43 | + protected $collections; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * DispatcherEvent constructor. |
|
| 47 | - * |
|
| 48 | - * @param string $event |
|
| 49 | - * @since 9.1.0 |
|
| 50 | - */ |
|
| 51 | - public function __construct($event) { |
|
| 52 | - $this->event = $event; |
|
| 53 | - $this->collections = []; |
|
| 54 | - } |
|
| 45 | + /** |
|
| 46 | + * DispatcherEvent constructor. |
|
| 47 | + * |
|
| 48 | + * @param string $event |
|
| 49 | + * @since 9.1.0 |
|
| 50 | + */ |
|
| 51 | + public function __construct($event) { |
|
| 52 | + $this->event = $event; |
|
| 53 | + $this->collections = []; |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @param string $name |
|
| 58 | - * @param \Closure $entityExistsFunction The closure should take one |
|
| 59 | - * argument, which is the id of the entity, that comments |
|
| 60 | - * should be handled for. The return should then be bool, |
|
| 61 | - * depending on whether comments are allowed (true) or not. |
|
| 62 | - * @throws \OutOfBoundsException when the entity name is already taken |
|
| 63 | - * @since 9.1.0 |
|
| 64 | - */ |
|
| 65 | - public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
| 66 | - if (isset($this->collections[$name])) { |
|
| 67 | - throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
| 68 | - } |
|
| 56 | + /** |
|
| 57 | + * @param string $name |
|
| 58 | + * @param \Closure $entityExistsFunction The closure should take one |
|
| 59 | + * argument, which is the id of the entity, that comments |
|
| 60 | + * should be handled for. The return should then be bool, |
|
| 61 | + * depending on whether comments are allowed (true) or not. |
|
| 62 | + * @throws \OutOfBoundsException when the entity name is already taken |
|
| 63 | + * @since 9.1.0 |
|
| 64 | + */ |
|
| 65 | + public function addEntityCollection($name, \Closure $entityExistsFunction) { |
|
| 66 | + if (isset($this->collections[$name])) { |
|
| 67 | + throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"'); |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - $this->collections[$name] = $entityExistsFunction; |
|
| 71 | - } |
|
| 70 | + $this->collections[$name] = $entityExistsFunction; |
|
| 71 | + } |
|
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @return \Closure[] |
|
| 75 | - * @since 9.1.0 |
|
| 76 | - */ |
|
| 77 | - public function getEntityCollections() { |
|
| 78 | - return $this->collections; |
|
| 79 | - } |
|
| 73 | + /** |
|
| 74 | + * @return \Closure[] |
|
| 75 | + * @since 9.1.0 |
|
| 76 | + */ |
|
| 77 | + public function getEntityCollections() { |
|
| 78 | + return $this->collections; |
|
| 79 | + } |
|
| 80 | 80 | } |
@@ -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,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 | } |
@@ -30,9 +30,9 @@ |
||
| 30 | 30 | * @since 8.1.0 |
| 31 | 31 | */ |
| 32 | 32 | interface ICommand { |
| 33 | - /** |
|
| 34 | - * Run the command |
|
| 35 | - * @since 8.1.0 |
|
| 36 | - */ |
|
| 37 | - public function handle(); |
|
| 33 | + /** |
|
| 34 | + * Run the command |
|
| 35 | + * @since 8.1.0 |
|
| 36 | + */ |
|
| 37 | + public function handle(); |
|
| 38 | 38 | } |
@@ -30,19 +30,19 @@ |
||
| 30 | 30 | * @since 8.1.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IBus { |
| 33 | - /** |
|
| 34 | - * Schedule a command to be fired |
|
| 35 | - * |
|
| 36 | - * @param \OCP\Command\ICommand | callable $command |
|
| 37 | - * @since 8.1.0 |
|
| 38 | - */ |
|
| 39 | - public function push($command); |
|
| 33 | + /** |
|
| 34 | + * Schedule a command to be fired |
|
| 35 | + * |
|
| 36 | + * @param \OCP\Command\ICommand | callable $command |
|
| 37 | + * @since 8.1.0 |
|
| 38 | + */ |
|
| 39 | + public function push($command); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Require all commands using a trait to be run synchronous |
|
| 43 | - * |
|
| 44 | - * @param string $trait |
|
| 45 | - * @since 8.1.0 |
|
| 46 | - */ |
|
| 47 | - public function requireSync($trait); |
|
| 41 | + /** |
|
| 42 | + * Require all commands using a trait to be run synchronous |
|
| 43 | + * |
|
| 44 | + * @param string $trait |
|
| 45 | + * @since 8.1.0 |
|
| 46 | + */ |
|
| 47 | + public function requireSync($trait); |
|
| 48 | 48 | } |
@@ -31,13 +31,13 @@ |
||
| 31 | 31 | * @since 5.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface Share_Backend_File_Dependent extends Share_Backend { |
| 34 | - /** |
|
| 35 | - * Get the file path of the item |
|
| 36 | - * @param string $itemSource |
|
| 37 | - * @param string $uidOwner User that is the owner of shared item |
|
| 38 | - * @return string|false |
|
| 39 | - * @since 5.0.0 |
|
| 40 | - */ |
|
| 41 | - public function getFilePath($itemSource, $uidOwner); |
|
| 34 | + /** |
|
| 35 | + * Get the file path of the item |
|
| 36 | + * @param string $itemSource |
|
| 37 | + * @param string $uidOwner User that is the owner of shared item |
|
| 38 | + * @return string|false |
|
| 39 | + * @since 5.0.0 |
|
| 40 | + */ |
|
| 41 | + public function getFilePath($itemSource, $uidOwner); |
|
| 42 | 42 | |
| 43 | 43 | } |