Page MenuHomePhabricator
Files F1841195

SupportedReportSet.php
No OneTemporary
Actions

SupportedReportSet.php
View Options

<?php
namespace Sabre\DAV\Xml\Property;
use Sabre\DAV;
use Sabre\DAV\Browser\HtmlOutput;
use Sabre\DAV\Browser\HtmlOutputHelper;
use Sabre\Xml\Writer;
use Sabre\Xml\XmlSerializable;
/**
* 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
*
* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
* @author Evert Pot (http://www.rooftopsolutions.nl/)
* @license http://sabre.io/license/ Modified BSD License
*/
class SupportedReportSet implements XmlSerializable, HtmlOutput {
/**
* List of reports
*
* @var array
*/
protected $reports = [];
/**
* Creates the property
*
* 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.
*
* @param string|string[] $reports
*/
function __construct($reports = null) {
if (!is_null($reports))
$this->addReport($reports);
}
/**
* Adds a report to this property
*
* The report must be a string in clark-notation.
* Multiple reports can be specified as an array.
*
* @param mixed $report
* @return void
*/
function addReport($report) {
$report = (array)$report;
foreach ($report as $r) {
if (!preg_match('/^{([^}]*)}(.*)$/', $r))
throw new DAV\Exception('Reportname must be in clark-notation');
$this->reports[] = $r;
}
}
/**
* Returns the list of supported reports
*
* @return string[]
*/
function getValue() {
return $this->reports;
}
/**
* Returns true or false if the property contains a specific report.
*
* @param string $reportName
* @return bool
*/
function has($reportName) {
return in_array(
$reportName,
$this->reports
);
}
/**
* The xmlSerialize metod is called during xml writing.
*
* Use the $writer argument to write its own xml serialization.
*
* An important note: do _not_ create a parent element. Any element
* implementing XmlSerializble 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.
*
* @param Writer $writer
* @return void
*/
function xmlSerialize(Writer $writer) {
foreach ($this->getValue() as $val) {
$writer->startElement('{DAV:}supported-report');
$writer->startElement('{DAV:}report');
$writer->writeElement($val);
$writer->endElement();
$writer->endElement();
}
}
/**
* Generate html representation for this value.
*
* 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.
*
* @param HtmlOutputHelper $html
* @return string
*/
function toHtml(HtmlOutputHelper $html) {
return implode(
', ',
array_map([$html, 'xmlName'], $this->getValue())
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Tue, Jan 7, 2:27 PM (3 d, 5 h ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
914442
Default Alt Text
SupportedReportSet.php (3 KB)

Event Timeline