annotate vendor/sabre/vobject/lib/Component/VEvent.php @ 7:430dbd5346f7

vendor sabre as distributed
author Charlie Root
date Sat, 13 Jan 2018 09:06:10 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
1 <?php
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
2
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
3 namespace Sabre\VObject\Component;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
4
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
5 use Sabre\VObject;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
6 use Sabre\VObject\Recur\EventIterator;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
7
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
8 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
9 * VEvent component
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
10 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
11 * This component contains some additional functionality specific for VEVENT's.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
12 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
13 * @copyright Copyright (C) 2011-2015 fruux GmbH (https://fruux.com/).
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
14 * @author Evert Pot (http://evertpot.com/)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
15 * @license http://sabre.io/license/ Modified BSD License
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
16 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
17 class VEvent extends VObject\Component {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
18
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
19 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
20 * Returns true or false depending on if the event falls in the specified
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
21 * time-range. This is used for filtering purposes.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
22 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
23 * The rules used to determine if an event falls within the specified
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
24 * time-range is based on the CalDAV specification.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
25 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
26 * @param \DateTime $start
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
27 * @param \DateTime $end
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
28 * @return bool
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
29 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
30 public function isInTimeRange(\DateTime $start, \DateTime $end) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
31
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
32 if ($this->RRULE) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
33 $it = new EventIterator($this);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
34 $it->fastForward($start);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
35
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
36 // We fast-forwarded to a spot where the end-time of the
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
37 // recurrence instance exceeded the start of the requested
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
38 // time-range.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
39 //
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
40 // If the starttime of the recurrence did not exceed the
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
41 // end of the time range as well, we have a match.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
42 return ($it->getDTStart() < $end && $it->getDTEnd() > $start);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
43
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
44 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
45
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
46 $effectiveStart = $this->DTSTART->getDateTime();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
47 if (isset($this->DTEND)) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
48
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
49 // The DTEND property is considered non inclusive. So for a 3 day
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
50 // event in july, dtstart and dtend would have to be July 1st and
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
51 // July 4th respectively.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
52 //
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
53 // See:
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
54 // http://tools.ietf.org/html/rfc5545#page-54
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
55 $effectiveEnd = $this->DTEND->getDateTime();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
56
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
57 } elseif (isset($this->DURATION)) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
58 $effectiveEnd = clone $effectiveStart;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
59 $effectiveEnd->add(VObject\DateTimeParser::parseDuration($this->DURATION));
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
60 } elseif (!$this->DTSTART->hasTime()) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
61 $effectiveEnd = clone $effectiveStart;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
62 $effectiveEnd->modify('+1 day');
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
63 } else {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
64 $effectiveEnd = clone $effectiveStart;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
65 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
66 return (
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
67 ($start <= $effectiveEnd) && ($end > $effectiveStart)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
68 );
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
69
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
70 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
71
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
72 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
73 * This method should return a list of default property values.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
74 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
75 * @return array
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
76 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
77 protected function getDefaults() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
78
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
79 return array(
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
80 'UID' => 'sabre-vobject-' . VObject\UUIDUtil::getUUID(),
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
81 'DTSTAMP' => date('Ymd\\THis\\Z'),
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
82 );
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
83
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
84 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
85
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
86
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
87 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
88 * A simple list of validation rules.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
89 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
90 * This is simply a list of properties, and how many times they either
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
91 * must or must not appear.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
92 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
93 * Possible values per property:
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
94 * * 0 - Must not appear.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
95 * * 1 - Must appear exactly once.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
96 * * + - Must appear at least once.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
97 * * * - Can appear any number of times.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
98 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
99 * @var array
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
100 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
101 public function getValidationRules() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
102
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
103 $hasMethod = isset($this->parent->METHOD);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
104 return array(
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
105 'UID' => 1,
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
106 'DTSTAMP' => 1,
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
107 'DTSTART' => $hasMethod?'?':'1',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
108 'CLASS' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
109 'CREATED' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
110 'DESCRIPTION' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
111 'GEO' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
112 'LAST-MODIFICATION' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
113 'LOCATION' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
114 'ORGANIZER' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
115 'PRIORITY' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
116 'SEQUENCE' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
117 'STATUS' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
118 'SUMMARY' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
119 'TRANSP' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
120 'URL' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
121 'RECURRENCE-ID' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
122 'RRULE' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
123 'DTEND' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
124 'DURATION' => '?',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
125
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
126 'ATTACH' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
127 'ATTENDEE' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
128 'CATEGORIES' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
129 'COMMENT' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
130 'CONTACT' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
131 'EXDATE' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
132 'REQUEST-STATUS' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
133 'RELATED-TO' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
134 'RESOURCES' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
135 'RDATE' => '*',
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
136 );
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
137
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
138 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
139
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
140 }