Class: Sabre_DAV_ServerPlugin

Source Location: /includes/classes/SabreDAV/lib/Sabre/DAV/ServerPlugin.php

Class Overview [line 14]


The baseclass for all server plugins.

Author(s):

  • Evert Pot (http://www.rooftopsolutions.nl/)

Version:

Copyright:

  • Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.

Variables

Constants

Methods


Child classes:

Sabre_CalDAV_Plugin
CalDAV plugin
Sabre_DAV_Auth_Plugin
This plugin provides Authentication for a WebDAV server.
Sabre_DAV_Browser_GuessContentType
GuessContentType plugin
Sabre_DAV_Browser_MapGetToPropFind
This is a simple plugin that will map any GET request for non-files to PROPFIND allprops-requests.
Sabre_DAV_Browser_Plugin
Browser Plugin
Sabre_DAV_Locks_Plugin
Locking plugin
Sabre_DAV_Mount_Plugin
This plugin provides support for RFC4709: Mounting WebDAV servers
Sabre_DAV_TemporaryFileFilterPlugin
Temporary File Filter Plugin
Sabre_DAV_ServerPluginMock
The baseclass for all server plugins.
Sabre_DAV_TestPlugin
The baseclass for all server plugins.

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

The baseclass for all server plugins.

Plugins can modify or extend the servers behaviour.

Tags:

[ Top ]


Class Variables


Class Methods

getFeatures

array getFeatures( )

[line 37]

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.

Tags:

  • access - public

Overridden in child classes as:

Sabre_CalDAV_Plugin::getFeatures()
Returns a list of features for the DAV: HTTP header.
Sabre_DAV_Locks_Plugin::getFeatures()
Returns a list of features for the HTTP OPTIONS Dav: header.
Sabre_DAV_TestPlugin::getFeatures()

Parameters:

[ Top ]

getHTTPMethods

array getHTTPMethods( string $uri)

[line 53]

Use this method to tell the server this plugin defines additional HTTP methods.

This method is passed a uri. It should only return HTTP methods that are available for the specified uri.

Tags:

  • access - public

Overridden in child classes as:

Sabre_CalDAV_Plugin::getHTTPMethods()
Use this method to tell the server this plugin defines additional HTTP methods.
Sabre_DAV_Locks_Plugin::getHTTPMethods()
Use this method to tell the server this plugin defines additional HTTP methods.
Sabre_DAV_TestPlugin::getHTTPMethods()

Parameters:

  • string $uri -

[ Top ]

initialize

void initialize( Sabre_DAV_Server $server)

[line 27]

This initializes the plugin.

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

This method should set up the requires event subscriptions.

Tags:

  • abstract -
  • access - public

Overridden in child classes as:

Sabre_CalDAV_Plugin::initialize()
Initializes the plugin
Sabre_DAV_Auth_Plugin::initialize()
Initializes the plugin. This function is automatically called by the server
Sabre_DAV_Browser_GuessContentType::initialize()
Initializes the plugin
Sabre_DAV_Browser_MapGetToPropFind::initialize()
Initializes the plugin and subscribes to events
Sabre_DAV_Browser_Plugin::initialize()
Initializes the plugin and subscribes to events
Sabre_DAV_Locks_Plugin::initialize()
Initializes the plugin
Sabre_DAV_Mount_Plugin::initialize()
Initializes the plugin and registers event handles
Sabre_DAV_TemporaryFileFilterPlugin::initialize()
Initialize the plugin
Sabre_DAV_ServerPluginMock::initialize()
Sabre_DAV_TestPlugin::initialize()

Parameters:

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:54:04 -0400 by phpDocumentor 1.4.3