Page MenuHomePhabricator
Files F1814340

SupportedCalendarComponentSet.php
No OneTemporary
Actions

SupportedCalendarComponentSet.php
View Options

<?php
namespace Sabre\CalDAV\Xml\Property;
use Sabre\Xml\Element;
use Sabre\Xml\ParseException;
use Sabre\Xml\Reader;
use Sabre\Xml\Writer;
use Sabre\CalDAV\Plugin;
/**
* SupportedCalendarComponentSet property.
*
* This class represents the
* {urn:ietf:params:xml:ns:caldav}supported-calendar-component-set property, as
* defined in:
*
* https://tools.ietf.org/html/rfc4791#section-5.2.3
*
* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
* @author Evert Pot (http://evertpot.com/)
* @license http://sabre.io/license/ Modified BSD License
*/
class SupportedCalendarComponentSet implements Element {
/**
* List of supported components.
*
* This array will contain values such as VEVENT, VTODO and VJOURNAL.
*
* @var array
*/
protected $components = [];
/**
* Creates the property.
*
* @param array $components
*/
function __construct(array $components) {
$this->components = $components;
}
/**
* Returns the list of supported components
*
* @return array
*/
function getValue() {
return $this->components;
}
/**
* 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->components as $component) {
$writer->startElement('{' . Plugin::NS_CALDAV . '}comp');
$writer->writeAttributes(['name' => $component]);
$writer->endElement();
}
}
/**
* The deserialize method is called during xml parsing.
*
* This method is called statictly, 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.
*
* @param Reader $reader
* @return mixed
*/
static function xmlDeserialize(Reader $reader) {
$elems = $reader->parseInnerTree();
$components = [];
foreach ((array)$elems as $elem) {
if ($elem['name'] === '{' . Plugin::NS_CALDAV . '}comp') {
$components[] = $elem['attributes']['name'];
}
}
if (!$components) {
throw new ParseException('supported-calendar-component-set must have at least one CALDAV:comp element');
}
return new self($components);
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Dec 20, 10:57 AM (4 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
914214
Default Alt Text
SupportedCalendarComponentSet.php (3 KB)

Event Timeline