Inheritance diagram for Sabre\VObject\Component\VCalendar:

Collaboration diagram for Sabre\VObject\Component\VCalendar:

Public Member Functions
	getDocumentType ()
	Returns the current document type. More...

	getBaseComponents ($componentName=null)
	Returns a list of all 'base components'. More...

	getBaseComponent ($componentName=null)
	Returns the first component that is not a VTIMEZONE, and does not have an RECURRENCE-ID. More...

	expand (DateTimeInterface $start, DateTimeInterface $end, DateTimeZone $timeZone=null)
	Expand all events in this VCalendar object and return a new VCalendar with the expanded events. More...

	getValidationRules ()

	validate ($options=0)
	Validates the node for correctness. More...

	getByUID ($uid)
	Returns all components with a specific UID value. More...

Public Member Functions inherited from Sabre\VObject\Document
	__construct ()
	Creates a new document. More...

	getDocumentType ()
	Returns the current document type. More...

	create ($name)
	Creates a new component or property. More...

	createComponent ($name, array $children=null, $defaults=true)
	Creates a new component. More...

	createProperty ($name, $value=null, array $parameters=null, $valueType=null)
	Factory method for creating new properties. More...

	getClassNameForPropertyValue ($valueParam)
	This method returns a full class-name for a value parameter. More...

	getClassNameForPropertyName ($propertyName)
	Returns the default class for a property name. More...

Public Member Functions inherited from Sabre\VObject\Component
	__construct (Document $root, $name, array $children=[], $defaults=true)
	Creates a new component. More...

	add ()
	Adds a new property or component, and returns the new item. More...

	remove ($item)
	This method removes a component or property from this component. More...

	children ()
	Returns a flat list of all the properties and components in this component. More...

	getComponents ()
	This method only returns a list of sub-components. More...

	select ($name)
	Returns an array with elements that match the specified name. More...

	serialize ()
	Turns the object back into a serialized blob. More...

	jsonSerialize ()
	This method returns an array, with the representation as it should be encoded in JSON. More...

	xmlSerialize (Xml\Writer $writer)
	This method serializes the data into XML. More...

	__isset ($name)
	This method checks if a sub-element with the specified name exists. More...

	__set ($name, $value)
	Using the setter method you can add properties or subcomponents. More...

	__unset ($name)
	Removes all properties and components within this component with the specified name. More...

	__clone ()
	This method is automatically called when the object is cloned. More...

	getValidationRules ()

	validate ($options=0)
	Validates the node for correctness. More...

	destroy ()
	Call this method on a document if you're done using it. More...

Public Member Functions inherited from Sabre\VObject\Node
	serialize ()
	Serializes the node into a mimedir format. More...

	jsonSerialize ()
	This method returns an array, with the representation as it should be encoded in JSON. More...

	xmlSerialize (Xml\Writer $writer)
	This method serializes the data into XML. More...

	destroy ()
	Call this method on a document if you're done using it. More...

	getIterator ()
	Returns the iterator for this object. More...

	setIterator (ElementList $iterator)
	Sets the overridden iterator. More...

	validate ($options=0)
	Validates the node for correctness. More...

	count ()
	Returns the number of elements. More...

	offsetExists ($offset)
	Checks if an item exists through ArrayAccess. More...

	offsetGet ($offset)
	Gets an item through ArrayAccess. More...

	offsetSet ($offset, $value)
	Sets an item through ArrayAccess. More...

	offsetUnset ($offset)
	Sets an item through ArrayAccess. More...

Public Member Functions inherited from Sabre\Xml\XmlSerializable
	xmlSerialize (Writer $writer)
	The xmlSerialize method is called during xml writing. More...

Static Public Attributes
static	$defaultName = 'VCALENDAR'

static	$componentMap

static	$valueMap

static	$propertyMap

Static Public Attributes inherited from Sabre\VObject\Document
static	$defaultName

