Documentation

PrincipalPropertySearchReport
in package

Application

implements XmlDeserializable

PrincipalSearchPropertySetReport request parser.

This class parses the {DAV:}principal-property-search REPORT, as defined in:

https://tools.ietf.org/html/rfc3744#section-9.4

Interfaces, Classes and Traits

XmlDeserializable: Implementing the XmlDeserializable interface allows you to use a class as a deserializer for a specific element.

$applyToPrincipalCollectionSet : bool: By default the property search will be conducted on the url of the http request. If this is set to true, it will be applied to the principal collection set instead.
$properties : array<string|int, mixed>|null: The requested properties.
$searchProperties : array<string|int, mixed>: searchProperties.
$test : string: Search for principals matching ANY of the properties (OR) or a ALL of the properties (AND).
xmlDeserialize() : mixed: The deserialize method is called during xml parsing.

$applyToPrincipalCollectionSet

By default the property search will be conducted on the url of the http request. If this is set to true, it will be applied to the principal collection set instead.


    public
        bool
    $applyToPrincipalCollectionSet
     = false

$properties

The requested properties.


    public
        array<string|int, mixed>|null
    $properties

$searchProperties

searchProperties.


    public
        array<string|int, mixed>
    $searchProperties
     = []

$test

Search for principals matching ANY of the properties (OR) or a ALL of the properties (AND).


    public
        string
    $test

This property is either "anyof" or "allof".

xmlDeserialize()

The deserialize method is called during xml parsing.


    public
            static    xmlDeserialize(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.

Parameters

$reader : Reader

Return values

mixed —