Sabre\CalDAV\Subscriptions\Plugin Class Reference

This plugin adds calendar-subscription support to your CalDAV server. More...

Inheritance diagram for Sabre\CalDAV\Subscriptions\Plugin:

Collaboration diagram for Sabre\CalDAV\Subscriptions\Plugin:

Public Member Functions
	initialize (Server $server)
	This initializes the plugin. More...
	getFeatures ()
	This method should return a list of server-features. More...
	propFind (PropFind $propFind, INode $node)
	Triggered after properties have been fetched. More...
	getPluginName ()
	Returns a plugin name. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...
Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...
	getFeatures ()
	This method should return a list of server-features. More...
	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...
	getPluginName ()
	Returns a plugin name. More...
	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...
	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Detailed Description

This plugin adds calendar-subscription support to your CalDAV server.

Some clients support 'managed subscriptions' server-side. This is basically a list of subscription urls a user is using.

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

Member Function Documentation

getFeatures()

Sabre\CalDAV\Subscriptions\Plugin::getFeatures

(

)

This method should return a list of server-features.

This is for example 'versioning' and is added to the DAV: header in an OPTIONS response.

Returns

array

Definition at line 53 of file Plugin.php.

                           {

        return ['calendarserver-subscribed'];

    }

getPluginInfo()

Sabre\CalDAV\Subscriptions\Plugin::getPluginInfo

(

)

Returns a bunch of meta-data about the plugin.

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Returns

array

Definition at line 111 of file Plugin.php.

References Sabre\CalDAV\Plugin\getPluginName().

                             {

        return [
            'name'        => $this->getPluginName(),
            'description' => 'This plugin allows users to store iCalendar subscriptions in their calendar-home.',
            'link'        => null,
        ];

    }

Here is the call graph for this function:

getPluginName()

Sabre\CalDAV\Subscriptions\Plugin::getPluginName

(

)

Returns a plugin name.

Using this name other plugins will be able to access other plugins using ::getPlugin

Returns

string

Definition at line 94 of file Plugin.php.

                             {

        return 'subscriptions';

    }

initialize()

Sabre\CalDAV\Subscriptions\Plugin::initialize

(

Server

$server

)

This initializes the plugin.

This function is called by Sabre, after addPlugin is called.

This method should set up the required event subscriptions.

Parameters

Server

$server

Returns

void

Definition at line 33 of file Plugin.php.

References Sabre\Event\EventEmitterInterface\on().

                                        {

        $server->resourceTypeMapping['Sabre\\CalDAV\\Subscriptions\\ISubscription'] =
            '{http://calendarserver.org/ns/}subscribed';

        $server->xml->elementMap['{http://calendarserver.org/ns/}source'] =
            'Sabre\\DAV\\Xml\\Property\\Href';

        $server->on('propFind', [$this, 'propFind'], 150);

    }

Here is the call graph for this function:

propFind()

Sabre\CalDAV\Subscriptions\Plugin::propFind	(	PropFind	$propFind,
		INode	$node
	)

Triggered after properties have been fetched.

Parameters

PropFind	$propFind
INode	$node

Returns

void

Definition at line 66 of file Plugin.php.

References Sabre\DAV\PropFind\getStatus(), and Sabre\DAV\PropFind\set().

                                                       {

        // There's a bunch of properties that must appear as a self-closing
        // xml-element. This event handler ensures that this will be the case.
        $props = [
            '{http://calendarserver.org/ns/}subscribed-strip-alarms',
            '{http://calendarserver.org/ns/}subscribed-strip-attachments',
            '{http://calendarserver.org/ns/}subscribed-strip-todos',
        ];

        foreach ($props as $prop) {

            if ($propFind->getStatus($prop) === 200) {
                $propFind->set($prop, '', 200);
            }

        }

    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/sabre/dav/lib/CalDAV/Subscriptions/Plugin.php