annotate plugins/libcalendaring/lib/Sabre/VObject/Component/VTodo.php @ 43:771f6803cc4b default tip

somehow lost the correctly updated metadata so e.g. 'mail' package wasn't being imported
author Charlie Root
date Sun, 26 Jan 2025 13:13:49 -0500
parents 888e774ee983
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
1 <?php
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
2
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
3 namespace Sabre\VObject\Component;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
4
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
5 use Sabre\VObject;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
6
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
7 /**
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
8 * VTodo component
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
9 *
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
10 * This component contains some additional functionality specific for VTODOs.
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
11 *
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
12 * @copyright Copyright (C) 2007-2013 fruux GmbH (https://fruux.com/).
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
13 * @author Evert Pot (http://evertpot.com/)
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
14 * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
15 */
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
16 class VTodo extends VObject\Component {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
17
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
18 /**
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
19 * Returns true or false depending on if the event falls in the specified
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
20 * time-range. This is used for filtering purposes.
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
21 *
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
22 * The rules used to determine if an event falls within the specified
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
23 * time-range is based on the CalDAV specification.
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
24 *
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
25 * @param DateTime $start
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
26 * @param DateTime $end
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
27 * @return bool
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
28 */
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
29 public function isInTimeRange(\DateTime $start, \DateTime $end) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
30
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
31 $dtstart = isset($this->DTSTART)?$this->DTSTART->getDateTime():null;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
32 $duration = isset($this->DURATION)?VObject\DateTimeParser::parseDuration($this->DURATION):null;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
33 $due = isset($this->DUE)?$this->DUE->getDateTime():null;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
34 $completed = isset($this->COMPLETED)?$this->COMPLETED->getDateTime():null;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
35 $created = isset($this->CREATED)?$this->CREATED->getDateTime():null;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
36
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
37 if ($dtstart) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
38 if ($duration) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
39 $effectiveEnd = clone $dtstart;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
40 $effectiveEnd->add($duration);
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
41 return $start <= $effectiveEnd && $end > $dtstart;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
42 } elseif ($due) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
43 return
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
44 ($start < $due || $start <= $dtstart) &&
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
45 ($end > $dtstart || $end >= $due);
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
46 } else {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
47 return $start <= $dtstart && $end > $dtstart;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
48 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
49 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
50 if ($due) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
51 return ($start < $due && $end >= $due);
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
52 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
53 if ($completed && $created) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
54 return
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
55 ($start <= $created || $start <= $completed) &&
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
56 ($end >= $created || $end >= $completed);
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
57 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
58 if ($completed) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
59 return ($start <= $completed && $end >= $completed);
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
60 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
61 if ($created) {
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
62 return ($end > $created);
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
63 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
64 return true;
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
65
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
66 }
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
67
888e774ee983 libcalendar plugin as distributed
Charlie Root
parents:
diff changeset
68 }