Inheritance diagram for Sabre\VObject\Component\VAlarm:

Collaboration diagram for Sabre\VObject\Component\VAlarm:

Public Member Functions
	getEffectiveTriggerTime ()
	Returns a DateTime object when this alarm is going to trigger. More...

	isInTimeRange (DateTimeInterface $start, DateTimeInterface $end)
	Returns true or false depending on if the event falls in the specified time-range. More...

	getValidationRules ()

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...

Additional Inherited Members
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 Member Functions inherited from Sabre\VObject\Component
	getDefaults ()
	This method should return a list of default property values. More...

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

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

	$root

Detailed Description

VAlarm component.

This component contains some additional functionality specific for VALARMs.

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 19 of file VAlarm.php.

Member Function Documentation

◆ getEffectiveTriggerTime()

Sabre\VObject\Component\VAlarm::getEffectiveTriggerTime ( )

Returns a DateTime object when this alarm is going to trigger.

This ignores repeated alarm, only the first trigger is returned.

Returns: DateTimeImmutable

Definition at line 28 of file VAlarm.php.

                                       {
 
        $trigger = $this->TRIGGER;
        if (!isset($trigger['VALUE']) || strtoupper($trigger['VALUE']) === 'DURATION') {
            $triggerDuration = VObject\DateTimeParser::parseDuration($this->TRIGGER);
            $related = (isset($trigger['RELATED']) && strtoupper($trigger['RELATED']) == 'END') ? 'END' : 'START';
 
            $parentComponent = $this->parent;
            if ($related === 'START') {
 
                if ($parentComponent->name === 'VTODO') {
                    $propName = 'DUE';
                } else {
                    $propName = 'DTSTART';
                }
 
                $effectiveTrigger = $parentComponent->$propName->getDateTime();
                $effectiveTrigger = $effectiveTrigger->add($triggerDuration);
            } else {
                if ($parentComponent->name === 'VTODO') {
                    $endProp = 'DUE';
                } elseif ($parentComponent->name === 'VEVENT') {
                    $endProp = 'DTEND';
                } else {
                    throw new InvalidDataException('time-range filters on VALARM components are only supported when they are a child of VTODO or VEVENT');
                }
 
                if (isset($parentComponent->$endProp)) {
                    $effectiveTrigger = $parentComponent->$endProp->getDateTime();
                    $effectiveTrigger = $effectiveTrigger->add($triggerDuration);
                } elseif (isset($parentComponent->DURATION)) {
                    $effectiveTrigger = $parentComponent->DTSTART->getDateTime();
                    $duration = VObject\DateTimeParser::parseDuration($parentComponent->DURATION);
                    $effectiveTrigger = $effectiveTrigger->add($duration);
                    $effectiveTrigger = $effectiveTrigger->add($triggerDuration);
                } else {
                    $effectiveTrigger = $parentComponent->DTSTART->getDateTime();
                    $effectiveTrigger = $effectiveTrigger->add($triggerDuration);
                }
            }
        } else {
            $effectiveTrigger = $trigger->getDateTime();
        }
        return $effectiveTrigger;
 
    }

References Sabre\VObject\Node\$parent, and Sabre\VObject\DateTimeParser\parseDuration().

Referenced by Sabre\VObject\Component\VAlarm\isInTimeRange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidationRules()

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

Reimplemented from Sabre\VObject\Component.

Definition at line 128 of file VAlarm.php.

                                  {
 
        return [
            'ACTION'  => 1,
            'TRIGGER' => 1,
 
            'DURATION' => '?',
            'REPEAT'   => '?',
 
            'ATTACH' => '?',
        ];
 
    }

◆ isInTimeRange()

Sabre\VObject\Component\VAlarm::isInTimeRange	(	DateTimeInterface	$start,
		DateTimeInterface	$end
	)

Returns true or false depending on if the event falls in the specified time-range.

This is used for filtering purposes.

The rules used to determine if an event falls within the specified time-range is based on the CalDAV specification.

Parameters

DateTime	$start
DateTime	$end

Returns: bool

Definition at line 87 of file VAlarm.php.

                                                                             {
 
        $effectiveTrigger = $this->getEffectiveTriggerTime();
 
        if (isset($this->DURATION)) {
            $duration = VObject\DateTimeParser::parseDuration($this->DURATION);
            $repeat = (string)$this->REPEAT;
            if (!$repeat) {
                $repeat = 1;
            }
 
            $period = new \DatePeriod($effectiveTrigger, $duration, (int)$repeat);
 
            foreach ($period as $occurrence) {
 
                if ($start <= $occurrence && $end > $occurrence) {
                    return true;
                }
            }
            return false;
        } else {
            return ($start <= $effectiveTrigger && $end > $effectiveTrigger);
        }
 
    }

References $repeat, Sabre\VObject\Component\VAlarm\getEffectiveTriggerTime(), and Sabre\VObject\DateTimeParser\parseDuration().

Referenced by Sabre\VObject\Component\VAlarmTest\testInTimeRange().