Sabre\DAVACL\IACL Interface Reference

ACL-enabled node. More...

Inheritance diagram for Sabre\DAVACL\IACL:

Collaboration diagram for Sabre\DAVACL\IACL:

Public Member Functions
	getOwner ()
	Returns the owner principal. More...
	getGroup ()
	Returns a group principal. More...
	getACL ()
	Returns a list of ACE's for this node. More...
	setACL (array $acl)
	Updates the ACL. More...
	getSupportedPrivilegeSet ()
	Returns the list of supported privileges for this node. More...
Public Member Functions inherited from Sabre\DAV\INode
	delete ()
	Deleted the current node. More...
	getName ()
	Returns the name of the node. More...
	setName ($name)
	Renames the node. More...
	getLastModified ()
	Returns the last modification time, as a unix timestamp. More...

Detailed Description

ACL-enabled node.

If you want to add WebDAV ACL to a node, you must implement this class

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 16 of file IACL.php.

Member Function Documentation

getACL()

Sabre\DAVACL\IACL::getACL

(

)

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.

Returns

array

Implemented in Sabre\CalDAV\Calendar, Sabre\CalDAV\CalendarHome, Sabre\CalDAV\CalendarObject, Sabre\CalDAV\Principal\User, Sabre\CalDAV\Schedule\Inbox, Sabre\CalDAV\Schedule\Outbox, Sabre\CalDAV\Schedule\SchedulingObject, Sabre\CalDAV\SharedCalendar, Sabre\CalDAV\Subscriptions\Subscription, Sabre\CardDAV\Card, Sabre\DAVACL\FS\Collection, Sabre\DAVACL\FS\File, Sabre\DAVACL\FS\HomeCollection, Sabre\DAVACL\PrincipalCollection, and Sabre\DAVACL\MockACLNode.

getGroup()

Sabre\DAVACL\IACL::getGroup

(

)

Returns a group principal.

This must be a url to a principal, or null if there's no owner

Returns

string|null

Implemented in Sabre\DAVACL\MockACLNode.

getOwner()

Sabre\DAVACL\IACL::getOwner

(

)

Returns the owner principal.

This must be a url to a principal, or null if there's no owner

Returns

string|null

Implemented in Sabre\CalDAV\Calendar, Sabre\CalDAV\CalendarHome, Sabre\CalDAV\CalendarObject, Sabre\CalDAV\Notifications\Collection, Sabre\CalDAV\Notifications\Node, Sabre\CalDAV\Schedule\Inbox, Sabre\CalDAV\Schedule\Outbox, Sabre\CalDAV\Schedule\SchedulingObject, Sabre\CalDAV\Subscriptions\Subscription, Sabre\CardDAV\AddressBook, Sabre\CardDAV\AddressBookHome, Sabre\CardDAV\Card, Sabre\DAVACL\FS\Collection, Sabre\DAVACL\FS\File, Sabre\DAVACL\Principal, and Sabre\DAVACL\MockACLNode.

Referenced by Sabre\CalDAV\Schedule\Plugin\handleFreeBusyRequest().

Here is the caller graph for this function:

getSupportedPrivilegeSet()

Sabre\DAVACL\IACL::getSupportedPrivilegeSet

(

)

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.

Returns

array|null

Implemented in Sabre\DAVACL\MockACLNode.

setACL()

Sabre\DAVACL\IACL::setACL

(

array

$acl

)

Updates the ACL.

This method will receive a list of new ACE's as an array argument.

Parameters

array

$acl

Returns

void

Implemented in Sabre\DAVACL\MockACLNode.

---

The documentation for this interface was generated from the following file:

• libs/composer/vendor/sabre/dav/lib/DAVACL/IACL.php