static	$propertyMap = []

static	$componentMap = []

static	$valueMap = []

Protected Member Functions
	getDefaults ()
	This method should return a list of default property values. More...

	getDefaults ()
	This method should return a list of default property values. More...

Additional Inherited Members
Data Fields inherited from Sabre\VObject\Document
const	UNKNOWN = 1
	Unknown document type. More...

const	VCALENDAR10 = 2
	vCalendar 1.0. More...

const	ICALENDAR20 = 3
	iCalendar 2.0. More...

const	VCARD21 = 4
	vCard 2.1. More...

const	VCARD30 = 5
	vCard 3.0. More...

const	VCARD40 = 6
	vCard 4.0. More...

Data Fields inherited from Sabre\VObject\Component
	$name

Data Fields inherited from Sabre\VObject\Node
const	REPAIR = 1
	The following constants are used by the validate() method. More...

const	PROFILE_CARDDAV = 2
	If this option is set, the validator will operate on the vcards on the assumption that the vcards need to be valid for CardDAV. More...

const	PROFILE_CALDAV = 4
	If this option is set, the validator will operate on iCalendar objects on the assumption that the vcards need to be valid for CalDAV. More...

	$parent

Protected Attributes inherited from Sabre\VObject\Component
	$children = []

Protected Attributes inherited from Sabre\VObject\Node
	$iterator = null

	$root

Detailed Description

The VCalendar component.

This component adds functionality to a component, specific for a VCALENDAR.

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

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 23 of file VCalendar.php.

Member Function Documentation

◆ expand()

Sabre\VObject\Component\VCalendar::expand	(	DateTimeInterface	$start,
		DateTimeInterface	$end,
		DateTimeZone	$timeZone = `null`
	)

Expand all events in this VCalendar object and return a new VCalendar with the expanded events.

If this calendar object, has events with recurrence rules, this method can be used to expand the event into multiple sub-events.

Each event will be stripped from it's recurrence information, and only the instances of the event in the specified timerange will be left alone.

In addition, this method will cause timezone information to be stripped, and normalized to UTC.

Parameters

DateTimeInterface	$start
DateTimeInterface	$end
DateTimeZone	$timeZone	reference timezone for floating dates and times.

Returns: VCalendar

Definition at line 293 of file VCalendar.php.

                                                                                                     {
 
        $newChildren = [];
        $recurringEvents = [];
 
        if (!$timeZone) {
            $timeZone = new DateTimeZone('UTC');
        }
 
        $stripTimezones = function(Component $component) use ($timeZone, &$stripTimezones) {
 
            foreach ($component->children() as $componentChild) {
                if ($componentChild instanceof Property\ICalendar\DateTime && $componentChild->hasTime()) {
 
                    $dt = $componentChild->getDateTimes($timeZone);
                    // We only need to update the first timezone, because
                    // setDateTimes will match all other timezones to the
                    // first.
                    $dt[0] = $dt[0]->setTimeZone(new DateTimeZone('UTC'));
                    $componentChild->setDateTimes($dt);
                } elseif ($componentChild instanceof Component) {
                    $stripTimezones($componentChild);
                }
 
            }
            return $component;
 
        };
 
        foreach ($this->children() as $child) {
 
            if ($child instanceof Property && $child->name !== 'PRODID') {
                // We explictly want to ignore PRODID, because we want to
                // overwrite it with our own.
                $newChildren[] = clone $child;
            } elseif ($child instanceof Component && $child->name !== 'VTIMEZONE') {
 
                // We're also stripping all VTIMEZONE objects because we're
                // converting everything to UTC.
                if ($child->name === 'VEVENT' && (isset($child->{'RECURRENCE-ID'}) || isset($child->RRULE) || isset($child->RDATE))) {
                    // Handle these a bit later.
                    $uid = (string)$child->UID;
                    if (!$uid) {
                        throw new InvalidDataException('Every VEVENT object must have a UID property');
                    }
                    if (isset($recurringEvents[$uid])) {
                        $recurringEvents[$uid][] = clone $child;
                    } else {
                        $recurringEvents[$uid] = [clone $child];
                    }
                } elseif ($child->name === 'VEVENT' && $child->isInTimeRange($start, $end)) {
                    $newChildren[] = $stripTimezones(clone $child);
                }
 
            }
 
        }
 
        foreach ($recurringEvents as $events) {
 
            try {
                $it = new EventIterator($events, $timeZone);
 
            } catch (NoInstancesException $e) {
                // This event is recurring, but it doesn't have a single
                // instance. We are skipping this event from the output
                // entirely.
                continue;
            }
            $it->fastForward($start);
 
            while ($it->valid() && $it->getDTStart() < $end) {
 
                if ($it->getDTEnd() > $start) {
 
                    $newChildren[] = $stripTimezones($it->getEventObject());
 
                }
                $it->next();
 
            }
 
        }
 
        return new self($newChildren);
 
    }

