The SchedulingObject represents a scheduling object in the Inbox collection. More...

Inheritance diagram for Sabre\CalDAV\Schedule\SchedulingObject:

Collaboration diagram for Sabre\CalDAV\Schedule\SchedulingObject:

Public Member Functions
	__construct (Backend\SchedulingSupport $caldavBackend, array $objectData)
	Constructor. More...

	get ()
	Returns the ICalendar-formatted object. More...

	put ($calendarData)
	Updates the ICalendar-formatted object. More...

	delete ()
	Deletes the scheduling message. More...

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

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

Public Member Functions inherited from Sabre\CalDAV\CalendarObject
	__construct (Backend\BackendInterface $caldavBackend, array $calendarInfo, array $objectData)
	Constructor. More...

	getName ()
	Returns the uri for this object. More...

	get ()
	Returns the ICalendar-formatted object. More...

	put ($calendarData)
	Updates the ICalendar-formatted object. More...

	delete ()
	Deletes the calendar object. More...

	getContentType ()
	Returns the mime content-type. More...

	getETag ()
	Returns an ETag for this object. More...

	getLastModified ()
	Returns the last modification date as a unix timestamp. More...

	getSize ()
	Returns the size of this object in bytes. 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\File
	put ($data)
	Replaces the contents of the file. More...

	get ()
	Returns the data. More...

	getSize ()
	Returns the size of the file, in bytes. More...

	getETag ()
	Returns the ETag for a file. More...

	getContentType ()
	Returns the mime-type for a file. 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
	$caldavBackend

	$objectData

Protected Attributes inherited from Sabre\CalDAV\CalendarObject
	$caldavBackend

	$objectData

	$calendarInfo

Detailed Description

The SchedulingObject represents a scheduling object in the Inbox collection.

Author: Brett (https://github.com/bretten) http://sabre.io/license/ Modified BSD License

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

Definition at line 15 of file SchedulingObject.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\Schedule\SchedulingObject::__construct	(	Backend\SchedulingSupport	$caldavBackend,
		array	$objectData
	)

Constructor.

The following properties may be passed within $objectData:

uri - A unique uri. Only the 'basename' must be passed.
principaluri - the principal that owns the object.
calendardata (optional) - The iCalendar data
etag - (optional) The etag for this object, MUST be encloded with double-quotes.
size - (optional) The size of the data in bytes.
lastmodified - (optional) format as a unix timestamp.
acl - (optional) Use this to override the default ACL for the node.

Parameters

Backend\SchedulingSupport	$caldavBackend
array	$objectData

Definition at line 48 of file SchedulingObject.php.

References Sabre\CalDAV\Schedule\SchedulingObject\$caldavBackend, and Sabre\CalDAV\Schedule\SchedulingObject\$objectData.

                                                                                       {
 
         $this->caldavBackend = $caldavBackend;
 
         if (!isset($objectData['uri'])) {
             throw new \InvalidArgumentException('The objectData argument must contain an \'uri\' property');
         }
 
         $this->objectData = $objectData;
 
     }

Member Function Documentation

◆ delete()

Sabre\CalDAV\Schedule\SchedulingObject::delete ( )

Deletes the scheduling message.

Returns: void

Implements Sabre\DAV\INode.

Definition at line 93 of file SchedulingObject.php.

                       {
 
         $this->caldavBackend->deleteSchedulingObject($this->objectData['principaluri'], $this->objectData['uri']);
 
     }

◆ get()

Sabre\CalDAV\Schedule\SchedulingObject::get ( )

Returns the ICalendar-formatted object.

Returns: string

Implements Sabre\DAV\IFile.

Definition at line 65 of file SchedulingObject.php.

                    {
 
         // Pre-populating the 'calendardata' is optional, if we don't have it
         // already we fetch it from the backend.
         if (!isset($this->objectData['calendardata'])) {
             $this->objectData = $this->caldavBackend->getSchedulingObject($this->objectData['principaluri'], $this->objectData['uri']);
         }
         return $this->objectData['calendardata'];
 
     }

◆ getACL()

Sabre\CalDAV\Schedule\SchedulingObject::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 125 of file SchedulingObject.php.

                       {
 
         // An alternative acl may be specified in the object data.
         //
 
         if (isset($this->objectData['acl'])) {
             return $this->objectData['acl'];
         }
 
         // The default ACL
         return [
             [
                 'privilege' => '{DAV:}all',
                 'principal' => '{DAV:}owner',
                 'protected' => true,
             ],
             [
                 'privilege' => '{DAV:}all',
                 'principal' => $this->objectData['principaluri'] . '/calendar-proxy-write',
                 'protected' => true,
             ],
             [
                 'privilege' => '{DAV:}read',
                 'principal' => $this->objectData['principaluri'] . '/calendar-proxy-read',
                 'protected' => true,
             ],
         ];
 
     }

◆ getOwner()

Sabre\CalDAV\Schedule\SchedulingObject::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 106 of file SchedulingObject.php.

                         {
 
         return $this->objectData['principaluri'];
 
     }

◆ put()

Sabre\CalDAV\Schedule\SchedulingObject::put ( $calendarData )

Updates the ICalendar-formatted object.

Parameters

string | resource $calendarData

Returns: string

Implements Sabre\DAV\IFile.

Definition at line 82 of file SchedulingObject.php.

                                 {
 
         throw new MethodNotAllowed('Updating scheduling objects is not supported');
 
     }

Field Documentation

◆ $caldavBackend

Sabre\CalDAV\Schedule\SchedulingObject::$caldavBackend

protected

Definition at line 22 of file SchedulingObject.php.

Referenced by Sabre\CalDAV\Schedule\SchedulingObject\__construct().

◆ $objectData

Sabre\CalDAV\Schedule\SchedulingObject::$objectData