fix: doc blocks added

Signed-off-by: yemkareems <yemkareems@gmail.com>

diff --git a/lib/private/AllConfig.php b/lib/private/AllConfig.php
index 7fbc4c1e1489797ed373e47cad3bea3bb05603b0..a096fed61dbd767c100df94094e2cb81166efcfc 100644 (file)
--- 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 3c2fd5b5098af1ca6e0d7669a5ec5d4deacd6173..57dadfea194ad08e63c356306e7b03a1029ac4e9 100644 (file)
--- 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 39f9ecff94ce986f74e94e7ef6d92c7016e19df6..093c0ecbd378fa24a4fae66742befdb195a8fdb9 100644 (file)
--- 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 83422c51dfc9c14d3a864f8967ca3ee880862f87..e614619eec8a3fb84cfaf2d817e1decca7da212c 100644 (file)
--- 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