PHP Class Horde_Dav_Principals, horde

Author: Jan Schneider ([email protected])
Inheritance: extends Sabre\DAVACL\PrincipalBackend\AbstractBackend
Exibir arquivo Open project: horde/horde

Protected Properties

Property Type Description
$_auth Horde_Auth_Base Authentication backend.
$_identities object Identity factory.

Public Methods

Method Description
__construct ( Horde_Auth_Base $auth, object $identities ) Constructor.
getGroupMemberSet ( string $principal ) : array Returns the list of members for a group-principal
getGroupMembership ( string $principal ) : array Returns the list of groups a principal is a member of
getPrincipalByPath ( string $path ) : array Returns a specific principal, specified by it's path.
getPrincipalsByPrefix ( string $prefixPath ) : array Returns a list of principals based on a prefix.
searchPrincipals ( string $prefixPath, array $searchProperties, string $test = 'allof' ) : array This method is used to search for principals matching a set of properties.
setGroupMemberSet ( string $principal, array $members ) : void Updates the list of group members for a group principal.
updatePrincipal ( string $path, Sabre\DAV\PropPatch $propPatch ) : void Updates one ore more webdav properties on a principal.

Protected Methods

Method Description
_getUserInfo ( string $user ) : array Returns principal details.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Auth_Base $auth, object $identities )
$auth Horde_Auth_Base Authentication backend.
$identities object Identity factory.

_getUserInfo() protected method

Returns principal details.
protected _getUserInfo ( string $user ) : array
$user string A user name.
return array A hash with user information.

getGroupMemberSet() public method

Returns the list of members for a group-principal
public getGroupMemberSet ( string $principal ) : array
$principal string
return array

getGroupMembership() public method

Returns the list of groups a principal is a member of
public getGroupMembership ( string $principal ) : array
$principal string
return array

getPrincipalByPath() public method

Returns a specific principal, specified by it's path.
public getPrincipalByPath ( string $path ) : array
$path string
return array

getPrincipalsByPrefix() public method

Returns a list of principals based on a prefix.
public getPrincipalsByPrefix ( string $prefixPath ) : array
$prefixPath string
return array

searchPrincipals() public method

This method is used to search for principals matching a set of properties.
public searchPrincipals ( string $prefixPath, array $searchProperties, string $test = 'allof' ) : array
$prefixPath string
$searchProperties array
$test string
return array

setGroupMemberSet() public method

The principals should be passed as a list of uri's.
public setGroupMemberSet ( string $principal, array $members ) : void
$principal string
$members array
return void

updatePrincipal() public method

Updates one ore more webdav properties on a principal.
public updatePrincipal ( string $path, Sabre\DAV\PropPatch $propPatch ) : void
$path string
$propPatch Sabre\DAV\PropPatch
return void

Property Details

$_auth protected_oe property

Authentication backend.
protected Horde_Auth_Base $_auth
return Horde_Auth_Base

$_identities protected_oe property

Identity factory.
protected object $_identities
return object