Add missing annotations for parameters

This commit is contained in:
Lukas Reschke 2015-06-27 20:35:47 +02:00
parent d1f0ff372e
commit af01958f3e
6 changed files with 52 additions and 35 deletions

View File

@ -120,9 +120,11 @@ class USER_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserIn
/** /**
* Get a list of all users * 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) { public function getUsers($search = '', $limit = 10, $offset = 0) {
$search = $this->access->escapeFilterPart($search, true); $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 * 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) { public function getDisplayNames($search = '', $limit = null, $offset = null) {
$cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset; $cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset;

View File

@ -132,9 +132,11 @@ class User_Proxy extends lib\Proxy implements \OCP\IUserBackend, \OCP\UserInterf
/** /**
* Get a list of all users * 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) { 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 //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. * 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) { 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 //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends

View File

@ -134,11 +134,13 @@ abstract class OC_User_Backend implements OC_User_Interface {
} }
/** /**
* Get a list of all users * Get a list of all users
* @return array an array of all uids *
* * @param string $search
* 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) { public function getUsers($search = '', $limit = null, $offset = null) {
return array(); 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. * 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) { public function getDisplayNames($search = '', $limit = null, $offset = null) {
$displayNames = array(); $displayNames = array();

View File

@ -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. * 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) { public function getDisplayNames($search = '', $limit = null, $offset = null) {
$parameters = []; $parameters = [];
@ -224,9 +226,11 @@ class OC_User_Database extends OC_User_Backend implements \OCP\IUserBackend {
/** /**
* Get a list of all users * 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) { public function getUsers($search = '', $limit = null, $offset = null) {
$parameters = []; $parameters = [];

View File

@ -108,11 +108,9 @@ class OC_User_Dummy extends OC_User_Backend implements \OCP\IUserBackend {
* Get a list of all users * Get a list of all users
* *
* @param string $search * @param string $search
* @param int $limit * @param null|int $limit
* @param int $offset * @param null|int $offset
* @return string[] with all uids * @return string[] an array of all uids
*
* Get a list of all users.
*/ */
public function getUsers($search = '', $limit = null, $offset = null) { public function getUsers($search = '', $limit = null, $offset = null) {
if (empty($search)) { if (empty($search)) {

View File

@ -45,11 +45,13 @@ interface OC_User_Interface {
public function deleteUser($uid); public function deleteUser($uid);
/** /**
* Get a list of all users * Get a list of all users
* @return array an array of all uids *
* * @param string $search
* 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); public function getUsers($search = '', $limit = null, $offset = null);
/** /**
@ -67,10 +69,12 @@ interface OC_User_Interface {
public function getDisplayName($uid); 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. * 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); public function getDisplayNames($search = '', $limit = null, $offset = null);