Class: Sabre_DAV_Auth_Principal

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

Class Overview [line 16]

Sabre_DAV_Node
   |
   --Sabre_DAV_Auth_Principal

Principal class

Author(s):

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

Version:

Copyright:

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

Variables

Constants

Methods


Implements interfaces

Inherited Variables

Inherited Constants

Inherited Methods

Class: Sabre_DAV_Node

Sabre_DAV_Node::delete()
Deleted the current node
Sabre_DAV_Node::getLastModified()
Returns the last modification time
Sabre_DAV_Node::setName()
Renames the node


Class Details

Principal class

This class represents a user in the directory tree. Many WebDAV specs require a user to show up in the directory structure. The principal is defined in RFC 3744.

Tags:

[ Top ]


Class Variables

$principalProperties

[line 30]

Struct with principal information.

Tags:

  • access - protected

Type: array

Overrides:

[ Top ]

$principalUri

[line 23]

Full uri for this principal resource

Tags:

  • access - protected

Type: string

Overrides:

[ Top ]


Class Methods

__construct

Sabre_DAV_Auth_Principal __construct( string $principalUri, [ $principalProperties = array()])

[line 38]

Creates the principal object

Tags:

  • access - public

Parameters:

  • string $principalUri - Full uri to the principal resource
  • array $principalProperties -

[ Top ]

getDisplayName

void getDisplayName( )

[line 62]

Returns the name of the user

Tags:

  • access - public

Parameters:

[ Top ]

getName

void getName( )

[line 50]

Returns the name of the element

Tags:

  • access - public

Implementation of:
Sabre_DAV_INode::getName()
Returns the name of the node

Parameters:

[ Top ]

getProperties

void getProperties( array $requestedProperties)

[line 78]

Returns a list of properties

Tags:

  • access - public

Implementation of:
Sabre_DAV_IProperties::getProperties()
Returns a list of properties for this nodes.

Parameters:

  • array $requestedProperties -

[ Top ]

updateProperties

bool|array updateProperties( array $properties)

[line 141]

Updates this principals properties.

Currently this is not supported

Tags:

  • see - Sabre_DAV_IProperties::updateProperties
  • access - public

Implementation of:
Sabre_DAV_IProperties::updateProperties()
Updates properties on this node,

Parameters:

  • array $properties -

[ Top ]


Class Constants


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