75 lines
1.8 KiB
PHP
75 lines
1.8 KiB
PHP
<?php
|
|
|
|
namespace Sabre\DAVACL;
|
|
use Sabre\DAV;
|
|
|
|
/**
|
|
* ACL-enabled node
|
|
*
|
|
* If you want to add WebDAV ACL to a node, you must implement this class
|
|
*
|
|
* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
|
|
* @author Evert Pot (http://evertpot.com/)
|
|
* @license http://sabre.io/license/ Modified BSD License
|
|
*/
|
|
interface IACL extends DAV\INode {
|
|
|
|
/**
|
|
* Returns the owner principal
|
|
*
|
|
* This must be a url to a principal, or null if there's no owner
|
|
*
|
|
* @return string|null
|
|
*/
|
|
function getOwner();
|
|
|
|
/**
|
|
* Returns a group principal
|
|
*
|
|
* This must be a url to a principal, or null if there's no owner
|
|
*
|
|
* @return string|null
|
|
*/
|
|
function getGroup();
|
|
|
|
/**
|
|
* Returns a list of ACE's for this node.
|
|
*
|
|
* Each ACE has the following properties:
|
|
* * 'privilege', a string such as {DAV:}read or {DAV:}write. These are
|
|
* currently the only supported privileges
|
|
* * 'principal', a url to the principal who owns the node
|
|
* * 'protected' (optional), indicating that this ACE is not allowed to
|
|
* be updated.
|
|
*
|
|
* @return array
|
|
*/
|
|
function getACL();
|
|
|
|
/**
|
|
* Updates the ACL
|
|
*
|
|
* This method will receive a list of new ACE's as an array argument.
|
|
*
|
|
* @param array $acl
|
|
* @return void
|
|
*/
|
|
function setACL(array $acl);
|
|
|
|
/**
|
|
* Returns the list of supported privileges for this node.
|
|
*
|
|
* The returned data structure is a list of nested privileges.
|
|
* See Sabre\DAVACL\Plugin::getDefaultSupportedPrivilegeSet for a simple
|
|
* standard structure.
|
|
*
|
|
* If null is returned from this method, the default privilege set is used,
|
|
* which is fine for most common usecases.
|
|
*
|
|
* @return array|null
|
|
*/
|
|
function getSupportedPrivilegeSet();
|
|
|
|
|
|
}
|