74 lines
2.2 KiB
PHP
74 lines
2.2 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implement this interface to create your own principal backends.
|
||
|
|
*
|
||
|
|
* Creating backends for principals is entirely optional. You can also
|
||
|
|
* implement Sabre_DAVACL_IPrincipal directly. This interface is used solely by
|
||
|
|
* Sabre_DAVACL_AbstractPrincipalCollection.
|
||
|
|
*
|
||
|
|
* @package Sabre
|
||
|
|
* @subpackage DAVACL
|
||
|
|
* @copyright Copyright (C) 2007-2011 Rooftop Solutions. All rights reserved.
|
||
|
|
* @author Evert Pot (http://www.rooftopsolutions.nl/)
|
||
|
|
* @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
|
||
|
|
*/
|
||
|
|
interface Sabre_DAVACL_IPrincipalBackend {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a list of principals based on a prefix.
|
||
|
|
*
|
||
|
|
* This prefix will often contain something like 'principals'. You are only
|
||
|
|
* expected to return principals that are in this base path.
|
||
|
|
*
|
||
|
|
* You are expected to return at least a 'uri' for every user, you can
|
||
|
|
* return any additional properties if you wish so. Common properties are:
|
||
|
|
* {DAV:}displayname
|
||
|
|
* {http://sabredav.org/ns}email-address - This is a custom SabreDAV
|
||
|
|
* field that's actualy injected in a number of other properties. If
|
||
|
|
* you have an email address, use this property.
|
||
|
|
*
|
||
|
|
* @param string $prefixPath
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getPrincipalsByPrefix($prefixPath);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a specific principal, specified by it's path.
|
||
|
|
* The returned structure should be the exact same as from
|
||
|
|
* getPrincipalsByPrefix.
|
||
|
|
*
|
||
|
|
* @param string $path
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getPrincipalByPath($path);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the list of members for a group-principal
|
||
|
|
*
|
||
|
|
* @param string $principal
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getGroupMemberSet($principal);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the list of groups a principal is a member of
|
||
|
|
*
|
||
|
|
* @param string $principal
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
function getGroupMembership($principal);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Updates the list of group members for a group principal.
|
||
|
|
*
|
||
|
|
* The principals should be passed as a list of uri's.
|
||
|
|
*
|
||
|
|
* @param string $principal
|
||
|
|
* @param array $members
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
function setGroupMemberSet($principal, array $members);
|
||
|
|
|
||
|
|
}
|