Documentation

PrincipalMatchReport
in package

Application

implements XmlDeserializable

PrincipalMatchReport request parser.

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

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

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

PRINCIPAL_PROPERTY = 2: Report on a property on resources, such as {DAV:}owner, that match the current principal.
SELF = 1: Report on a list of principals that match the current principal.
$principalProperty : string: If $type = PRINCIPAL_PROPERTY, which WebDAV property we should compare to the current principal.
$properties : array<string|int, string>: List of properties that are being requested for matching resources.
$type : int: Must be SELF or PRINCIPAL_PROPERTY.
xmlDeserialize() : mixed: The deserialize method is called during xml parsing.

Report on a property on resources, such as {DAV:}owner, that match the current principal.


    public
    mixed
    PRINCIPAL_PROPERTY
    = 2

Report on a list of principals that match the current principal.


    public
    mixed
    SELF
    = 1

If $type = PRINCIPAL_PROPERTY, which WebDAV property we should compare to the current principal.


    public
        string
    $principalProperty

List of properties that are being requested for matching resources.


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

Must be SELF or PRINCIPAL_PROPERTY.


    public
        int
    $type

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.

mixed —