[Pkg-owncloud-commits] [owncloud] 154/205: Add missing annotations for parameters
David Prévot
taffit at moszumanska.debian.org
Thu Jul 2 17:37:08 UTC 2015
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch stable8
in repository owncloud.
commit af01958f3e3c36d850f056b4598b85336878ee2f
Author: Lukas Reschke <lukas at owncloud.com>
Date: Sat Jun 27 20:35:47 2015 +0200
Add missing annotations for parameters
---
apps/user_ldap/user_ldap.php | 12 ++++++++----
apps/user_ldap/user_proxy.php | 13 ++++++++-----
lib/private/user/backend.php | 20 ++++++++++++--------
lib/private/user/database.php | 14 +++++++++-----
lib/private/user/dummy.php | 8 +++-----
lib/private/user/interface.php | 20 ++++++++++++--------
6 files changed, 52 insertions(+), 35 deletions(-)
diff --git a/apps/user_ldap/user_ldap.php b/apps/user_ldap/user_ldap.php
index 014d60c..caff30a 100644
--- a/apps/user_ldap/user_ldap.php
+++ b/apps/user_ldap/user_ldap.php
@@ -120,9 +120,11 @@ class USER_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserIn
/**
* Get a list of all users
- * @return string[] with 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 = 10, $offset = 0) {
$search = $this->access->escapeFilterPart($search, true);
@@ -328,9 +330,11 @@ class USER_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserIn
/**
* Get a list of all display names
- * @return array with 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) {
$cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset;
diff --git a/apps/user_ldap/user_proxy.php b/apps/user_ldap/user_proxy.php
index 53d453e..683529e 100644
--- a/apps/user_ldap/user_proxy.php
+++ b/apps/user_ldap/user_proxy.php
@@ -132,9 +132,11 @@ class User_Proxy extends lib\Proxy implements \OCP\IUserBackend, \OCP\UserInterf
/**
* Get a list of all users
- * @return string[] with 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 = 10, $offset = 0) {
//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
@@ -208,10 +210,11 @@ class User_Proxy extends lib\Proxy implements \OCP\IUserBackend, \OCP\UserInterf
}
/**
- * Get a list of all display names
- * @return array with 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) {
//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
diff --git a/lib/private/user/backend.php b/lib/private/user/backend.php
index 0775bc0..10bf3e2 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 0de062b..3cf73f9 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 8555274..3779f7b 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 abaca9b..caf328a 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);
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git
More information about the Pkg-owncloud-commits
mailing list