Principal

Principal property.

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

Full name: \Sabre\DAVACL\Xml\Property\Principal
Parent class: \Sabre\DAV\Xml\Property\Href

Constants

Constant	Visibility	Value
`UNAUTHENTICATED`	public	1
`AUTHENTICATED`	public	2
`HREF`	public	3
`ALL`	public	4

Properties

type

Principal-type.

protected int $type

Must be one of the UNAUTHENTICATED, AUTHENTICATED or HREF constants.

Methods

__construct

Creates the property.

public __construct(int $type, string|null $href = null): mixed

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

'href' is only required for the HREF type.

Parameters:

Parameter	Type	Description
`$type`	int
`$href`	string\|null

getType

Returns the principal type.

public getType(): int

xmlSerialize

The xmlSerialize method is called during xml writing.

public xmlSerialize(\Sabre\Xml\Writer $writer): mixed

Use the $writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializable should only ever write what's considered its 'inner xml'.

The parent of the current element is responsible for writing a containing element.

This allows serializers to be re-used for different element names.

If you are opening new elements, you must also close them again.

Parameters:

Parameter	Type	Description
`$writer`	\Sabre\Xml\Writer

toHtml

Generate html representation for this value.

public toHtml(\Sabre\DAV\Browser\HtmlOutputHelper $html): string

The html output is 100% trusted, and no effort is being made to sanitize it. It's up to the implementor to sanitize user provided values.

The output must be in UTF-8.

The baseUri parameter is a url to the root of the application, and can be used to construct local links.

Parameters:

Parameter	Type	Description
`$html`	\Sabre\DAV\Browser\HtmlOutputHelper

xmlDeserialize

The deserialize method is called during xml parsing.

public static xmlDeserialize(\Sabre\Xml\Reader $reader): mixed

This method is called staticly, this is because in theory this method may be used as a type of constructor, or factory method.

Often you want to return an instance of the current class, but you are free to return other data as well.

Important note 2: You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.

If you just want to skip parsing for this element altogether, you can just call $reader->next();

$reader->parseInnerTree() will parse the entire sub-tree, and advance to the next element.

This method is static.

Parameters:

Parameter	Type	Description
`$reader`	\Sabre\Xml\Reader

Inherited methods

__construct

Constructor.

public __construct(string|string[] $hrefs): mixed

You must either pass a string for a single href, or an array of hrefs.

Parameters:

Parameter	Type	Description
`$hrefs`	string\|string[]

getHref

Returns the first Href.

public getHref(): string|null

getHrefs

Returns the hrefs as an array.

public getHrefs(): array

xmlSerialize

The xmlSerialize method is called during xml writing.

public xmlSerialize(\Sabre\Xml\Writer $writer): mixed

Use the $writer argument to write its own xml serialization.

An important note: do not create a parent element. Any element implementing XmlSerializable should only ever write what's considered its 'inner xml'.

The parent of the current element is responsible for writing a containing element.

This allows serializers to be re-used for different element names.

If you are opening new elements, you must also close them again.

Parameters:

Parameter	Type	Description
`$writer`	\Sabre\Xml\Writer

toHtml

Generate html representation for this value.

public toHtml(\Sabre\DAV\Browser\HtmlOutputHelper $html): string

The html output is 100% trusted, and no effort is being made to sanitize it. It's up to the implementor to sanitize user provided values.

The output must be in UTF-8.

The baseUri parameter is a url to the root of the application, and can be used to construct local links.

Parameters:

Parameter	Type	Description
`$html`	\Sabre\DAV\Browser\HtmlOutputHelper

xmlDeserialize

The deserialize method is called during xml parsing.

public static xmlDeserialize(\Sabre\Xml\Reader $reader): mixed

This method is called statically, this is because in theory this method may be used as a type of constructor, or factory method.

Often you want to return an instance of the current class, but you are free to return other data as well.

You are responsible for advancing the reader to the next element. Not doing anything will result in a never-ending loop.

If you just want to skip parsing for this element altogether, you can just call $reader->next();

$reader->parseInnerTree() will parse the entire sub-tree, and advance to the next element.

This method is static.

Parameters:

Parameter	Type	Description
`$reader`	\Sabre\Xml\Reader

Automatically generated on 2025-03-18