@@ -40,69 +40,69 @@ |
||
40 | 40 | */ |
41 | 41 | interface UserInterface { |
42 | 42 | |
43 | - /** |
|
44 | - * Check if backend implements actions |
|
45 | - * @param int $actions bitwise-or'ed actions |
|
46 | - * @return boolean |
|
47 | - * |
|
48 | - * Returns the supported actions as int to be |
|
49 | - * compared with \OC\User\Backend::CREATE_USER etc. |
|
50 | - * @since 4.5.0 |
|
51 | - * @deprecated 14.0.0 Switch to the interfaces from OCP\User\Backend |
|
52 | - */ |
|
53 | - public function implementsActions($actions); |
|
43 | + /** |
|
44 | + * Check if backend implements actions |
|
45 | + * @param int $actions bitwise-or'ed actions |
|
46 | + * @return boolean |
|
47 | + * |
|
48 | + * Returns the supported actions as int to be |
|
49 | + * compared with \OC\User\Backend::CREATE_USER etc. |
|
50 | + * @since 4.5.0 |
|
51 | + * @deprecated 14.0.0 Switch to the interfaces from OCP\User\Backend |
|
52 | + */ |
|
53 | + public function implementsActions($actions); |
|
54 | 54 | |
55 | - /** |
|
56 | - * delete a user |
|
57 | - * @param string $uid The username of the user to delete |
|
58 | - * @return bool |
|
59 | - * @since 4.5.0 |
|
60 | - */ |
|
61 | - public function deleteUser($uid); |
|
55 | + /** |
|
56 | + * delete a user |
|
57 | + * @param string $uid The username of the user to delete |
|
58 | + * @return bool |
|
59 | + * @since 4.5.0 |
|
60 | + */ |
|
61 | + public function deleteUser($uid); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Get a list of all users |
|
65 | - * |
|
66 | - * @param string $search |
|
67 | - * @param null|int $limit |
|
68 | - * @param null|int $offset |
|
69 | - * @return string[] an array of all uids |
|
70 | - * @since 4.5.0 |
|
71 | - */ |
|
72 | - public function getUsers($search = '', $limit = null, $offset = null); |
|
63 | + /** |
|
64 | + * Get a list of all users |
|
65 | + * |
|
66 | + * @param string $search |
|
67 | + * @param null|int $limit |
|
68 | + * @param null|int $offset |
|
69 | + * @return string[] an array of all uids |
|
70 | + * @since 4.5.0 |
|
71 | + */ |
|
72 | + public function getUsers($search = '', $limit = null, $offset = null); |
|
73 | 73 | |
74 | - /** |
|
75 | - * check if a user exists |
|
76 | - * @param string $uid the username |
|
77 | - * @return boolean |
|
78 | - * @since 4.5.0 |
|
79 | - */ |
|
80 | - public function userExists($uid); |
|
74 | + /** |
|
75 | + * check if a user exists |
|
76 | + * @param string $uid the username |
|
77 | + * @return boolean |
|
78 | + * @since 4.5.0 |
|
79 | + */ |
|
80 | + public function userExists($uid); |
|
81 | 81 | |
82 | - /** |
|
83 | - * get display name of the user |
|
84 | - * @param string $uid user ID of the user |
|
85 | - * @return string display name |
|
86 | - * @since 4.5.0 |
|
87 | - */ |
|
88 | - public function getDisplayName($uid); |
|
82 | + /** |
|
83 | + * get display name of the user |
|
84 | + * @param string $uid user ID of the user |
|
85 | + * @return string display name |
|
86 | + * @since 4.5.0 |
|
87 | + */ |
|
88 | + public function getDisplayName($uid); |
|
89 | 89 | |
90 | - /** |
|
91 | - * Get a list of all display names and user ids. |
|
92 | - * |
|
93 | - * @param string $search |
|
94 | - * @param string|null $limit |
|
95 | - * @param string|null $offset |
|
96 | - * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
97 | - * @since 4.5.0 |
|
98 | - */ |
|
99 | - public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
90 | + /** |
|
91 | + * Get a list of all display names and user ids. |
|
92 | + * |
|
93 | + * @param string $search |
|
94 | + * @param string|null $limit |
|
95 | + * @param string|null $offset |
|
96 | + * @return array an array of all displayNames (value) and the corresponding uids (key) |
|
97 | + * @since 4.5.0 |
|
98 | + */ |
|
99 | + public function getDisplayNames($search = '', $limit = null, $offset = null); |
|
100 | 100 | |
101 | - /** |
|
102 | - * Check if a user list is available or not |
|
103 | - * @return boolean if users can be listed or not |
|
104 | - * @since 4.5.0 |
|
105 | - */ |
|
106 | - public function hasUserListings(); |
|
101 | + /** |
|
102 | + * Check if a user list is available or not |
|
103 | + * @return boolean if users can be listed or not |
|
104 | + * @since 4.5.0 |
|
105 | + */ |
|
106 | + public function hasUserListings(); |
|
107 | 107 | |
108 | 108 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISetPasswordBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid The username |
|
36 | - * @param string $password The new password |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function setPassword(string $uid, string $password): bool; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid The username |
|
36 | + * @param string $password The new password |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function setPassword(string $uid, string $password): bool; |
|
40 | 40 | } |
@@ -28,12 +28,12 @@ |
||
28 | 28 | * @since 14.0.0 |
29 | 29 | */ |
30 | 30 | interface ICheckPasswordBackend { |
31 | - /** |
|
32 | - * @since 14.0.0 |
|
33 | - * |
|
34 | - * @param string $uid The username |
|
35 | - * @param string $password The password |
|
36 | - * @return string|bool The uid on success false on failure |
|
37 | - */ |
|
38 | - public function checkPassword(string $loginName, string $password); |
|
31 | + /** |
|
32 | + * @since 14.0.0 |
|
33 | + * |
|
34 | + * @param string $uid The username |
|
35 | + * @param string $password The password |
|
36 | + * @return string|bool The uid on success false on failure |
|
37 | + */ |
|
38 | + public function checkPassword(string $loginName, string $password); |
|
39 | 39 | } |
@@ -33,40 +33,40 @@ |
||
33 | 33 | */ |
34 | 34 | abstract class ABackend implements IUserBackend, UserInterface { |
35 | 35 | |
36 | - /** |
|
37 | - * @deprecated 14.0.0 |
|
38 | - * |
|
39 | - * @param int $actions The action to check for |
|
40 | - * @return bool |
|
41 | - */ |
|
42 | - public function implementsActions($actions): bool { |
|
43 | - $implements = 0; |
|
36 | + /** |
|
37 | + * @deprecated 14.0.0 |
|
38 | + * |
|
39 | + * @param int $actions The action to check for |
|
40 | + * @return bool |
|
41 | + */ |
|
42 | + public function implementsActions($actions): bool { |
|
43 | + $implements = 0; |
|
44 | 44 | |
45 | - if ($this instanceof ICreateUserBackend) { |
|
46 | - $implements |= Backend::CREATE_USER; |
|
47 | - } |
|
48 | - if ($this instanceof ISetPasswordBackend) { |
|
49 | - $implements |= Backend::SET_PASSWORD; |
|
50 | - } |
|
51 | - if ($this instanceof ICheckPasswordBackend) { |
|
52 | - $implements |= Backend::CHECK_PASSWORD; |
|
53 | - } |
|
54 | - if ($this instanceof IGetHomeBackend) { |
|
55 | - $implements |= Backend::GET_HOME; |
|
56 | - } |
|
57 | - if ($this instanceof IGetDisplayNameBackend) { |
|
58 | - $implements |= Backend::GET_DISPLAYNAME; |
|
59 | - } |
|
60 | - if ($this instanceof ISetDisplayNameBackend) { |
|
61 | - $implements |= Backend::SET_DISPLAYNAME; |
|
62 | - } |
|
63 | - if ($this instanceof IProvideAvatarBackend) { |
|
64 | - $implements |= Backend::PROVIDE_AVATAR; |
|
65 | - } |
|
66 | - if ($this instanceof ICountUsersBackend) { |
|
67 | - $implements |= Backend::COUNT_USERS; |
|
68 | - } |
|
45 | + if ($this instanceof ICreateUserBackend) { |
|
46 | + $implements |= Backend::CREATE_USER; |
|
47 | + } |
|
48 | + if ($this instanceof ISetPasswordBackend) { |
|
49 | + $implements |= Backend::SET_PASSWORD; |
|
50 | + } |
|
51 | + if ($this instanceof ICheckPasswordBackend) { |
|
52 | + $implements |= Backend::CHECK_PASSWORD; |
|
53 | + } |
|
54 | + if ($this instanceof IGetHomeBackend) { |
|
55 | + $implements |= Backend::GET_HOME; |
|
56 | + } |
|
57 | + if ($this instanceof IGetDisplayNameBackend) { |
|
58 | + $implements |= Backend::GET_DISPLAYNAME; |
|
59 | + } |
|
60 | + if ($this instanceof ISetDisplayNameBackend) { |
|
61 | + $implements |= Backend::SET_DISPLAYNAME; |
|
62 | + } |
|
63 | + if ($this instanceof IProvideAvatarBackend) { |
|
64 | + $implements |= Backend::PROVIDE_AVATAR; |
|
65 | + } |
|
66 | + if ($this instanceof ICountUsersBackend) { |
|
67 | + $implements |= Backend::COUNT_USERS; |
|
68 | + } |
|
69 | 69 | |
70 | - return (bool)($actions & $implements); |
|
71 | - } |
|
70 | + return (bool)($actions & $implements); |
|
71 | + } |
|
72 | 72 | } |
@@ -29,10 +29,10 @@ |
||
29 | 29 | */ |
30 | 30 | interface ICountUsersBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @return int|bool The number of users on success false on failure |
|
36 | - */ |
|
37 | - public function countUsers(); |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @return int|bool The number of users on success false on failure |
|
36 | + */ |
|
37 | + public function countUsers(); |
|
38 | 38 | } |
@@ -29,11 +29,11 @@ |
||
29 | 29 | */ |
30 | 30 | interface IGetHomeBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid the username |
|
36 | - * @return string|bool Datadir on success false on failure |
|
37 | - */ |
|
38 | - public function getHome(string $uid); |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid the username |
|
36 | + * @return string|bool Datadir on success false on failure |
|
37 | + */ |
|
38 | + public function getHome(string $uid); |
|
39 | 39 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | */ |
30 | 30 | interface ISetDisplayNameBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid The username |
|
36 | - * @param string $displayName The new display name |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function setDisplayName(string $uid, string $displayName): bool; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid The username |
|
36 | + * @param string $displayName The new display name |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function setDisplayName(string $uid, string $displayName): bool; |
|
40 | 40 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | */ |
30 | 30 | interface ICreateUserBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid The username of the user to create |
|
36 | - * @param string $password The password of the new user |
|
37 | - * @return bool |
|
38 | - */ |
|
39 | - public function createUser(string $uid, string $password): bool; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid The username of the user to create |
|
36 | + * @param string $password The password of the new user |
|
37 | + * @return bool |
|
38 | + */ |
|
39 | + public function createUser(string $uid, string $password): bool; |
|
40 | 40 | } |
@@ -29,11 +29,11 @@ |
||
29 | 29 | */ |
30 | 30 | interface IGetDisplayNameBackend { |
31 | 31 | |
32 | - /** |
|
33 | - * @since 14.0.0 |
|
34 | - * |
|
35 | - * @param string $uid user ID of the user |
|
36 | - * @return string display name |
|
37 | - */ |
|
38 | - public function getDisplayName($uid): string; |
|
32 | + /** |
|
33 | + * @since 14.0.0 |
|
34 | + * |
|
35 | + * @param string $uid user ID of the user |
|
36 | + * @return string display name |
|
37 | + */ |
|
38 | + public function getDisplayName($uid): string; |
|
39 | 39 | } |