@@ -41,77 +41,77 @@ |
||
| 41 | 41 | * @since 6.0.0 |
| 42 | 42 | */ |
| 43 | 43 | interface ISession { |
| 44 | - /** |
|
| 45 | - * Set a value in the session |
|
| 46 | - * |
|
| 47 | - * @param string $key |
|
| 48 | - * @param mixed $value |
|
| 49 | - * @since 6.0.0 |
|
| 50 | - */ |
|
| 51 | - public function set(string $key, $value); |
|
| 44 | + /** |
|
| 45 | + * Set a value in the session |
|
| 46 | + * |
|
| 47 | + * @param string $key |
|
| 48 | + * @param mixed $value |
|
| 49 | + * @since 6.0.0 |
|
| 50 | + */ |
|
| 51 | + public function set(string $key, $value); |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Get a value from the session |
|
| 55 | - * |
|
| 56 | - * @param string $key |
|
| 57 | - * @return mixed should return null if $key does not exist |
|
| 58 | - * @since 6.0.0 |
|
| 59 | - */ |
|
| 60 | - public function get(string $key); |
|
| 53 | + /** |
|
| 54 | + * Get a value from the session |
|
| 55 | + * |
|
| 56 | + * @param string $key |
|
| 57 | + * @return mixed should return null if $key does not exist |
|
| 58 | + * @since 6.0.0 |
|
| 59 | + */ |
|
| 60 | + public function get(string $key); |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Check if a named key exists in the session |
|
| 64 | - * |
|
| 65 | - * @param string $key |
|
| 66 | - * @return bool |
|
| 67 | - * @since 6.0.0 |
|
| 68 | - */ |
|
| 69 | - public function exists(string $key): bool; |
|
| 62 | + /** |
|
| 63 | + * Check if a named key exists in the session |
|
| 64 | + * |
|
| 65 | + * @param string $key |
|
| 66 | + * @return bool |
|
| 67 | + * @since 6.0.0 |
|
| 68 | + */ |
|
| 69 | + public function exists(string $key): bool; |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Remove a $key/$value pair from the session |
|
| 73 | - * |
|
| 74 | - * @param string $key |
|
| 75 | - * @since 6.0.0 |
|
| 76 | - */ |
|
| 77 | - public function remove(string $key); |
|
| 71 | + /** |
|
| 72 | + * Remove a $key/$value pair from the session |
|
| 73 | + * |
|
| 74 | + * @param string $key |
|
| 75 | + * @since 6.0.0 |
|
| 76 | + */ |
|
| 77 | + public function remove(string $key); |
|
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Reset and recreate the session |
|
| 81 | - * @since 6.0.0 |
|
| 82 | - */ |
|
| 83 | - public function clear(); |
|
| 79 | + /** |
|
| 80 | + * Reset and recreate the session |
|
| 81 | + * @since 6.0.0 |
|
| 82 | + */ |
|
| 83 | + public function clear(); |
|
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Reopen a session for writing again |
|
| 87 | - * |
|
| 88 | - * @return bool true if the session was actually reopened, otherwise false |
|
| 89 | - * @since 25.0.0 |
|
| 90 | - */ |
|
| 91 | - public function reopen(): bool; |
|
| 85 | + /** |
|
| 86 | + * Reopen a session for writing again |
|
| 87 | + * |
|
| 88 | + * @return bool true if the session was actually reopened, otherwise false |
|
| 89 | + * @since 25.0.0 |
|
| 90 | + */ |
|
| 91 | + public function reopen(): bool; |
|
| 92 | 92 | |
| 93 | - /** |
|
| 94 | - * Close the session and release the lock |
|
| 95 | - * @since 7.0.0 |
|
| 96 | - */ |
|
| 97 | - public function close(); |
|
| 93 | + /** |
|
| 94 | + * Close the session and release the lock |
|
| 95 | + * @since 7.0.0 |
|
| 96 | + */ |
|
| 97 | + public function close(); |
|
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Wrapper around session_regenerate_id |
|
| 101 | - * |
|
| 102 | - * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
| 103 | - * @param bool $updateToken Wheater to update the associated auth token |
|
| 104 | - * @return void |
|
| 105 | - * @since 9.0.0, $updateToken added in 14.0.0 |
|
| 106 | - */ |
|
| 107 | - public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false); |
|
| 99 | + /** |
|
| 100 | + * Wrapper around session_regenerate_id |
|
| 101 | + * |
|
| 102 | + * @param bool $deleteOldSession Whether to delete the old associated session file or not. |
|
| 103 | + * @param bool $updateToken Wheater to update the associated auth token |
|
| 104 | + * @return void |
|
| 105 | + * @since 9.0.0, $updateToken added in 14.0.0 |
|
| 106 | + */ |
|
| 107 | + public function regenerateId(bool $deleteOldSession = true, bool $updateToken = false); |
|
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Wrapper around session_id |
|
| 111 | - * |
|
| 112 | - * @return string |
|
| 113 | - * @throws SessionNotAvailableException |
|
| 114 | - * @since 9.1.0 |
|
| 115 | - */ |
|
| 116 | - public function getId(): string; |
|
| 109 | + /** |
|
| 110 | + * Wrapper around session_id |
|
| 111 | + * |
|
| 112 | + * @return string |
|
| 113 | + * @throws SessionNotAvailableException |
|
| 114 | + * @since 9.1.0 |
|
| 115 | + */ |
|
| 116 | + public function getId(): string; |
|
| 117 | 117 | } |
@@ -28,21 +28,21 @@ |
||
| 28 | 28 | * @since 9.1.0 |
| 29 | 29 | */ |
| 30 | 30 | interface IRepairStep { |
| 31 | - /** |
|
| 32 | - * Returns the step's name |
|
| 33 | - * |
|
| 34 | - * @return string |
|
| 35 | - * @since 9.1.0 |
|
| 36 | - */ |
|
| 37 | - public function getName(); |
|
| 31 | + /** |
|
| 32 | + * Returns the step's name |
|
| 33 | + * |
|
| 34 | + * @return string |
|
| 35 | + * @since 9.1.0 |
|
| 36 | + */ |
|
| 37 | + public function getName(); |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Run repair step. |
|
| 41 | - * Must throw exception on error. |
|
| 42 | - * |
|
| 43 | - * @param IOutput $output |
|
| 44 | - * @throws \Exception in case of failure |
|
| 45 | - * @since 9.1.0 |
|
| 46 | - */ |
|
| 47 | - public function run(IOutput $output); |
|
| 39 | + /** |
|
| 40 | + * Run repair step. |
|
| 41 | + * Must throw exception on error. |
|
| 42 | + * |
|
| 43 | + * @param IOutput $output |
|
| 44 | + * @throws \Exception in case of failure |
|
| 45 | + * @since 9.1.0 |
|
| 46 | + */ |
|
| 47 | + public function run(IOutput $output); |
|
| 48 | 48 | } |
@@ -32,16 +32,16 @@ |
||
| 32 | 32 | * @deprecated 9.0.0 |
| 33 | 33 | */ |
| 34 | 34 | interface IRouter { |
| 35 | - /** |
|
| 36 | - * Create a \OCP\Route\IRoute. |
|
| 37 | - * |
|
| 38 | - * @param string $name Name of the route to create. |
|
| 39 | - * @param string $pattern The pattern to match |
|
| 40 | - * @param array $defaults An array of default parameter values |
|
| 41 | - * @param array $requirements An array of requirements for parameters (regexes) |
|
| 42 | - * @return \OCP\Route\IRoute |
|
| 43 | - * @since 7.0.0 |
|
| 44 | - * @deprecated 9.0.0 |
|
| 45 | - */ |
|
| 46 | - public function create($name, $pattern, array $defaults = [], array $requirements = []); |
|
| 35 | + /** |
|
| 36 | + * Create a \OCP\Route\IRoute. |
|
| 37 | + * |
|
| 38 | + * @param string $name Name of the route to create. |
|
| 39 | + * @param string $pattern The pattern to match |
|
| 40 | + * @param array $defaults An array of default parameter values |
|
| 41 | + * @param array $requirements An array of requirements for parameters (regexes) |
|
| 42 | + * @return \OCP\Route\IRoute |
|
| 43 | + * @since 7.0.0 |
|
| 44 | + * @deprecated 9.0.0 |
|
| 45 | + */ |
|
| 46 | + public function create($name, $pattern, array $defaults = [], array $requirements = []); |
|
| 47 | 47 | } |
@@ -32,68 +32,68 @@ |
||
| 32 | 32 | * @since 16.0.0 |
| 33 | 33 | */ |
| 34 | 34 | interface ISubAdmin { |
| 35 | - /** |
|
| 36 | - * add a SubAdmin |
|
| 37 | - * @param IUser $user user to be SubAdmin |
|
| 38 | - * @param IGroup $group group $user becomes subadmin of |
|
| 39 | - * |
|
| 40 | - * @since 16.0.0 |
|
| 41 | - */ |
|
| 42 | - public function createSubAdmin(IUser $user, IGroup $group): void; |
|
| 35 | + /** |
|
| 36 | + * add a SubAdmin |
|
| 37 | + * @param IUser $user user to be SubAdmin |
|
| 38 | + * @param IGroup $group group $user becomes subadmin of |
|
| 39 | + * |
|
| 40 | + * @since 16.0.0 |
|
| 41 | + */ |
|
| 42 | + public function createSubAdmin(IUser $user, IGroup $group): void; |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * delete a SubAdmin |
|
| 46 | - * @param IUser $user the user that is the SubAdmin |
|
| 47 | - * @param IGroup $group the group |
|
| 48 | - * |
|
| 49 | - * @since 16.0.0 |
|
| 50 | - */ |
|
| 51 | - public function deleteSubAdmin(IUser $user, IGroup $group): void; |
|
| 44 | + /** |
|
| 45 | + * delete a SubAdmin |
|
| 46 | + * @param IUser $user the user that is the SubAdmin |
|
| 47 | + * @param IGroup $group the group |
|
| 48 | + * |
|
| 49 | + * @since 16.0.0 |
|
| 50 | + */ |
|
| 51 | + public function deleteSubAdmin(IUser $user, IGroup $group): void; |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * get groups of a SubAdmin |
|
| 55 | - * @param IUser $user the SubAdmin |
|
| 56 | - * @return IGroup[] |
|
| 57 | - * |
|
| 58 | - * @since 16.0.0 |
|
| 59 | - */ |
|
| 60 | - public function getSubAdminsGroups(IUser $user): array; |
|
| 53 | + /** |
|
| 54 | + * get groups of a SubAdmin |
|
| 55 | + * @param IUser $user the SubAdmin |
|
| 56 | + * @return IGroup[] |
|
| 57 | + * |
|
| 58 | + * @since 16.0.0 |
|
| 59 | + */ |
|
| 60 | + public function getSubAdminsGroups(IUser $user): array; |
|
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * get SubAdmins of a group |
|
| 64 | - * @param IGroup $group the group |
|
| 65 | - * @return IUser[] |
|
| 66 | - * |
|
| 67 | - * @since 16.0.0 |
|
| 68 | - */ |
|
| 69 | - public function getGroupsSubAdmins(IGroup $group): array; |
|
| 62 | + /** |
|
| 63 | + * get SubAdmins of a group |
|
| 64 | + * @param IGroup $group the group |
|
| 65 | + * @return IUser[] |
|
| 66 | + * |
|
| 67 | + * @since 16.0.0 |
|
| 68 | + */ |
|
| 69 | + public function getGroupsSubAdmins(IGroup $group): array; |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * checks if a user is a SubAdmin of a group |
|
| 73 | - * @param IUser $user |
|
| 74 | - * @param IGroup $group |
|
| 75 | - * @return bool |
|
| 76 | - * |
|
| 77 | - * @since 16.0.0 |
|
| 78 | - */ |
|
| 79 | - public function isSubAdminOfGroup(IUser $user, IGroup $group): bool; |
|
| 71 | + /** |
|
| 72 | + * checks if a user is a SubAdmin of a group |
|
| 73 | + * @param IUser $user |
|
| 74 | + * @param IGroup $group |
|
| 75 | + * @return bool |
|
| 76 | + * |
|
| 77 | + * @since 16.0.0 |
|
| 78 | + */ |
|
| 79 | + public function isSubAdminOfGroup(IUser $user, IGroup $group): bool; |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * checks if a user is a SubAdmin |
|
| 83 | - * @param IUser $user |
|
| 84 | - * @return bool |
|
| 85 | - * |
|
| 86 | - * @since 16.0.0 |
|
| 87 | - */ |
|
| 88 | - public function isSubAdmin(IUser $user): bool; |
|
| 81 | + /** |
|
| 82 | + * checks if a user is a SubAdmin |
|
| 83 | + * @param IUser $user |
|
| 84 | + * @return bool |
|
| 85 | + * |
|
| 86 | + * @since 16.0.0 |
|
| 87 | + */ |
|
| 88 | + public function isSubAdmin(IUser $user): bool; |
|
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * checks if a user is a accessible by a subadmin |
|
| 92 | - * @param IUser $subadmin |
|
| 93 | - * @param IUser $user |
|
| 94 | - * @return bool |
|
| 95 | - * |
|
| 96 | - * @since 16.0.0 |
|
| 97 | - */ |
|
| 98 | - public function isUserAccessible(IUser $subadmin, IUser $user): bool; |
|
| 90 | + /** |
|
| 91 | + * checks if a user is a accessible by a subadmin |
|
| 92 | + * @param IUser $subadmin |
|
| 93 | + * @param IUser $user |
|
| 94 | + * @return bool |
|
| 95 | + * |
|
| 96 | + * @since 16.0.0 |
|
| 97 | + */ |
|
| 98 | + public function isUserAccessible(IUser $subadmin, IUser $user): bool; |
|
| 99 | 99 | } |
@@ -32,22 +32,22 @@ |
||
| 32 | 32 | * @since 18.0.0 |
| 33 | 33 | */ |
| 34 | 34 | class BeforeGroupDeletedEvent extends Event { |
| 35 | - /** @var IGroup */ |
|
| 36 | - private $group; |
|
| 35 | + /** @var IGroup */ |
|
| 36 | + private $group; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @since 18.0.0 |
|
| 40 | - */ |
|
| 41 | - public function __construct(IGroup $group) { |
|
| 42 | - parent::__construct(); |
|
| 43 | - $this->group = $group; |
|
| 44 | - } |
|
| 38 | + /** |
|
| 39 | + * @since 18.0.0 |
|
| 40 | + */ |
|
| 41 | + public function __construct(IGroup $group) { |
|
| 42 | + parent::__construct(); |
|
| 43 | + $this->group = $group; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @return IGroup |
|
| 48 | - * @since 18.0.0 |
|
| 49 | - */ |
|
| 50 | - public function getGroup(): IGroup { |
|
| 51 | - return $this->group; |
|
| 52 | - } |
|
| 46 | + /** |
|
| 47 | + * @return IGroup |
|
| 48 | + * @since 18.0.0 |
|
| 49 | + */ |
|
| 50 | + public function getGroup(): IGroup { |
|
| 51 | + return $this->group; |
|
| 52 | + } |
|
| 53 | 53 | } |
@@ -32,22 +32,22 @@ |
||
| 32 | 32 | * @since 18.0.0 |
| 33 | 33 | */ |
| 34 | 34 | class GroupCreatedEvent extends Event { |
| 35 | - /** @var IGroup */ |
|
| 36 | - private $group; |
|
| 35 | + /** @var IGroup */ |
|
| 36 | + private $group; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @since 18.0.0 |
|
| 40 | - */ |
|
| 41 | - public function __construct(IGroup $group) { |
|
| 42 | - parent::__construct(); |
|
| 43 | - $this->group = $group; |
|
| 44 | - } |
|
| 38 | + /** |
|
| 39 | + * @since 18.0.0 |
|
| 40 | + */ |
|
| 41 | + public function __construct(IGroup $group) { |
|
| 42 | + parent::__construct(); |
|
| 43 | + $this->group = $group; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @return IGroup |
|
| 48 | - * @since 18.0.0 |
|
| 49 | - */ |
|
| 50 | - public function getGroup(): IGroup { |
|
| 51 | - return $this->group; |
|
| 52 | - } |
|
| 46 | + /** |
|
| 47 | + * @return IGroup |
|
| 48 | + * @since 18.0.0 |
|
| 49 | + */ |
|
| 50 | + public function getGroup(): IGroup { |
|
| 51 | + return $this->group; |
|
| 52 | + } |
|
| 53 | 53 | } |
@@ -32,22 +32,22 @@ |
||
| 32 | 32 | * @since 18.0.0 |
| 33 | 33 | */ |
| 34 | 34 | class GroupDeletedEvent extends Event { |
| 35 | - /** @var IGroup */ |
|
| 36 | - private $group; |
|
| 35 | + /** @var IGroup */ |
|
| 36 | + private $group; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @since 18.0.0 |
|
| 40 | - */ |
|
| 41 | - public function __construct(IGroup $group) { |
|
| 42 | - parent::__construct(); |
|
| 43 | - $this->group = $group; |
|
| 44 | - } |
|
| 38 | + /** |
|
| 39 | + * @since 18.0.0 |
|
| 40 | + */ |
|
| 41 | + public function __construct(IGroup $group) { |
|
| 42 | + parent::__construct(); |
|
| 43 | + $this->group = $group; |
|
| 44 | + } |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @return IGroup |
|
| 48 | - * @since 18.0.0 |
|
| 49 | - */ |
|
| 50 | - public function getGroup(): IGroup { |
|
| 51 | - return $this->group; |
|
| 52 | - } |
|
| 46 | + /** |
|
| 47 | + * @return IGroup |
|
| 48 | + * @since 18.0.0 |
|
| 49 | + */ |
|
| 50 | + public function getGroup(): IGroup { |
|
| 51 | + return $this->group; |
|
| 52 | + } |
|
| 53 | 53 | } |
@@ -31,22 +31,22 @@ |
||
| 31 | 31 | * @since 18.0.0 |
| 32 | 32 | */ |
| 33 | 33 | class BeforeGroupCreatedEvent extends Event { |
| 34 | - /** @var string */ |
|
| 35 | - private $name; |
|
| 34 | + /** @var string */ |
|
| 35 | + private $name; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @since 18.0.0 |
|
| 39 | - */ |
|
| 40 | - public function __construct(string $name) { |
|
| 41 | - parent::__construct(); |
|
| 42 | - $this->name = $name; |
|
| 43 | - } |
|
| 37 | + /** |
|
| 38 | + * @since 18.0.0 |
|
| 39 | + */ |
|
| 40 | + public function __construct(string $name) { |
|
| 41 | + parent::__construct(); |
|
| 42 | + $this->name = $name; |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @return string |
|
| 47 | - * @since 18.0.0 |
|
| 48 | - */ |
|
| 49 | - public function getName(): string { |
|
| 50 | - return $this->name; |
|
| 51 | - } |
|
| 45 | + /** |
|
| 46 | + * @return string |
|
| 47 | + * @since 18.0.0 |
|
| 48 | + */ |
|
| 49 | + public function getName(): string { |
|
| 50 | + return $this->name; |
|
| 51 | + } |
|
| 52 | 52 | } |
@@ -30,10 +30,10 @@ |
||
| 30 | 30 | * @since 17.0.0 |
| 31 | 31 | */ |
| 32 | 32 | interface IGetDisplayNameBackend { |
| 33 | - /** |
|
| 34 | - * @param string $gid |
|
| 35 | - * @return string |
|
| 36 | - * @since 17.0.0 |
|
| 37 | - */ |
|
| 38 | - public function getDisplayName(string $gid): string; |
|
| 33 | + /** |
|
| 34 | + * @param string $gid |
|
| 35 | + * @return string |
|
| 36 | + * @since 17.0.0 |
|
| 37 | + */ |
|
| 38 | + public function getDisplayName(string $gid): string; |
|
| 39 | 39 | } |