References $end, $start, $timeZone, and if.

◆ getBaseComponent()

Sabre\VObject\Component\VCalendar::getBaseComponent ( $componentName = null )

Returns the first component that is not a VTIMEZONE, and does not have an RECURRENCE-ID.

If there is no such component, null will be returned.

Parameters

string $componentName filter by component name

Returns: VObject\Component|null

Definition at line 234 of file VCalendar.php.

                                                     {
 
        $isBaseComponent = function($component) {
 
            if (!$component instanceof VObject\Component) {
                return false;
            }
            if ($component->name === 'VTIMEZONE') {
                return false;
            }
            if (isset($component->{'RECURRENCE-ID'})) {
                return false;
            }
            return true;
 
        };
 
        if ($componentName) {
            foreach ($this->select($componentName) as $child) {
                if ($isBaseComponent($child)) {
                    return $child;
                }
            }
            return null;
        }
 
        // Searching all components
        foreach ($this->children as $childGroup) {
            foreach ($childGroup as $child) {
                if ($isBaseComponent($child)) {
                    return $child;
                }
            }
 
        }
        return null;
 
    }

◆ getBaseComponents()

Sabre\VObject\Component\VCalendar::getBaseComponents ( $componentName = null )

Returns a list of all 'base components'.

For instance, if an Event has a recurrence rule, and one instance is overridden, the overridden event will have the same UID, but will be excluded from this list.

VTIMEZONE components will always be excluded.

Parameters

string $componentName filter by component name

Returns: VObject\Component[]

Definition at line 178 of file VCalendar.php.

                                                      {
 
        $isBaseComponent = function($component) {
 
            if (!$component instanceof VObject\Component) {
                return false;
            }
            if ($component->name === 'VTIMEZONE') {
                return false;
            }
            if (isset($component->{'RECURRENCE-ID'})) {
                return false;
            }
            return true;
 
        };
 
        if ($componentName) {
            // Early exit
            return array_filter(
                $this->select($componentName),
                $isBaseComponent
            );
        }
 
        $components = [];
        foreach ($this->children as $childGroup) {
 
            foreach ($childGroup as $child) {
 
                if (!$child instanceof Component) {
                    // If one child is not a component, they all are so we skip
                    // the entire group.
                    continue 2;
                }
                if ($isBaseComponent($child)) {
                    $components[] = $child;
                }
 
            }
 
        }
        return $components;
 
    }

◆ getByUID()

Sabre\VObject\Component\VCalendar::getByUID ( $uid )

Returns all components with a specific UID value.

Returns: array

Definition at line 546 of file VCalendar.php.

                            {
 
        return array_filter($this->getComponents(), function($item) use ($uid) {
 
            if (!$itemUid = $item->select('UID')) {
                return false;
            }
            $itemUid = current($itemUid)->getValue();
            return $uid === $itemUid;
 
        });
 
    }

