The CalDAV scheduling outbox. More...

Inheritance diagram for Sabre\CalDAV\Schedule\Outbox:

Collaboration diagram for Sabre\CalDAV\Schedule\Outbox:

Public Member Functions
	__construct ($principalUri)
	Constructor. More...

	getName ()
	Returns the name of the node. More...

	getChildren ()
	Returns an array with all the child nodes. More...

	getOwner ()
	Returns the owner principal. More...

	getACL ()
	Returns a list of ACE's for this node. More...

Public Member Functions inherited from Sabre\DAV\Collection
	getChild ($name)
	Returns a child object, by its name. More...

	childExists ($name)
	Checks is a child-node exists. More...

	createFile ($name, $data=null)
	Creates a new file in the directory. More...

	createDirectory ($name)
	Creates a new subdirectory. More...

Public Member Functions inherited from Sabre\DAV\Node
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...

	delete ()
	Deletes the current node. More...

	setName ($name)
	Renames the node. More...

Public Member Functions inherited from Sabre\DAVACL\IACL
	getGroup ()
	Returns a group principal. More...

	setACL (array $acl)
	Updates the ACL. More...

	getSupportedPrivilegeSet ()
	Returns the list of supported privileges for this node. More...

Protected Attributes
	$principalUri

Detailed Description

The CalDAV scheduling outbox.

The outbox is mainly used as an endpoint in the tree for a client to do free-busy requests. This functionality is completely handled by the Scheduling plugin, so this object is actually mostly static.

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

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

Definition at line 20 of file Outbox.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\Schedule\Outbox::__construct ( $principalUri )

Constructor.

Parameters

string $principalUri

Definition at line 36 of file Outbox.php.

References Sabre\CalDAV\Schedule\Outbox\$principalUri.

                                         {
 
         $this->principalUri = $principalUri;
 
     }

Member Function Documentation

◆ getACL()

Sabre\CalDAV\Schedule\Outbox::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

Implements Sabre\DAVACL\IACL.

Definition at line 91 of file Outbox.php.

References Sabre\CalDAV\Schedule\Outbox\getOwner(), and Sabre\CalDAV\Plugin\NS_CALDAV.

                       {
 
         return [
             [
                 'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-send',
                 'principal' => $this->getOwner(),
                 'protected' => true,
             ],
             [
                 'privilege' => '{DAV:}read',
                 'principal' => $this->getOwner(),
                 'protected' => true,
             ],
             [
                 'privilege' => '{' . CalDAV\Plugin::NS_CALDAV . '}schedule-send',
                 'principal' => $this->getOwner() . '/calendar-proxy-write',
                 'protected' => true,
             ],
             [
                 'privilege' => '{DAV:}read',
                 'principal' => $this->getOwner() . '/calendar-proxy-read',
                 'protected' => true,
             ],
             [
                 'privilege' => '{DAV:}read',
                 'principal' => $this->getOwner() . '/calendar-proxy-write',
                 'protected' => true,
             ],
         ];
 
     }

Here is the call graph for this function:

◆ getChildren()

Sabre\CalDAV\Schedule\Outbox::getChildren ( )

Returns an array with all the child nodes.

Returns: []

Implements Sabre\DAV\ICollection.

Definition at line 60 of file Outbox.php.

◆ getName()

Sabre\CalDAV\Schedule\Outbox::getName ( )

Returns the name of the node.

This is used to generate the url.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 49 of file Outbox.php.

                        {
 
         return 'outbox';
 
     }

◆ getOwner()

Sabre\CalDAV\Schedule\Outbox::getOwner ( )

Returns the owner principal.

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

Returns: string|null

Implements Sabre\DAVACL\IACL.

Definition at line 73 of file Outbox.php.

References Sabre\CalDAV\Schedule\Outbox\$principalUri.

Referenced by Sabre\CalDAV\Schedule\Outbox\getACL().

                         {
 
         return $this->principalUri;
 
     }

Here is the caller graph for this function:

Field Documentation

◆ $principalUri

Sabre\CalDAV\Schedule\Outbox::$principalUri

protected

Definition at line 29 of file Outbox.php.

Referenced by Sabre\CalDAV\Schedule\Outbox\__construct(), and Sabre\CalDAV\Schedule\Outbox\getOwner().

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

libs/composer/vendor/sabre/dav/lib/CalDAV/Schedule/Outbox.php

Public Member Functions

Protected Attributes