Inheritance diagram for Sabre\VObject\Component\VTodo:

Collaboration diagram for Sabre\VObject\Component\VTodo:

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

	getValidationRules ()

	validate ($options=0)
	Validates the node for correctness. 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...

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

VTodo component.

This component contains some additional functionality specific for VTODOs.

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 17 of file VTodo.php.

Member Function Documentation

◆ getDefaults()

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

protected

This method should return a list of default property values.

Returns: array

Reimplemented from Sabre\VObject\Component.

Definition at line 184 of file VTodo.php.

                                     {
 
        return [
            'UID'     => 'sabre-vobject-' . VObject\UUIDUtil::getUUID(),
            'DTSTAMP' => date('Ymd\\THis\\Z'),
        ];
 
    }

References Sabre\VObject\UUIDUtil\getUUID().

Here is the call graph for this function:

◆ getValidationRules()

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

Reimplemented from Sabre\VObject\Component.

Definition at line 84 of file VTodo.php.

                                  {
 
        return [
            'UID'     => 1,
            'DTSTAMP' => 1,
 
            'CLASS'         => '?',
            'COMPLETED'     => '?',
            'CREATED'       => '?',
            'DESCRIPTION'   => '?',
            'DTSTART'       => '?',
            'GEO'           => '?',
            'LAST-MODIFIED' => '?',
            'LOCATION'      => '?',
            'ORGANIZER'     => '?',
            'PERCENT'       => '?',
            'PRIORITY'      => '?',
            'RECURRENCE-ID' => '?',
            'SEQUENCE'      => '?',
            'STATUS'        => '?',
            'SUMMARY'       => '?',
            'URL'           => '?',
 
            'RRULE'    => '?',
            'DUE'      => '?',
            'DURATION' => '?',
 
            'ATTACH'         => '*',
            'ATTENDEE'       => '*',
            'CATEGORIES'     => '*',
            'COMMENT'        => '*',
            'CONTACT'        => '*',
            'EXDATE'         => '*',
            'REQUEST-STATUS' => '*',
            'RELATED-TO'     => '*',
            'RESOURCES'      => '*',
            'RDATE'          => '*',
        ];
 
    }

◆ isInTimeRange()

Sabre\VObject\Component\VTodo::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

DateTimeInterface	$start
DateTimeInterface	$end

Returns: bool

Definition at line 31 of file VTodo.php.

                                                                             {
 
        $dtstart = isset($this->DTSTART) ? $this->DTSTART->getDateTime() : null;
        $duration = isset($this->DURATION) ? VObject\DateTimeParser::parseDuration($this->DURATION) : null;
        $due = isset($this->DUE) ? $this->DUE->getDateTime() : null;
        $completed = isset($this->COMPLETED) ? $this->COMPLETED->getDateTime() : null;
        $created = isset($this->CREATED) ? $this->CREATED->getDateTime() : null;
 
        if ($dtstart) {
            if ($duration) {
                $effectiveEnd = $dtstart->add($duration);
                return $start <= $effectiveEnd && $end > $dtstart;
            } elseif ($due) {
                return
                    ($start < $due || $start <= $dtstart) &&
                    ($end > $dtstart || $end >= $due);
            } else {
                return $start <= $dtstart && $end > $dtstart;
            }
        }
        if ($due) {
            return ($start < $due && $end >= $due);
        }
        if ($completed && $created) {
            return
                ($start <= $created || $start <= $completed) &&
                ($end >= $created || $end >= $completed);
        }
        if ($completed) {
            return ($start <= $completed && $end >= $completed);
        }
        if ($created) {
            return ($end > $created);
        }
        return true;
 
    }

References $end, $start, COMPLETED, and Sabre\VObject\DateTimeParser\parseDuration().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

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

Validates the node for correctness.

The following options are supported: Node::REPAIR - May attempt to automatically repair the problem.

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 - An inconsequential issue 3 - A severe issue.

Parameters

int $options

Returns: array

Reimplemented from Sabre\VObject\Component.

Definition at line 147 of file VTodo.php.

                                    {
 
        $result = parent::validate($options);
        if (isset($this->DUE) && isset($this->DTSTART)) {
 
            $due = $this->DUE;
            $dtStart = $this->DTSTART;
 
            if ($due->getValueType() !== $dtStart->getValueType()) {
 
                $result[] = [
                    'level'   => 3,
                    'message' => 'The value type (DATE or DATE-TIME) must be identical for DUE and DTSTART',
                    'node'    => $due,
                ];
 
            } elseif ($due->getDateTime() < $dtStart->getDateTime()) {
 
                $result[] = [
                    'level'   => 3,
                    'message' => 'DUE must occur after DTSTART',
                    'node'    => $due,
                ];
 
            }
 
        }
 
        return $result;
 
    }

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

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDefaults()

◆ getValidationRules()

◆ isInTimeRange()

◆ validate()