SupportedReportSet
in package
implements
XmlSerializable, HtmlOutput
supported-report-set property.
This property is defined in RFC3253, but since it's so common in other webdav-related specs, it is part of the core server.
This property is defined here: http://tools.ietf.org/html/rfc3253#section-3.1.5
Tags
Interfaces, Classes and Traits
- XmlSerializable
- Objects implementing XmlSerializable can control how they are represented in Xml.
- HtmlOutput
- WebDAV properties that implement this interface are able to generate their own html output for the browser plugin.
Table of Contents
- $reports : array<string|int, mixed>
- List of reports.
- __construct() : mixed
- Creates the property.
- addReport() : mixed
- Adds a report to this property.
- getValue() : array<string|int, string>
- Returns the list of supported reports.
- has() : bool
- Returns true or false if the property contains a specific report.
- toHtml() : string
- Generate html representation for this value.
- xmlSerialize() : mixed
- The xmlSerialize method is called during xml writing.
Properties
$reports
List of reports.
protected
array<string|int, mixed>
$reports
= []
Methods
__construct()
Creates the property.
public
__construct([string|array<string|int, string> $reports = null ]) : mixed
Any reports passed in the constructor should be valid report-types in clark-notation.
Either a string or an array of strings must be passed.
Parameters
- $reports : string|array<string|int, string> = null
Return values
mixed —addReport()
Adds a report to this property.
public
addReport(mixed $report) : mixed
The report must be a string in clark-notation. Multiple reports can be specified as an array.
Parameters
- $report : mixed
Return values
mixed —getValue()
Returns the list of supported reports.
public
getValue() : array<string|int, string>
Return values
array<string|int, string> —has()
Returns true or false if the property contains a specific report.
public
has(string $reportName) : bool
Parameters
- $reportName : string
Return values
bool —toHtml()
Generate html representation for this value.
public
toHtml(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
- $html : HtmlOutputHelper
Return values
string —xmlSerialize()
The xmlSerialize method is called during xml writing.
public
xmlSerialize(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
- $writer : Writer