OpenXE/classes/Modules/CalDav/SabreDavBackend/WawisionPrincipalBackend.php

172 lines
4.8 KiB
PHP
Raw Normal View History

2021-05-21 08:49:41 +02:00
<?php
namespace Xentral\Modules\CalDav\SabreDavBackend;
use Sabre\DAV\Exception\NotImplemented;
use Sabre\DAV\PropPatch;
use Sabre\DAVACL\PrincipalBackend\AbstractBackend;
use Xentral\Components\Database\Database;
class WawisionPrincipalBackend extends AbstractBackend
{
/**
* @var Database
*/
private $db;
/**
* WawisionPrincipalBackend constructor.
*
* @param Database $db
*/
public function __construct(Database $db)
{
$this->db = $db;
}
/**
* 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 actually injected in a number of other properties. If
* you have an email address, use this property.
*
* @param string $prefixPath
*
* @return array
*/
function getPrincipalsByPrefix($prefixPath)
{
return [
[
'{DAV:}displayname' => 'Admin',
'uri' => 'principals/admin',
],
];
}
/**
* 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)
{
return [
'{DAV:}displayname' => 'Admin',
'uri' => 'principals/admin',
];
}
/**
* Updates one ore more webdav properties on a principal.
*
* The list of mutations is stored in a Sabre\DAV\PropPatch object.
* To do the actual updates, you must tell this object which properties
* you're going to process with the handle() method.
*
* Calling the handle method is like telling the PropPatch object "I
* promise I can handle updating this property".
*
* Read the PropPatch documentation for more info and examples.
*
* @param string $path
* @param PropPatch $propPatch
*
* @return void
* @throws NotImplemented
*/
function updatePrincipal($path, PropPatch $propPatch)
{
throw new NotImplemented('updatePrincipal not implemented');
}
/**
* This method is used to search for principals matching a set of
* properties.
*
* This search is specifically used by RFC3744's principal-property-search
* REPORT.
*
* The actual search should be a unicode-non-case-sensitive search. The
* keys in searchProperties are the WebDAV property names, while the values
* are the property values to search on.
*
* By default, if multiple properties are submitted to this method, the
* various properties should be combined with 'AND'. If $test is set to
* 'anyof', it should be combined using 'OR'.
*
* This method should simply return an array with full principal uri's.
*
* If somebody attempted to search on a property the backend does not
* support, you should simply return 0 results.
*
* You can also just return 0 results if you choose to not support
* searching at all, but keep in mind that this may stop certain features
* from working.
*
* @param string $prefixPath
* @param array $searchProperties
* @param string $test
*
* @return array
* @throws NotImplemented
*/
function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof')
{
throw new NotImplemented('searchPrincipals not implemented');
}
/**
* Returns the list of members for a group-principal
*
* @param string $principal
*
* @return array
*/
function getGroupMemberSet($principal)
{
return [];
}
/**
* Returns the list of groups a principal is a member of
*
* @param string $principal
*
* @return array
*/
function getGroupMembership($principal)
{
// throw new NotImplemented('getGroupMembership not implemented');
return [];
}
/**
* 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
* @throws NotImplemented
*/
function setGroupMemberSet($principal, array $members)
{
throw new NotImplemented('setGroupMembership not implemented');
}
}