Class: Sabre_DAV_Property_Principal

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

Class Overview [line 19]

Sabre_DAV_Property
   |
   --Sabre_DAV_Property_Principal

Principal property

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



Class Details

Principal property

The principal property represents a principal from RFC3744 (ACL). The property can be used to specify a principal or pseudo principals.

Tags:

[ Top ]


Class Variables


Class Methods

__construct

void __construct( int $type, [string $href = null])

[line 65]

Creates the property.

The 'type' argument must be one of the type constants defined in this class.

'href' is only required for the HREF type.

Tags:

  • access - public

Parameters:

  • int $type -
  • string $href -

[ Top ]

getHref

string getHref( )

[line 92]

Returns the principal uri.

Tags:

  • access - public

Implementation of:
Sabre_DAV_Property_IHref::getHref()
getHref

Parameters:

[ Top ]

getType

int getType( )

[line 81]

Returns the principal type

Tags:

  • access - public

Parameters:

[ Top ]

serialize

void serialize( Sabre_DAV_Server $server, $node)

[line 105]

Serializes the property into a DOMElement.

Tags:

  • access - public

Overrides Sabre_DAV_Property::serialize() (parent method not documented)

Parameters:

[ Top ]


Class Constants

AUTHENTICATED =  2

[line 29]

To specify any principal that is logged in, use AUTHENTICATED

[ Top ]

HREF =  3

[line 34]

Specific princpals can be specified with the HREF

[ Top ]

UNAUTHENTICATED =  1

[line 24]

To specify a not-logged-in user, use the UNAUTHENTICTED principal

[ Top ]


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