◆ getDefaults()

Sabre\VObject\Component\VCalendar::getDefaults ( )

protected

This method should return a list of default property values.

Returns: array

Reimplemented from Sabre\VObject\Component.

Definition at line 386 of file VCalendar.php.

                                     {
 
        return [
            'VERSION'  => '2.0',
            'PRODID'   => '-//Sabre//Sabre VObject ' . VObject\Version::VERSION . '//EN',
            'CALSCALE' => 'GREGORIAN',
        ];
 
    }

◆ getDocumentType()

Sabre\VObject\Component\VCalendar::getDocumentType ( )

Returns the current document type.

Returns: int

Reimplemented from Sabre\VObject\Document.

Definition at line 161 of file VCalendar.php.

                               {
 
        return self::ICALENDAR20;
 
    }

References Sabre\VObject\Document\ICALENDAR20.

◆ getValidationRules()

Sabre\VObject\Component\VCalendar::getValidationRules ( )

Reimplemented from Sabre\VObject\Component.

Definition at line 411 of file VCalendar.php.

                                  {
 
        return [
            'PRODID'  => 1,
            'VERSION' => 1,
 
            'CALSCALE' => '?',
            'METHOD'   => '?',
        ];
 
    }

◆ validate()

Sabre\VObject\Component\VCalendar::validate ( $options = 0 )

Validates the node for correctness.

The following options are supported: Node::REPAIR - May attempt to automatically repair the problem. Node::PROFILE_CARDDAV - Validate the vCard for CardDAV purposes. Node::PROFILE_CALDAV - Validate the iCalendar for CalDAV purposes.

This method returns an array with detected problems. Every element has the following properties:

level - problem level.
message - A human-readable string describing the issue.
node - A reference to the problematic node.

The level means: 1 - The issue was repaired (only happens if REPAIR was turned on). 2 - A warning. 3 - An error.

Parameters

int $options

Returns: array

Reimplemented from Sabre\VObject\Component.

Definition at line 447 of file VCalendar.php.

                                    {
 
        $warnings = parent::validate($options);
 
        if ($ver = $this->VERSION) {
            if ((string)$ver !== '2.0') {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'Only iCalendar version 2.0 as defined in rfc5545 is supported.',
                    'node'    => $this,
                ];
            }
 
        }
 
        $uidList = [];
        $componentsFound = 0;
        $componentTypes = [];
 
        foreach ($this->children() as $child) {
            if ($child instanceof Component) {
                $componentsFound++;
 
                if (!in_array($child->name, ['VEVENT', 'VTODO', 'VJOURNAL'])) {
                    continue;
                }
                $componentTypes[] = $child->name;
 
                $uid = (string)$child->UID;
                $isMaster = isset($child->{'RECURRENCE-ID'}) ? 0 : 1;
                if (isset($uidList[$uid])) {
                    $uidList[$uid]['count']++;
                    if ($isMaster && $uidList[$uid]['hasMaster']) {
                        $warnings[] = [
                            'level'   => 3,
                            'message' => 'More than one master object was found for the object with UID ' . $uid,
                            'node'    => $this,
                        ];
                    }
                    $uidList[$uid]['hasMaster'] += $isMaster;
                } else {
                    $uidList[$uid] = [
                        'count'     => 1,
                        'hasMaster' => $isMaster,
                    ];
                }
 
            }
        }
 
        if ($componentsFound === 0) {
            $warnings[] = [
                'level'   => 3,
                'message' => 'An iCalendar object must have at least 1 component.',
                'node'    => $this,
            ];
        }
 
        if ($options & self::PROFILE_CALDAV) {
            if (count($uidList) > 1) {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'A calendar object on a CalDAV server may only have components with the same UID.',
                    'node'    => $this,
                ];
            }
            if (count($componentTypes) === 0) {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'A calendar object on a CalDAV server must have at least 1 component (VTODO, VEVENT, VJOURNAL).',
                    'node'    => $this,
                ];
            }
            if (count(array_unique($componentTypes)) > 1) {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'A calendar object on a CalDAV server may only have 1 type of component (VEVENT, VTODO or VJOURNAL).',
                    'node'    => $this,
                ];
            }
 
            if (isset($this->METHOD)) {
                $warnings[] = [
                    'level'   => 3,
                    'message' => 'A calendar object on a CalDAV server MUST NOT have a METHOD property.',
                    'node'    => $this,
                ];
            }
        }
 
        return $warnings;
 
    }

