sabre/dav Documentation

The Sabre\CalDAV\Backend\PDO class is a CalDAV backend implementation that uses a PDO database (such as MySQL or SQLite) to store calendar data.

When initializing the backend, you can customize the database table names used for various components of the CalDAV system by setting the following public properties:

• $calendarTableName: Table for calendars.
• $calendarInstancesTableName: Table for calendar instances (e.g., when a calendar is shared).
• $calendarObjectTableName: Table for individual calendar objects (events, todos, etc.).
• $calendarChangesTableName: Table for tracking changes.
• $schedulingObjectTableName: Table for inbox/scheduling items.
• $calendarSubscriptionsTableName: Table for calendar subscriptions.

You can also extend the $propertyMap or $subscriptionPropertyMap to map additional CalDAV/iCalendar properties to specific database field names. Note that only string-based properties are supported via this mapping.

The Sabre\DAVACL\Plugin class can be customized via several public properties to change how permissions and principals are handled.

Key configuration options include:

• $principalCollectionSet: A list of URLs containing principal collections. Modify this if your principals are located elsewhere.
• $hideNodesFromListings: If set to true, nodes that are inaccessible by the user will be hidden from directory listings (e.g., PROPFIND on a parent with Depth: 1). Defaults to false.
• $adminPrincipals: A list of principal URIs that will automatically receive {DAV:}all privileges as protected privileges.
• $allowUnauthenticatedAccess: If true, the plugin modifies the auth plugin to only require login when a privileged operation is denied. Set to false to harden security.
• $principalSearchPropertySet: Defines which properties a client can search using the {DAV:}principal-property-search report. Keys are property names, values are descriptions.

The Server class provides several public properties and static settings to control its behavior:

• $debugExceptions (bool): If true, the XML error response will include detailed information like file, line, code, and stack trace. Defaults to false.
• $enablePropfindDepthInfinity (bool): If true, allows Depth: infinity on PROPFIND requests. This can be a DoS vector and is false by default.
• $resourceTypeMapping (array): Maps node classes/interfaces to DAV resource types (e.g., ICollection::class => '{DAV:}collection').
• $protectedProperties (array): A list of properties (e.g., {DAV:}getetag) that are server-controlled and cannot be modified via PROPPATCH.
• static $exposeVersion (bool): If false, the SabreDAV version number is hidden from headers and XML responses. Defaults to true.
• static $streamMultiStatus (bool): If true, PROPFIND multi-status responses are streamed to the output buffer to save memory. Defaults to false.

The PDO backend provides methods to manage CalDAV subscriptions for a principal.

Create a subscription

Use createSubscription($principalUri, $uri, array $properties) to create a new subscription. The $properties array must include the {http://calendarserver.org/ns/}source key, which contains the subscription source object.

Update a subscription

Use updateSubscription($subscriptionId, PropPatch $propPatch) to modify an existing subscription. You must pass a PropPatch object and call its handle() method, specifying the supported properties (including {http://calendarserver.org/ns/}source) to process the mutations.

Delete a subscription

Use deleteSubscription($subscriptionId) to remove a subscription.

public function createSubscription($principalUri, $uri, array $properties)
public function updateSubscription($subscriptionId, PropPatch $propPatch)
public function deleteSubscription($subscriptionId)