From 5b249df6866c3434740d08827eeabcf2cb6eb2e9 Mon Sep 17 00:00:00 2001 From: yemkareems Date: Wed, 26 Jun 2024 14:04:57 +0530 Subject: [PATCH] fix: doc blocks added Signed-off-by: yemkareems --- lib/private/AllConfig.php | 8 ++++++++ lib/private/User/Manager.php | 3 +++ lib/public/IConfig.php | 8 ++++++++ lib/public/IUserManager.php | 3 +++ 4 files changed, 22 insertions(+) diff --git a/lib/private/AllConfig.php b/lib/private/AllConfig.php index 7fbc4c1e148..a096fed61db 100644 --- a/lib/private/AllConfig.php +++ b/lib/private/AllConfig.php @@ -491,6 +491,14 @@ class AllConfig implements IConfig { return $userIDs; } + /** + * Gets the list of users based on their lastLogin info asc or desc + * + * @param string $search search users based on search params + * @param string $sortMode can be lastLogin or any key in preferences + * @param string $sortOrder asc or desc + * @return array of user IDs + */ public function getLastLoggedInUsers($search, $sortMode, $sortOrder): array { // TODO - FIXME $this->fixDIInit(); diff --git a/lib/private/User/Manager.php b/lib/private/User/Manager.php index 3c2fd5b5098..57dadfea194 100644 --- a/lib/private/User/Manager.php +++ b/lib/private/User/Manager.php @@ -342,6 +342,9 @@ class Manager extends PublicEmitter implements IUserManager { return array_slice($users, $offset, $limit); } + /** + * @return IUser[] + */ public function getUsersSortedByLastLogin(?int $limit = null, int $offset = 0, $search = '', $sortMode = 'lastLogin', $sortOrder = 'desc'): array { $users = $this->config->getLastLoggedInUsers($search, $sortMode, $sortOrder); $users = array_combine( diff --git a/lib/public/IConfig.php b/lib/public/IConfig.php index 39f9ecff94c..093c0ecbd37 100644 --- a/lib/public/IConfig.php +++ b/lib/public/IConfig.php @@ -250,5 +250,13 @@ interface IConfig { */ public function getUsersForUserValue($appName, $key, $value); + /** + * Gets the list of users based on their lastLogin info asc or desc + * + * @param string $search search users based on search params + * @param string $sortMode can be lastLogin or any key in preferences + * @param string $sortOrder asc or desc + * @return array of user IDs + */ public function getLastLoggedInUsers($search, $sortMode, $sortOrder); } diff --git a/lib/public/IUserManager.php b/lib/public/IUserManager.php index 83422c51dfc..e614619eec8 100644 --- a/lib/public/IUserManager.php +++ b/lib/public/IUserManager.php @@ -124,6 +124,9 @@ interface IUserManager { */ public function getDisabledUsers(?int $limit = null, int $offset = 0, string $search = ''): array; + /** + * @return IUser[] + */ public function getUsersSortedByLastLogin(?int $limit = null, int $offset = 0, $search = '', $sortMode = 'lastLogin', $sortOrder = 'desc'): array; /** * Search known users (from phonebook sync) by displayName