Inheritance diagram for Sabre\CalDAV\Backend\SimplePDO:

Collaboration diagram for Sabre\CalDAV\Backend\SimplePDO:

Public Member Functions
	__construct (\PDO $pdo)
	Creates the backend. More...

	getCalendarsForUser ($principalUri)
	Returns a list of calendars for a principal. More...

	createCalendar ($principalUri, $calendarUri, array $properties)
	Creates a new calendar for a principal. More...

	deleteCalendar ($calendarId)
	Delete a calendar and all it's objects. More...

	getCalendarObjects ($calendarId)
	Returns all calendar objects within a calendar. More...

	getCalendarObject ($calendarId, $objectUri)
	Returns information from a single calendar object, based on it's object uri. More...

	createCalendarObject ($calendarId, $objectUri, $calendarData)
	Creates a new calendar object. More...

	updateCalendarObject ($calendarId, $objectUri, $calendarData)
	Updates an existing calendarobject, based on it's uri. More...

	deleteCalendarObject ($calendarId, $objectUri)
	Deletes an existing calendar object. More...

Public Member Functions inherited from Sabre\CalDAV\Backend\AbstractBackend
	updateCalendar ($calendarId, \Sabre\DAV\PropPatch $propPatch)
	Updates properties for a calendar. More...

	getMultipleCalendarObjects ($calendarId, array $uris)
	Returns a list of calendar objects. More...

	calendarQuery ($calendarId, array $filters)
	Performs a calendar-query on the contents of this calendar. More...

	getCalendarObjectByUID ($principalUri, $uid)
	Searches through all of a users calendars and calendar objects to find an object with a specific UID. More...

	getCalendarsForUser ($principalUri)
	Returns a list of calendars for a principal. More...

	createCalendar ($principalUri, $calendarUri, array $properties)
	Creates a new calendar for a principal. More...

	updateCalendar ($calendarId, \Sabre\DAV\PropPatch $propPatch)
	Updates properties for a calendar. More...

	deleteCalendar ($calendarId)
	Delete a calendar and all its objects. More...

	getCalendarObjects ($calendarId)
	Returns all calendar objects within a calendar. More...

	getCalendarObject ($calendarId, $objectUri)
	Returns information from a single calendar object, based on it's object uri. More...

	getMultipleCalendarObjects ($calendarId, array $uris)
	Returns a list of calendar objects. More...

	createCalendarObject ($calendarId, $objectUri, $calendarData)
	Creates a new calendar object. More...

	updateCalendarObject ($calendarId, $objectUri, $calendarData)
	Updates an existing calendarobject, based on it's uri. More...

	deleteCalendarObject ($calendarId, $objectUri)
	Deletes an existing calendar object. More...

	calendarQuery ($calendarId, array $filters)
	Performs a calendar-query on the contents of this calendar. More...

	getCalendarObjectByUID ($principalUri, $uid)
	Searches through all of a users calendars and calendar objects to find an object with a specific UID. More...

Protected Attributes
	$pdo

Additional Inherited Members
Protected Member Functions inherited from Sabre\CalDAV\Backend\AbstractBackend
	validateFilterForObject (array $object, array $filters)
	This method validates if a filter (as passed to calendarQuery) matches the given object. More...

Detailed Description

Simple PDO CalDAV backend.

This class is basically the most minimum example to get a caldav backend up and running. This class uses the following schema (MySQL example):

CREATE TABLE simple_calendars ( id INT UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT, uri VARBINARY(200) NOT NULL, principaluri VARBINARY(200) NOT NULL );

CREATE TABLE simple_calendarobjects ( id INT UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT, calendarid INT UNSIGNED NOT NULL, uri VARBINARY(200) NOT NULL, calendardata MEDIUMBLOB )

To make this class work, you absolutely need to have the PropertyStorage plugin enabled.

Copyright: Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).

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

Definition at line 34 of file SimplePDO.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\CalDAV\Backend\SimplePDO::__construct ( \PDO $pdo )

Creates the backend.

Parameters

\PDO $pdo

Definition at line 48 of file SimplePDO.php.

                                    {
 
        $this->pdo = $pdo;
 
    }

References Sabre\CalDAV\Backend\SimplePDO\$pdo.

Member Function Documentation

◆ createCalendar()

Sabre\CalDAV\Backend\SimplePDO::createCalendar	(		$principalUri,
			$calendarUri,
		array	$properties
	)

Creates a new calendar for a principal.

