\Horde_Dav_Principals

Backend implementation for listing and managing principals (users and groups).

Summary

Methods
Properties
Constants
__construct()
getPrincipalsByPrefix()
getPrincipalByPath()
updatePrincipal()
searchPrincipals()
getGroupMemberSet()
getGroupMembership()
setGroupMemberSet()
No public properties found
No constants found
_getUserInfo()
$_auth
$_identities
N/A
No private methods found
No private properties found
N/A

Properties

$_auth

$_auth : \Horde_Auth_Base

Authentication backend.

Type

\Horde_Auth_Base

$_identities

$_identities : object

Identity factory.

Type

object

Methods

__construct()

__construct(\Horde_Auth_Base  $auth, object  $identities) 

Constructor.

Parameters

\Horde_Auth_Base $auth

Authentication backend.

object $identities

Identity factory.

getPrincipalsByPrefix()

getPrincipalsByPrefix(string  $prefixPath) : array

Returns a list of principals based on a prefix.

Parameters

string $prefixPath

Returns

array

getPrincipalByPath()

getPrincipalByPath(string  $path) : array

Returns a specific principal, specified by it's path.

Parameters

string $path

Returns

array

updatePrincipal()

updatePrincipal(string  $path, \Sabre\DAV\PropPatch  $propPatch) : void

Updates one ore more webdav properties on a principal.

Parameters

string $path
\Sabre\DAV\PropPatch $propPatch

searchPrincipals()

searchPrincipals(string  $prefixPath, array  $searchProperties, string  $test = 'allof') : array

This method is used to search for principals matching a set of properties.

Parameters

string $prefixPath
array $searchProperties
string $test

Returns

array

getGroupMemberSet()

getGroupMemberSet(string  $principal) : array

Returns the list of members for a group-principal

Parameters

string $principal

Returns

array

getGroupMembership()

getGroupMembership(string  $principal) : array

Returns the list of groups a principal is a member of

Parameters

string $principal

Returns

array

setGroupMemberSet()

setGroupMemberSet(string  $principal, array  $members) : void

Updates the list of group members for a group principal.

The principals should be passed as a list of uri's.

Parameters

string $principal
array $members

_getUserInfo()

_getUserInfo(string  $user) : array

Returns principal details.

Parameters

string $user

A user name.

Returns

array —

A hash with user information.