References PHPMailer\PHPMailer\$options, and $warnings.

Field Documentation

◆ $componentMap

Sabre\VObject\Component\VCalendar::$componentMap

static

Initial value:

= [
        'VCALENDAR'     => 'Sabre\\VObject\\Component\\VCalendar',
        'VALARM'        => 'Sabre\\VObject\\Component\\VAlarm',
        'VEVENT'        => 'Sabre\\VObject\\Component\\VEvent',
        'VFREEBUSY'     => 'Sabre\\VObject\\Component\\VFreeBusy',
        'VAVAILABILITY' => 'Sabre\\VObject\\Component\\VAvailability',
        'AVAILABLE'     => 'Sabre\\VObject\\Component\\Available',
        'VJOURNAL'      => 'Sabre\\VObject\\Component\\VJournal',
        'VTIMEZONE'     => 'Sabre\\VObject\\Component\\VTimeZone',
        'VTODO'         => 'Sabre\\VObject\\Component\\VTodo',
    ]

Definition at line 39 of file VCalendar.php.

Referenced by Sabre\VObject\Parser\MimeDir\parseDocument().

◆ $defaultName

Sabre\VObject\Component\VCalendar::$defaultName = 'VCALENDAR'

static

Definition at line 32 of file VCalendar.php.

◆ $propertyMap

Sabre\VObject\Component\VCalendar::$propertyMap

static

Definition at line 79 of file VCalendar.php.

◆ $valueMap

Sabre\VObject\Component\VCalendar::$valueMap

static

Initial value:

= [
        'BINARY'      => 'Sabre\\VObject\\Property\\Binary',
        'BOOLEAN'     => 'Sabre\\VObject\\Property\\Boolean',
        'CAL-ADDRESS' => 'Sabre\\VObject\\Property\\ICalendar\\CalAddress',
        'DATE'        => 'Sabre\\VObject\\Property\\ICalendar\\Date',
        'DATE-TIME'   => 'Sabre\\VObject\\Property\\ICalendar\\DateTime',
        'DURATION'    => 'Sabre\\VObject\\Property\\ICalendar\\Duration',
        'FLOAT'       => 'Sabre\\VObject\\Property\\FloatValue',
        'INTEGER'     => 'Sabre\\VObject\\Property\\IntegerValue',
        'PERIOD'      => 'Sabre\\VObject\\Property\\ICalendar\\Period',
        'RECUR'       => 'Sabre\\VObject\\Property\\ICalendar\\Recur',
        'TEXT'        => 'Sabre\\VObject\\Property\\Text',
        'TIME'        => 'Sabre\\VObject\\Property\\Time',
        'UNKNOWN'     => 'Sabre\\VObject\\Property\\Unknown', 
        'URI'         => 'Sabre\\VObject\\Property\\Uri',
        'UTC-OFFSET'  => 'Sabre\\VObject\\Property\\UtcOffset',
    ]

Definition at line 56 of file VCalendar.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/vobject/lib/Component/VCalendar.php

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ expand()

◆ getBaseComponent()

◆ getBaseComponents()

◆ getByUID()

◆ getDefaults()

◆ getDocumentType()

◆ getValidationRules()

◆ validate()

Field Documentation

◆ $componentMap

◆ $defaultName

◆ $propertyMap

◆ $valueMap