If the creation was a success, an id must be returned that can be used to reference this calendar in other methods, such as updateCalendar.

Parameters

string	$principalUri
string	$calendarUri
array	$properties

Returns: string

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 110 of file SimplePDO.php.

                                                                            {
 
        $stmt = $this->pdo->prepare("INSERT INTO simple_calendars (principaluri, uri) VALUES (?, ?)");
        $stmt->execute([$principalUri, $calendarUri]);
 
        return $this->pdo->lastInsertId();
 
    }

References $stmt.

◆ createCalendarObject()

Sabre\CalDAV\Backend\SimplePDO::createCalendarObject	(	$calendarId,
		$objectUri,
		$calendarData
	)

Creates a new calendar object.

The object uri is only the basename, or filename and not a full path.

It is possible return an etag from this function, which will be used in the response to this PUT request. Note that the ETag must be surrounded by double-quotes.

However, you should only really return this ETag if you don't mangle the calendar-data. If the result of a subsequent GET to this object is not the exact same as this request body, you should omit the ETag.

Parameters

mixed	$calendarId
string	$objectUri
string	$calendarData

Returns: string|null

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 240 of file SimplePDO.php.

                                                                          {
 
        $stmt = $this->pdo->prepare('INSERT INTO simple_calendarobjects (calendarid, uri, calendardata) VALUES (?,?,?)');
        $stmt->execute([
            $calendarId,
            $objectUri,
            $calendarData
        ]);
 
        return '"' . md5($calendarData) . '"';
 
    }

References $stmt.

◆ deleteCalendar()

Sabre\CalDAV\Backend\SimplePDO::deleteCalendar ( $calendarId )

Delete a calendar and all it's objects.

Parameters

string $calendarId

Returns: void

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 125 of file SimplePDO.php.

                                         {
 
        $stmt = $this->pdo->prepare('DELETE FROM simple_calendarobjects WHERE calendarid = ?');
        $stmt->execute([$calendarId]);
 
        $stmt = $this->pdo->prepare('DELETE FROM simple_calendars WHERE id = ?');
        $stmt->execute([$calendarId]);
 
    }

References $stmt.

◆ deleteCalendarObject()

Sabre\CalDAV\Backend\SimplePDO::deleteCalendarObject	(	$calendarId,
		$objectUri
	)

Deletes an existing calendar object.

The object uri is only the basename, or filename and not a full path.

Parameters

string	$calendarId
string	$objectUri

Returns: void

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 289 of file SimplePDO.php.

                                                           {
 
        $stmt = $this->pdo->prepare('DELETE FROM simple_calendarobjects WHERE calendarid = ? AND uri = ?');
        $stmt->execute([$calendarId, $objectUri]);
 
    }

References $stmt.

◆ getCalendarObject()

Sabre\CalDAV\Backend\SimplePDO::getCalendarObject	(	$calendarId,
		$objectUri
	)

Returns information from a single calendar object, based on it's object uri.

The object uri is only the basename, or filename and not a full path.

The returned array must have the same keys as getCalendarObjects. The 'calendardata' object is required here though, while it's not required for getCalendarObjects.

This method must return null if the object did not exist.

Parameters

string	$calendarId
string	$objectUri

Returns: array|null

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 203 of file SimplePDO.php.

                                                        {
 
        $stmt = $this->pdo->prepare('SELECT id, uri, calendardata FROM simple_calendarobjects WHERE calendarid = ? AND uri = ?');
        $stmt->execute([$calendarId, $objectUri]);
        $row = $stmt->fetch(\PDO::FETCH_ASSOC);
 
        if (!$row) return null;
 
        return [
            'id'           => $row['id'],
            'uri'          => $row['uri'],
            'etag'         => '"' . md5($row['calendardata']) . '"',
            'calendarid'   => $calendarId,
            'size'         => strlen($row['calendardata']),
            'calendardata' => $row['calendardata'],
         ];
 
    }

References $row, and $stmt.

◆ getCalendarObjects()

Sabre\CalDAV\Backend\SimplePDO::getCalendarObjects ( $calendarId )

Returns all calendar objects within a calendar.

Every item contains an array with the following keys:

calendardata - The iCalendar-compatible calendar data
uri - a unique key which will be used to construct the uri. This can be any arbitrary string, but making sure it ends with '.ics' is a good idea. This is only the basename, or filename, not the full path.
lastmodified - a timestamp of the last modification time
etag - An arbitrary string, surrounded by double-quotes. (e.g.: ' "abcdef"')
size - The size of the calendar objects, in bytes.
component - optional, a string containing the type of object, such as 'vevent' or 'vtodo'. If specified, this will be used to populate the Content-Type header.

