The CalendarObject represents a single VEVENT or VTODO within a Calendar. More...

Inheritance diagram for Sabre\CalDAV\CalendarObject:

Collaboration diagram for Sabre\CalDAV\CalendarObject:

Public Member Functions
	__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...

	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...

	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...

	put ($data)
	Replaces the contents of the file. More...

	get ()
	Returns the data. More...

	getContentType ()
	Returns the mime-type for a file. More...

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

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

Public Member Functions inherited from Sabre\DAVACL\IACL
	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...

Protected Attributes
	$caldavBackend

	$objectData

	$calendarInfo

Detailed Description

The CalendarObject represents a single VEVENT or VTODO within a Calendar.

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 12 of file CalendarObject.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\CalendarObject::__construct	(	Backend\BackendInterface	$caldavBackend,
		array	$calendarInfo,
		array	$objectData
	)

Constructor.

The following properties may be passed within $objectData:

calendarid - This must refer to a calendarid from a caldavBackend
uri - A unique uri. Only the 'basename' must be passed.
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\BackendInterface	$caldavBackend
array	$calendarInfo
array	$objectData

Definition at line 55 of file CalendarObject.php.

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

References Sabre\CalDAV\CalendarObject\$caldavBackend, Sabre\CalDAV\CalendarObject\$calendarInfo, and Sabre\CalDAV\CalendarObject\$objectData.

Member Function Documentation

◆ delete()

Sabre\CalDAV\CalendarObject::delete ( )

Deletes the calendar object.

Returns: void

Implements Sabre\DAV\INode.

Reimplemented in Sabre\CalDAV\Schedule\SchedulingObject.

Definition at line 119 of file CalendarObject.php.

                      {
 
        $this->caldavBackend->deleteCalendarObject($this->calendarInfo['id'], $this->objectData['uri']);
 
    }

◆ get()

Sabre\CalDAV\CalendarObject::get ( )

Returns the ICalendar-formatted object.

Returns: string

Reimplemented from Sabre\DAV\File.

Reimplemented in Sabre\CalDAV\Schedule\SchedulingObject.

Definition at line 84 of file CalendarObject.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->getCalendarObject($this->calendarInfo['id'], $this->objectData['uri']);
        }
        return $this->objectData['calendardata'];
 
    }

◆ getACL()

Sabre\CalDAV\CalendarObject::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.

Reimplemented in Sabre\CalDAV\Schedule\SchedulingObject.

Definition at line 208 of file CalendarObject.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' => $this->calendarInfo['principaluri'],
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}all',
                'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-write',
                'protected' => true,
            ],
            [
                'privilege' => '{DAV:}read',
                'principal' => $this->calendarInfo['principaluri'] . '/calendar-proxy-read',
                'protected' => true,
            ],
 
        ];
 
    }

◆ getContentType()

Sabre\CalDAV\CalendarObject::getContentType ( )

Returns the mime content-type.

Returns: string

Reimplemented from Sabre\DAV\File.

Definition at line 130 of file CalendarObject.php.

                              {
 
        $mime = 'text/calendar; charset=utf-8';
        if (isset($this->objectData['component']) && $this->objectData['component']) {
            $mime .= '; component=' . $this->objectData['component'];
        }
        return $mime;
 
    }

◆ getETag()

Sabre\CalDAV\CalendarObject::getETag ( )

Returns an ETag for this object.

The ETag is an arbitrary string, but MUST be surrounded by double-quotes.

Returns: string

Reimplemented from Sabre\DAV\File.

Definition at line 147 of file CalendarObject.php.

                       {
 
        if (isset($this->objectData['etag'])) {
            return $this->objectData['etag'];
        } else {
            return '"' . md5($this->get()) . '"';
        }
 
    }

◆ getLastModified()

Sabre\CalDAV\CalendarObject::getLastModified ( )

Returns the last modification date as a unix timestamp.

Returns: int

Implements Sabre\DAV\INode.

Definition at line 162 of file CalendarObject.php.

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

◆ getName()

Sabre\CalDAV\CalendarObject::getName ( )

Returns the uri for this object.

Returns: string

Implements Sabre\DAV\INode.

Definition at line 73 of file CalendarObject.php.

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

◆ getOwner()

Sabre\CalDAV\CalendarObject::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.

Reimplemented in Sabre\CalDAV\Schedule\SchedulingObject.

Definition at line 190 of file CalendarObject.php.

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

◆ getSize()

Sabre\CalDAV\CalendarObject::getSize ( )

Returns the size of this object in bytes.

Returns: int

Reimplemented from Sabre\DAV\File.

Definition at line 173 of file CalendarObject.php.

                       {
 
        if (array_key_exists('size', $this->objectData)) {
            return $this->objectData['size'];
        } else {
            return strlen($this->get());
        }
 
    }

◆ put()

Sabre\CalDAV\CalendarObject::put ( $calendarData )

Updates the ICalendar-formatted object.

Parameters

string | resource $calendarData

Returns: string

Reimplemented from Sabre\DAV\File.

Reimplemented in Sabre\CalDAV\Schedule\SchedulingObject.

Definition at line 101 of file CalendarObject.php.

                                {
 
        if (is_resource($calendarData)) {
            $calendarData = stream_get_contents($calendarData);
        }
        $etag = $this->caldavBackend->updateCalendarObject($this->calendarInfo['id'], $this->objectData['uri'], $calendarData);
        $this->objectData['calendardata'] = $calendarData;
        $this->objectData['etag'] = $etag;
 
        return $etag;
 
    }

Field Documentation

◆ $caldavBackend

Sabre\CalDAV\CalendarObject::$caldavBackend

protected

Definition at line 21 of file CalendarObject.php.

Referenced by Sabre\CalDAV\CalendarObject\__construct().

◆ $calendarInfo

Sabre\CalDAV\CalendarObject::$calendarInfo

protected

Definition at line 35 of file CalendarObject.php.

Referenced by Sabre\CalDAV\CalendarObject\__construct().

◆ $objectData

Sabre\CalDAV\CalendarObject::$objectData

protected

Definition at line 28 of file CalendarObject.php.

Referenced by Sabre\CalDAV\CalendarObject\__construct().

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

libs/composer/vendor/sabre/dav/lib/CalDAV/CalendarObject.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ get()

◆ getACL()

◆ getContentType()

◆ getETag()

◆ getLastModified()

◆ getName()

◆ getOwner()

◆ getSize()

◆ put()

Field Documentation

◆ $caldavBackend

◆ $calendarInfo

◆ $objectData