From af01958f3e3c36d850f056b4598b85336878ee2f Mon Sep 17 00:00:00 2001 From: Lukas Reschke Date: Sat, 27 Jun 2015 20:35:47 +0200 Subject: Add missing annotations for parameters --- lib/private/user/backend.php | 20 ++++++++++++-------- lib/private/user/database.php | 14 +++++++++----- lib/private/user/dummy.php | 8 +++----- lib/private/user/interface.php | 20 ++++++++++++-------- 4 files changed, 36 insertions(+), 26 deletions(-) (limited to 'lib/private/user') diff --git a/lib/private/user/backend.php b/lib/private/user/backend.php index 0775bc05588..10bf3e28085 100644 --- a/lib/private/user/backend.php +++ b/lib/private/user/backend.php @@ -134,11 +134,13 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * Get a list of all users - * @return array an array of all uids - * - * Get a list of all users. - */ + * Get a list of all users + * + * @param string $search + * @param null|int $limit + * @param null|int $offset + * @return string[] an array of all uids + */ public function getUsers($search = '', $limit = null, $offset = null) { return array(); } @@ -171,10 +173,12 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * Get a list of all display names - * @return array an array of all displayNames (value) and the corresponding uids (key) - * * Get a list of all display names and user ids. + * + * @param string $search + * @param string|null $limit + * @param string|null $offset + * @return array an array of all displayNames (value) and the corresponding uids (key) */ public function getDisplayNames($search = '', $limit = null, $offset = null) { $displayNames = array(); diff --git a/lib/private/user/database.php b/lib/private/user/database.php index 0de062ba2ce..3cf73f939e5 100644 --- a/lib/private/user/database.php +++ b/lib/private/user/database.php @@ -143,10 +143,12 @@ class OC_User_Database extends OC_User_Backend implements \OCP\IUserBackend { } /** - * Get a list of all display names - * @return array an array of all displayNames (value) and the correspondig uids (key) - * * Get a list of all display names and user ids. + * + * @param string $search + * @param string|null $limit + * @param string|null $offset + * @return array an array of all displayNames (value) and the corresponding uids (key) */ public function getDisplayNames($search = '', $limit = null, $offset = null) { $parameters = []; @@ -224,9 +226,11 @@ class OC_User_Database extends OC_User_Backend implements \OCP\IUserBackend { /** * Get a list of all users - * @return array an array of all uids * - * Get a list of all users. + * @param string $search + * @param null|int $limit + * @param null|int $offset + * @return string[] an array of all uids */ public function getUsers($search = '', $limit = null, $offset = null) { $parameters = []; diff --git a/lib/private/user/dummy.php b/lib/private/user/dummy.php index 85552740fac..3779f7b5ddf 100644 --- a/lib/private/user/dummy.php +++ b/lib/private/user/dummy.php @@ -108,11 +108,9 @@ class OC_User_Dummy extends OC_User_Backend implements \OCP\IUserBackend { * Get a list of all users * * @param string $search - * @param int $limit - * @param int $offset - * @return string[] with all uids - * - * Get a list of all users. + * @param null|int $limit + * @param null|int $offset + * @return string[] an array of all uids */ public function getUsers($search = '', $limit = null, $offset = null) { if (empty($search)) { diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php index abaca9bad7c..caf328a9fc8 100644 --- a/lib/private/user/interface.php +++ b/lib/private/user/interface.php @@ -45,11 +45,13 @@ interface OC_User_Interface { public function deleteUser($uid); /** - * Get a list of all users - * @return array an array of all uids - * - * Get a list of all users. - */ + * Get a list of all users + * + * @param string $search + * @param null|int $limit + * @param null|int $offset + * @return string[] an array of all uids + */ public function getUsers($search = '', $limit = null, $offset = null); /** @@ -67,10 +69,12 @@ interface OC_User_Interface { public function getDisplayName($uid); /** - * Get a list of all display names - * @return array an array of all displayNames (value) and the corresponding uids (key) - * * Get a list of all display names and user ids. + * + * @param string $search + * @param string|null $limit + * @param string|null $offset + * @return array an array of all displayNames (value) and the corresponding uids (key) */ public function getDisplayNames($search = '', $limit = null, $offset = null); -- cgit v1.2.3