Class: Sabre_DAV_Auth_Plugin

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

Class Overview [line 18]

Sabre_DAV_ServerPlugin
   |
   --Sabre_DAV_Auth_Plugin

This plugin provides Authentication for a WebDAV server.

Author(s):

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

Version:

Copyright:

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

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods

Class: Sabre_DAV_ServerPlugin

Sabre_DAV_ServerPlugin::getFeatures()
This method should return a list of server-features.
Sabre_DAV_ServerPlugin::getHTTPMethods()
Use this method to tell the server this plugin defines additional HTTP methods.
Sabre_DAV_ServerPlugin::initialize()
This initializes the plugin.


Class Details

This plugin provides Authentication for a WebDAV server.

It relies on a Backend object, which provides user information.

Additionally, it provides support for: * {DAV:}current-user-principal property from RFC5397 * {DAV:}principal-collection-set property from RFC3744

Tags:

[ Top ]


Class Variables


Class Methods

__construct

void __construct( Sabre_DAV_Auth_Backend_Abstract $authBackend, string $realm)

[line 48]

__construct

Tags:

  • access - public

Parameters:

[ Top ]

afterGetProperties

void afterGetProperties( $href, &$properties)

[line 78]

This method intercepts calls to PROPFIND and similar lookups

This is done to inject the current-user-principal if this is requested.

Tags:

  • todo - support for 'unauthenticated'
  • access - public

Parameters:

  • $href -
  • &$properties -

[ Top ]

beforeMethod

bool beforeMethod( string $method)

[line 108]

This method is called before any HTTP method and forces users to be authenticated

Tags:

  • throws - Sabre_DAV_Exception_NotAuthenticated
  • access - public

Parameters:

  • string $method -

[ Top ]

expandProperties

void expandProperties( array $path, $requestedProperties, array $depth)

[line 238]

This method expands all the properties and returns a list with property values

Tags:

  • access - protected

Parameters:

  • array $path -
  • array $requestedProperties - the list of required properties
  • array $depth -

[ Top ]

expandPropertyReport

void expandPropertyReport( DOMElement $dom)

[line 158]

The expand-property report is defined in RFC3253 section 3-8.

This report is very similar to a standard PROPFIND. The difference is that it has the additional ability to look at properties containing a {DAV:}href element, follow that property and grab additional elements there.

Other rfc's, such as ACL rely on this report, so it made sense to put it in this plugin.

Tags:

  • access - protected

Parameters:

  • DOMElement $dom -

[ Top ]

initialize

void initialize( Sabre_DAV_Server $server)

[line 61]

Initializes the plugin. This function is automatically called by the server

Tags:

  • access - public

Overrides Sabre_DAV_ServerPlugin::initialize() (This initializes the plugin.)

Parameters:

[ Top ]

parseExpandPropertyReportRequest

array parseExpandPropertyReportRequest( DOMElement $node)

[line 201]

This method is used by expandPropertyReport to parse out the entire HTTP request.

Tags:

  • access - protected

Parameters:

  • DOMElement $node -

[ Top ]

parsePrincipalPropertySearchReportRequest

void parsePrincipalPropertySearchReportRequest( $dom)

[line 386]

Tags:

  • access - protected

Parameters:

  • $dom -

[ Top ]

principalPropertySearchReport

void principalPropertySearchReport( $dom)

[line 334]

Tags:

  • access - protected

Parameters:

  • $dom -

[ Top ]

principalSearchPropertySetReport

void principalSearchPropertySetReport( $dom)

[line 268]

Tags:

  • access - protected

Parameters:

  • DOMDocument $dom -

[ Top ]

report

bool|null report( string $reportName, DOMNode $dom)

[line 121]

This functions handles REPORT requests

Tags:

  • access - public

Parameters:

  • string $reportName -
  • DOMNode $dom -

[ Top ]


Class Constants


Documentation generated on Mon, 31 May 2010 12:53:47 -0400 by phpDocumentor 1.4.3