upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-06-08 16:26:59 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Merge pull request #17214 from owncloud/fix-php-doc-user-interface

Browse source 
Fix PHPDoc + Indentation
This commit is contained in:
Lukas Reschke 2015-06-27 21:58:49 +02:00
commit 717f91a4e8
6 changed files with 67 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
apps/user_ldap/user_ldap.php
View file

@ -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;

13
apps/user_ldap/user_proxy.php
View file

@ -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

20
lib/private/user/backend.php
View file

@ -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();

14
lib/private/user/database.php
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.
*
* @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 = [];

8
lib/private/user/dummy.php
View file

@ -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)) {

50
lib/private/user/interface.php
View file

@ -28,35 +28,37 @@
interface OC_User_Interface {
/**
* Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
* Returns the supported actions as int to be
* compared with \OC_User_Backend::CREATE_USER etc.
*/
* Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
* Returns the supported actions as int to be
* compared with \OC_User_Backend::CREATE_USER etc.
*/
public function implementsActions($actions);
/**
* delete a user
* @param string $uid The username of the user to delete
* @return bool
*/
* delete a user
* @param string $uid The username of the user to delete
* @return bool
*/
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);
/**
* check if a user exists
* @param string $uid the username
* @return boolean
*/
* check if a user exists
* @param string $uid the username
* @return boolean
*/
public function userExists($uid);
/**
@ -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);