Documentation

ScheduleCalendarTransp
in package
implements Element

schedule-calendar-transp property.

This property is a representation of the schedule-calendar-transp property. This property is defined in:

http://tools.ietf.org/html/rfc6638#section-9.1

Its values are either 'transparent' or 'opaque'. If it's transparent, it means that this calendar will not be taken into consideration when a different user queries for free-busy information. If it's 'opaque', it will.

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Evert Pot (http://www.rooftopsolutions.nl/)

license

http://sabre.io/license/ Modified BSD License

Interfaces, Classes and Traits

Element
This is the XML element interface.

Table of Contents

OPAQUE  = 'opaque'
TRANSPARENT  = 'transparent'
$value  : string
value.
__construct()  : mixed
Creates the property.
getValue()  : string
Returns the current value.
xmlDeserialize()  : mixed
The deserialize method is called during xml parsing.
xmlSerialize()  : mixed
The xmlSerialize method is called during xml writing.

Constants

Properties

Methods

__construct()

Creates the property.

public __construct(string $value) : mixed
Parameters
$value : string
Return values
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 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
Return values
mixed

Search results