Note that the etag is optional, but it's highly encouraged to return for speed reasons.

The calendardata is also optional. If it's not returned 'getCalendarObject' will be called later, which is expected to return calendardata.

If neither etag or size are specified, the calendardata will be used/fetched to determine these numbers. If both are specified the amount of times this is needed is reduced by a great degree.

Parameters

string $calendarId

Returns: array

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 166 of file SimplePDO.php.

                                             {
 
        $stmt = $this->pdo->prepare('SELECT id, uri, calendardata FROM simple_calendarobjects WHERE calendarid = ?');
        $stmt->execute([$calendarId]);
 
        $result = [];
        foreach ($stmt->fetchAll(\PDO::FETCH_ASSOC) as $row) {
            $result[] = [
                'id'           => $row['id'],
                'uri'          => $row['uri'],
                'etag'         => '"' . md5($row['calendardata']) . '"',
                'calendarid'   => $calendarId,
                'size'         => strlen($row['calendardata']),
                'calendardata' => $row['calendardata'],
            ];
        }
 
        return $result;
 
    }

References $result, $row, and $stmt.

◆ getCalendarsForUser()

Sabre\CalDAV\Backend\SimplePDO::getCalendarsForUser ( $principalUri )

Returns a list of calendars for a principal.

Every project is an array with the following keys:

id, a unique id that will be used by other functions to modify the calendar. This can be the same as the uri or a database key.
uri. This is just the 'base uri' or 'filename' of the calendar.
principaluri. The owner of the calendar. Almost always the same as principalUri passed to this method.

Furthermore it can contain webdav properties in clark notation. A very common one is '{DAV:}displayname'.

Many clients also require: {urn:ietf:params:xml:ns:caldav}supported-calendar-component-set For this property, you can just return an instance of Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet.

If you return {http://sabredav.org/ns}read-only and set the value to 1, ACL will automatically be put in read-only mode.

Parameters

string $principalUri

Returns: array

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 78 of file SimplePDO.php.

                                                {
 
        // Making fields a comma-delimited list
        $stmt = $this->pdo->prepare("SELECT id, uri FROM simple_calendars WHERE principaluri = ? ORDER BY id ASC");
        $stmt->execute([$principalUri]);
 
        $calendars = [];
        while ($row = $stmt->fetch(\PDO::FETCH_ASSOC)) {
 
            $calendars[] = [
                'id'           => $row['id'],
                'uri'          => $row['uri'],
                'principaluri' => $principalUri,
            ];
 
        }
 
        return $calendars;
 
    }

References $row, and $stmt.

◆ updateCalendarObject()

Sabre\CalDAV\Backend\SimplePDO::updateCalendarObject	(	$calendarId,
		$objectUri,
		$calendarData
	)

Updates an existing calendarobject, based on it's uri.

The object uri is only the basename, or filename and not a full path.

It is possible return an etag from this function, which will be used in the response to this PUT request. Note that the ETag must be surrounded by double-quotes.

However, you should only really return this ETag if you don't mangle the calendar-data. If the result of a subsequent GET to this object is not the exact same as this request body, you should omit the ETag.

Parameters

mixed	$calendarId
string	$objectUri
string	$calendarData

Returns: string|null

Implements Sabre\CalDAV\Backend\BackendInterface.

Definition at line 271 of file SimplePDO.php.

                                                                          {
 
        $stmt = $this->pdo->prepare('UPDATE simple_calendarobjects SET calendardata = ? WHERE calendarid = ? AND uri = ?');
        $stmt->execute([$calendarData, $calendarId, $objectUri]);
 
        return '"' . md5($calendarData) . '"';
 
    }

References $stmt.

Field Documentation

◆ $pdo

Sabre\CalDAV\Backend\SimplePDO::$pdo

protected

Definition at line 41 of file SimplePDO.php.

Referenced by Sabre\CalDAV\Backend\SimplePDO\__construct().

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

libs/composer/vendor/sabre/dav/lib/CalDAV/Backend/SimplePDO.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createCalendar()

◆ createCalendarObject()

◆ deleteCalendar()

◆ deleteCalendarObject()

◆ getCalendarObject()

◆ getCalendarObjects()

◆ getCalendarsForUser()

◆ updateCalendarObject()

Field Documentation

◆ $pdo