Response
in package
implements
Element
WebDAV {DAV:}response parser.
This class parses the {DAV:}response element, as defined in:
https://tools.ietf.org/html/rfc4918#section-14.24
Tags
Interfaces, Classes and Traits
- Element
- This is the XML element interface.
Table of Contents
- $href : string
- Url for the response.
- $httpStatus : string
- The HTTP status for an entire response.
- $responseProperties : array<string|int, mixed>
- Propertylist, ordered by HTTP status code.
- __construct() : mixed
- The href argument is a url relative to the root of the server. This class will calculate the full path.
- getHref() : string
- Returns the url.
- getHttpStatus() : string
- Returns the httpStatus value.
- getResponseProperties() : array<string|int, mixed>
- Returns the property list.
- xmlDeserialize() : mixed
- The deserialize method is called during xml parsing.
- xmlSerialize() : mixed
- The serialize method is called during xml writing.
Properties
$href
Url for the response.
protected
string
$href
$httpStatus
The HTTP status for an entire response.
protected
string
$httpStatus
This is currently only used in WebDAV-Sync
$responseProperties
Propertylist, ordered by HTTP status code.
protected
array<string|int, mixed>
$responseProperties
Methods
__construct()
The href argument is a url relative to the root of the server. This class will calculate the full path.
public
__construct(string $href, array<string|int, mixed> $responseProperties[, string $httpStatus = null ]) : mixed
The responseProperties argument is a list of properties within an array with keys representing HTTP status codes
Besides specific properties, the entire {DAV:}response element may also have a http status code. In most cases you don't need it.
This is currently used by the Sync extension to indicate that a node is deleted.
Parameters
- $href : string
- $responseProperties : array<string|int, mixed>
- $httpStatus : string = null
Return values
mixed —getHref()
Returns the url.
public
getHref() : string
Return values
string —getHttpStatus()
Returns the httpStatus value.
public
getHttpStatus() : string
Return values
string —getResponseProperties()
Returns the property list.
public
getResponseProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —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 —xmlSerialize()
The serialize method is called during xml writing.
public
xmlSerialize(Writer $writer) : mixed
It should use the $writer argument to encode this object into XML.
Important note: it is not needed to create the parent element. The parent element is already created, and we only have to worry about attributes, child elements and text (if any).
Important note 2: If you are writing any new elements, you are also responsible for closing them.
Parameters
- $writer : Writer