Class Sabre_DAV_Auth_PrincipalCollection

Description

Principals Collection

This collection represents a list of users. It uses Sabre_DAV_Auth_Backend to determine which users are available on the list.

The users are instances of Sabre_DAV_Auth_Principal

  • author: Evert Pot (http://www.rooftopsolutions.nl/)
  • copyright: Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.
  • license: Modified BSD License

Located in /sources_custom/Sabre/DAV/Auth/PrincipalCollection.php (line 17)

Sabre_DAV_Node
   |
   --Sabre_DAV_Directory
      |
      --Sabre_DAV_Auth_PrincipalCollection
Class Constant Summary
 NODENAME = 'principals'
Variable Summary
Sabre_DAV_Auth_Backend $authBackend
Method Summary
Sabre_DAV_Auth_PrincipalCollection __construct (Sabre_DAV_Auth_Backend_Abstract $authBackend)
void getChildren ()
string getName ()
Variables
Sabre_DAV_Auth_Backend $authBackend (line 31)

Authentication backend

  • access: protected
Methods
Constructor __construct (line 38)

Creates the object

  • access: public
Sabre_DAV_Auth_PrincipalCollection __construct (Sabre_DAV_Auth_Backend_Abstract $authBackend)
getChildren (line 60)

Retursn the list of users

  • access: public
void getChildren ()
getName (line 49)

Returns the name of this collection.

  • access: public
string getName ()

Inherited Methods

Inherited From Sabre_DAV_Directory

Sabre_DAV_Directory::childExists()
Sabre_DAV_Directory::createDirectory()
Sabre_DAV_Directory::createFile()
Sabre_DAV_Directory::getChild()

Inherited From Sabre_DAV_Node

Sabre_DAV_Node::delete()
Sabre_DAV_Node::getLastModified()
Sabre_DAV_Node::setName()
Class Constants
NODENAME = 'principals' (line 24)

The name of this object. It is not adviced to change this.

The plugins that depend on the principals collection to exist need to be have a common name to find it.

Documentation generated on Sun, 02 Jan 2011 23:23:02 +0000 by phpDocumentor 1.4.3