\OCPUserInterface

TODO actually this is a IUserBackend

Summary

Methods
Constants
implementsActions()
deleteUser()
getUsers()
userExists()
getDisplayName()
getDisplayNames()
hasUserListings()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

implementsActions()

implementsActions(integer  $actions) : boolean

Check if backend implements actions

Parameters

integer $actions

bitwise-or'ed actions

Returns

boolean —

Returns the supported actions as int to be compared with \OC_User_Backend::CREATE_USER etc.

deleteUser()

deleteUser(string  $uid) : boolean

delete a user

Parameters

string $uid

The username of the user to delete

Returns

boolean

getUsers()

getUsers(string  $search = '', null|integer  $limit = null, null|integer  $offset = null) : array<mixed,string>

Get a list of all users

Parameters

string $search
null|integer $limit
null|integer $offset

Returns

array<mixed,string> —

an array of all uids

userExists()

userExists(string  $uid) : boolean

check if a user exists

Parameters

string $uid

the username

Returns

boolean

getDisplayName()

getDisplayName(string  $uid) : string

get display name of the user

Parameters

string $uid

user ID of the user

Returns

string —

display name

getDisplayNames()

getDisplayNames(string  $search = '', string|null  $limit = null, string|null  $offset = null) : array

Get a list of all display names and user ids.

Parameters

string $search
string|null $limit
string|null $offset

Returns

array —

an array of all displayNames (value) and the corresponding uids (key)

hasUserListings()

hasUserListings() : boolean

Check if a user list is available or not

Returns

boolean —

if users can be listed or not