Inheritance diagram for Sabre\CalDAV\Notifications\Plugin:

Collaboration diagram for Sabre\CalDAV\Notifications\Plugin:

Public Member Functions
	getPluginName ()
	Returns a plugin name. More...

	initialize (Server $server)
	This initializes the plugin. More...

	propFind (PropFind $propFind, BaseINode $node)
	PropFind. More...

	httpGet (RequestInterface $request, ResponseInterface $response)
	This event is triggered before the usual GET request handler. 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...

Data Fields
const	NS_CALENDARSERVER = 'http://calendarserver.org/ns/'
	This is the namespace for the proprietary calendarserver extensions. More...

Protected Attributes
	$server

Detailed Description

Notifications plugin.

This plugin implements several features required by the caldav-notification draft specification.

Before version 2.1.0 this functionality was part of Sabre but this has since been split up.

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

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

Definition at line 27 of file Plugin.php.

Member Function Documentation

◆ getPluginInfo()

Sabre\CalDAV\Notifications\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 170 of file Plugin.php.

References Sabre\CalDAV\Notifications\Plugin\getPluginName().

                              {
 
         return [
             'name'        => $this->getPluginName(),
             'description' => 'Adds support for caldav-notifications, which is required to enable caldav-sharing.',
             'link'        => 'http://sabre.io/dav/caldav-sharing/',
         ];
 
     }

Here is the call graph for this function:

◆ getPluginName()

Sabre\CalDAV\Notifications\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 49 of file Plugin.php.

Referenced by Sabre\CalDAV\Notifications\Plugin\getPluginInfo().

                              {
 
         return 'notifications';
 
     }

Here is the caller graph for this function:

◆ httpGet()

Sabre\CalDAV\Notifications\Plugin::httpGet	(	RequestInterface	$request,
		ResponseInterface	$response
	)

This event is triggered before the usual GET request handler.

We use this to intercept GET calls to notification nodes, and return the proper response.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: void

Definition at line 128 of file Plugin.php.

References $path, Sabre\HTTP\RequestInterface\getPath(), Sabre\HTTP\MessageInterface\setBody(), Sabre\HTTP\MessageInterface\setHeader(), and Sabre\HTTP\ResponseInterface\setStatus().

                                                                              {
 
         $path = $request->getPath();
 
         try {
             $node = $this->server->tree->getNodeForPath($path);
         } catch (DAV\Exception\NotFound $e) {
             return;
         }
 
         if (!$node instanceof INode)
             return;
 
         $writer = $this->server->xml->getWriter();
         $writer->contextUri = $this->server->getBaseUri();
         $writer->openMemory();
         $writer->startDocument('1.0', 'UTF-8');
         $writer->startElement('{http://calendarserver.org/ns/}notification');
         $node->getNotificationType()->xmlSerializeFull($writer);
         $writer->endElement();
 
         $response->setHeader('Content-Type', 'application/xml');
         $response->setHeader('ETag', $node->getETag());
         $response->setStatus(200);
         $response->setBody($writer->outputMemory());
 
         // Return false to break the event chain.
         return false;
 
     }

Here is the call graph for this function:

◆ initialize()

Sabre\CalDAV\Notifications\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 66 of file Plugin.php.

References Sabre\CalDAV\Notifications\Plugin\$server, and Sabre\Event\EventEmitterInterface\on().

                                         {
 
         $this->server = $server;
         $server->on('method:GET', [$this, 'httpGet'], 90);
         $server->on('propFind',   [$this, 'propFind']);
 
         $server->xml->namespaceMap[self::NS_CALENDARSERVER] = 'cs';
         $server->resourceTypeMapping['\\Sabre\\CalDAV\\Notifications\\ICollection'] = '{' . self::NS_CALENDARSERVER . '}notification';
 
         array_push($server->protectedProperties,
             '{' . self::NS_CALENDARSERVER . '}notification-URL',
             '{' . self::NS_CALENDARSERVER . '}notificationtype'
         );
 
     }

Here is the call graph for this function:

◆ propFind()

Sabre\CalDAV\Notifications\Plugin::propFind	(	PropFind	$propFind,
		BaseINode	$node
	)

PropFind.

Parameters

PropFind	$propFind
BaseINode	$node

Returns: void

Definition at line 89 of file Plugin.php.

References $caldavPlugin, and Sabre\DAV\PropFind\handle().

                                                            {
 
         $caldavPlugin = $this->server->getPlugin('caldav');
 
         if ($node instanceof DAVACL\IPrincipal) {
 
             $principalUrl = $node->getPrincipalUrl();
 
             // notification-URL property
             $propFind->handle('{' . self::NS_CALENDARSERVER . '}notification-URL', function() use ($principalUrl, $caldavPlugin) {
 
                 $notificationPath = $caldavPlugin->getCalendarHomeForPrincipal($principalUrl) . '/notifications/';
                 return new DAV\Xml\Property\Href($notificationPath);
 
             });
 
         }
 
         if ($node instanceof INode) {
 
             $propFind->handle(
                 '{' . self::NS_CALENDARSERVER . '}notificationtype',
                 [$node, 'getNotificationType']
             );
 
         }
 
     }

Here is the call graph for this function:

Field Documentation

◆ $server

Sabre\CalDAV\Notifications\Plugin::$server

protected

Definition at line 39 of file Plugin.php.

Referenced by Sabre\CalDAV\Notifications\Plugin\initialize().

◆ NS_CALENDARSERVER

const Sabre\CalDAV\Notifications\Plugin::NS_CALENDARSERVER = 'http://calendarserver.org/ns/'

This is the namespace for the proprietary calendarserver extensions.

Definition at line 32 of file Plugin.php.

Referenced by Sabre\CalDAV\Notifications\PluginTest\testNotificationProperties(), and Sabre\CalDAV\Notifications\PluginTest\testPrincipalProperties().

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

libs/composer/vendor/sabre/dav/lib/CalDAV/Notifications/Plugin.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ getPluginInfo()

◆ getPluginName()

◆ httpGet()

◆ initialize()

◆ propFind()

Field Documentation

◆ $server

◆ NS_CALENDARSERVER