Horde_Dav_Principals
extends AbstractBackend
in package
Backend implementation for listing and managing principals (users and groups).
Tags
Table of Contents
- $_auth : Horde_Auth_Base
- Authentication backend.
- $_identities : object
- Identity factory.
- __construct() : mixed
- Constructor.
- getGroupMemberSet() : array<string|int, mixed>
- Returns the list of members for a group-principal
- getGroupMembership() : array<string|int, mixed>
- Returns the list of groups a principal is a member of
- getPrincipalByPath() : array<string|int, mixed>
- Returns a specific principal, specified by it's path.
- getPrincipalsByPrefix() : array<string|int, mixed>
- Returns a list of principals based on a prefix.
- searchPrincipals() : array<string|int, mixed>
- This method is used to search for principals matching a set of properties.
- setGroupMemberSet() : void
- Updates the list of group members for a group principal.
- updatePrincipal() : void
- Updates one ore more webdav properties on a principal.
- _getUserInfo() : array<string|int, mixed>
- Returns principal details.
Properties
$_auth
Authentication backend.
protected
Horde_Auth_Base
$_auth
$_identities
Identity factory.
protected
object
$_identities
Methods
__construct()
Constructor.
public
__construct(Horde_Auth_Base $auth, object $identities) : mixed
Parameters
- $auth : Horde_Auth_Base
-
Authentication backend.
- $identities : object
-
Identity factory.
Return values
mixed —getGroupMemberSet()
Returns the list of members for a group-principal
public
getGroupMemberSet(string $principal) : array<string|int, mixed>
Parameters
- $principal : string
Return values
array<string|int, mixed> —getGroupMembership()
Returns the list of groups a principal is a member of
public
getGroupMembership(string $principal) : array<string|int, mixed>
Parameters
- $principal : string
Return values
array<string|int, mixed> —getPrincipalByPath()
Returns a specific principal, specified by it's path.
public
getPrincipalByPath(string $path) : array<string|int, mixed>
Parameters
- $path : string
Return values
array<string|int, mixed> —getPrincipalsByPrefix()
Returns a list of principals based on a prefix.
public
getPrincipalsByPrefix(string $prefixPath) : array<string|int, mixed>
Parameters
- $prefixPath : string
Return values
array<string|int, mixed> —searchPrincipals()
This method is used to search for principals matching a set of properties.
public
searchPrincipals(string $prefixPath, array<string|int, mixed> $searchProperties[, string $test = 'allof' ]) : array<string|int, mixed>
Parameters
- $prefixPath : string
- $searchProperties : array<string|int, mixed>
- $test : string = 'allof'
Return values
array<string|int, mixed> —setGroupMemberSet()
Updates the list of group members for a group principal.
public
setGroupMemberSet(string $principal, array<string|int, mixed> $members) : void
The principals should be passed as a list of uri's.
Parameters
- $principal : string
- $members : array<string|int, mixed>
Return values
void —updatePrincipal()
Updates one ore more webdav properties on a principal.
public
updatePrincipal(string $path, PropPatch $propPatch) : void
Parameters
- $path : string
- $propPatch : PropPatch
Return values
void —_getUserInfo()
Returns principal details.
protected
_getUserInfo(string $user) : array<string|int, mixed>
Parameters
- $user : string
-
A user name.
Return values
array<string|int, mixed> —A hash with user information.