annotate vendor/sabre/vobject/lib/Property/ICalendar/Recur.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\Property\ICalendar;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
4
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
5 use
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
6 Sabre\VObject\Property,
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
7 Sabre\VObject\Parser\MimeDir;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
8
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
9 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
10 * Recur property
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
11 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
12 * This object represents RECUR properties.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
13 * These values are just used for RRULE and the now deprecated EXRULE.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
14 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
15 * The RRULE property may look something like this:
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
16 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
17 * RRULE:FREQ=MONTHLY;BYDAY=1,2,3;BYHOUR=5.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
18 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
19 * This property exposes this as a key=>value array that is accessible using
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
20 * getParts, and may be set using setParts.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
21 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
22 * @copyright Copyright (C) 2011-2015 fruux GmbH (https://fruux.com/).
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
23 * @author Evert Pot (http://evertpot.com/)
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
24 * @license http://sabre.io/license/ Modified BSD License
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
25 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
26 class Recur extends Property {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
27
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
28 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
29 * Updates the current value.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
30 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
31 * This may be either a single, or multiple strings in an array.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
32 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
33 * @param string|array $value
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
34 * @return void
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
35 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
36 public function setValue($value) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
37
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
38 // If we're getting the data from json, we'll be receiving an object
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
39 if ($value instanceof \StdClass) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
40 $value = (array)$value;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
41 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
42
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
43 if (is_array($value)) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
44 $newVal = array();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
45 foreach($value as $k=>$v) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
46
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
47 if (is_string($v)) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
48 $v = strtoupper($v);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
49
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
50 // The value had multiple sub-values
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
51 if (strpos($v,',')!==false) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
52 $v = explode(',', $v);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
53 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
54 } else {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
55 $v = array_map('strtoupper', $v);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
56 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
57
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
58 $newVal[strtoupper($k)] = $v;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
59 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
60 $this->value = $newVal;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
61 } elseif (is_string($value)) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
62 $this->value = self::stringToArray($value);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
63 } else {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
64 throw new \InvalidArgumentException('You must either pass a string, or a key=>value array');
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
65 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
66
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
67 }
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 * Returns the current value.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
71 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
72 * This method will always return a singular value. If this was a
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
73 * multi-value object, some decision will be made first on how to represent
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
74 * it as a string.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
75 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
76 * To get the correct multi-value version, use getParts.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
77 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
78 * @return string
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
79 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
80 public function getValue() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
81
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
82 $out = array();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
83 foreach($this->value as $key=>$value) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
84 $out[] = $key . '=' . (is_array($value)?implode(',', $value):$value);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
85 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
86 return strtoupper(implode(';',$out));
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
87
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
88 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
89
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
90 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
91 * Sets a multi-valued property.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
92 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
93 * @param array $parts
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
94 * @return void
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
95 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
96 public function setParts(array $parts) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
97
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
98 $this->setValue($parts);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
99
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
100 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
101
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
102 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
103 * Returns a multi-valued property.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
104 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
105 * This method always returns an array, if there was only a single value,
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
106 * it will still be wrapped in an array.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
107 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
108 * @return array
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
109 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
110 public function getParts() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
111
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
112 return $this->value;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
113
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
114 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
115
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
116 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
117 * Sets a raw value coming from a mimedir (iCalendar/vCard) file.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
118 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
119 * This has been 'unfolded', so only 1 line will be passed. Unescaping is
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
120 * not yet done, but parameters are not included.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
121 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
122 * @param string $val
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
123 * @return void
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
124 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
125 public function setRawMimeDirValue($val) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
126
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
127 $this->setValue($val);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
128
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
129 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
130
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
131 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
132 * Returns a raw mime-dir representation of the value.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
133 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
134 * @return string
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
135 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
136 public function getRawMimeDirValue() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
137
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
138 return $this->getValue();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
139
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
140 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
141
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
142 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
143 * Returns the type of value.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
144 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
145 * This corresponds to the VALUE= parameter. Every property also has a
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
146 * 'default' valueType.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
147 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
148 * @return string
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
149 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
150 public function getValueType() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
151
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
152 return "RECUR";
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
153
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
154 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
155
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
156 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
157 * Returns the value, in the format it should be encoded for json.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
158 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
159 * This method must always return an array.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
160 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
161 * @return array
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
162 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
163 public function getJsonValue() {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
164
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
165 $values = array();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
166 foreach($this->getParts() as $k=>$v) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
167 $values[strtolower($k)] = $v;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
168 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
169 return array($values);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
170
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
171 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
172
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
173 /**
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
174 * Parses an RRULE value string, and turns it into a struct-ish array.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
175 *
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
176 * @param string $value
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
177 * @return array
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
178 */
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
179 static function stringToArray($value) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
180
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
181 $value = strtoupper($value);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
182 $newValue = array();
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
183 foreach(explode(';', $value) as $part) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
184
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
185 // Skipping empty parts.
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
186 if (empty($part)) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
187 continue;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
188 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
189 list($partName, $partValue) = explode('=', $part);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
190
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
191 // The value itself had multiple values..
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
192 if (strpos($partValue,',')!==false) {
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
193 $partValue=explode(',', $partValue);
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
194 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
195 $newValue[$partName] = $partValue;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
196
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
197 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
198
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
199 return $newValue;
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
200
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
201 }
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
202
430dbd5346f7 vendor sabre as distributed
Charlie Root
parents:
diff changeset
203 }