This repository has been archived by the owner on Jan 30, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 42
/
Entry.php
387 lines (350 loc) · 10.9 KB
/
Entry.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Feed\Writer\Extension\ITunes;
use Zend\Feed\Uri;
use Zend\Feed\Writer;
use Zend\Stdlib\StringUtils;
use Zend\Stdlib\StringWrapper\StringWrapperInterface;
/**
*/
class Entry
{
/**
* Array of Feed data for rendering by Extension's renderers
*
* @var array
*/
protected $data = [];
/**
* Encoding of all text values
*
* @var string
*/
protected $encoding = 'UTF-8';
/**
* The used string wrapper supporting encoding
*
* @var StringWrapperInterface
*/
protected $stringWrapper;
public function __construct()
{
$this->stringWrapper = StringUtils::getWrapper($this->encoding);
}
/**
* Set feed encoding
*
* @param string $enc
* @return Entry
*/
public function setEncoding($enc)
{
$this->stringWrapper = StringUtils::getWrapper($enc);
$this->encoding = $enc;
return $this;
}
/**
* Get feed encoding
*
* @return string
*/
public function getEncoding()
{
return $this->encoding;
}
/**
* Set a block value of "yes" or "no". You may also set an empty string.
*
* @param string
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesBlock($value)
{
if (! ctype_alpha($value) && strlen($value) > 0) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "block" may only'
. ' contain alphabetic characters');
}
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "block" may only'
. ' contain a maximum of 255 characters');
}
$this->data['block'] = $value;
}
/**
* Add authors to itunes entry
*
* @param array $values
* @return Entry
*/
public function addItunesAuthors(array $values)
{
foreach ($values as $value) {
$this->addItunesAuthor($value);
}
return $this;
}
/**
* Add author to itunes entry
*
* @param string $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function addItunesAuthor($value)
{
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: any "author" may only'
. ' contain a maximum of 255 characters each');
}
if (! isset($this->data['authors'])) {
$this->data['authors'] = [];
}
$this->data['authors'][] = $value;
return $this;
}
/**
* Set duration
*
* @param int $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesDuration($value)
{
$value = (string) $value;
if (! ctype_digit($value)
&& ! preg_match("/^\d+:[0-5]{1}[0-9]{1}$/", $value)
&& ! preg_match("/^\d+:[0-5]{1}[0-9]{1}:[0-5]{1}[0-9]{1}$/", $value)
) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "duration" may only'
. ' be of a specified [[HH:]MM:]SS format');
}
$this->data['duration'] = $value;
return $this;
}
/**
* Set "explicit" flag
*
* @param bool $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesExplicit($value)
{
if (! in_array($value, ['yes', 'no', 'clean'])) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "explicit" may only'
. ' be one of "yes", "no" or "clean"');
}
$this->data['explicit'] = $value;
return $this;
}
/**
* Set keywords
*
* @deprecated since 2.10.0; itunes:keywords is no longer part of the
* iTunes podcast RSS specification.
* @param array $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesKeywords(array $value)
{
trigger_error(
'itunes:keywords has been deprecated in the iTunes podcast RSS specification,'
. ' and should not be relied on.',
\E_USER_DEPRECATED
);
if (count($value) > 12) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "keywords" may only'
. ' contain a maximum of 12 terms');
}
$concat = implode(',', $value);
if ($this->stringWrapper->strlen($concat) > 255) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "keywords" may only'
. ' have a concatenated length of 255 chars where terms are delimited'
. ' by a comma');
}
$this->data['keywords'] = $value;
return $this;
}
/**
* Set title
*
* @param string $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesTitle($value)
{
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "title" may only'
. ' contain a maximum of 255 characters');
}
$this->data['title'] = $value;
return $this;
}
/**
* Set subtitle
*
* @param string $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesSubtitle($value)
{
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "subtitle" may only'
. ' contain a maximum of 255 characters');
}
$this->data['subtitle'] = $value;
return $this;
}
/**
* Set summary
*
* @param string $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesSummary($value)
{
if ($this->stringWrapper->strlen($value) > 4000) {
throw new Writer\Exception\InvalidArgumentException('invalid parameter: "summary" may only'
. ' contain a maximum of 4000 characters');
}
$this->data['summary'] = $value;
return $this;
}
/**
* Set entry image (icon)
*
* @param string $value
* @return Entry
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesImage($value)
{
if (! is_string($value) || ! Uri::factory($value)->isValid()) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "image" may only be a valid URI/IRI'
);
}
if (! in_array(substr($value, -3), ['jpg', 'png'])) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "image" may only use file extension "jpg"'
. ' or "png" which must be the last three characters of the URI'
. ' (i.e. no query string or fragment)'
);
}
$this->data['image'] = $value;
return $this;
}
/**
* Set the episode number
*
* @param int $number
* @return self
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesEpisode($number)
{
if (! is_numeric($number) || is_float($number)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "number" may only be an integer; received %s',
is_object($number) ? get_class($number) : gettype($number)
));
}
$this->data['episode'] = (int) $number;
return $this;
}
/**
* Set the episode type
*
* @param string $type One of "full", "trailer", or "bonus".
* @return self
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesEpisodeType($type)
{
$validTypes = ['full', 'trailer', 'bonus'];
if (! in_array($type, $validTypes, true)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "episodeType" MUST be one of the strings [%s]; received %s',
implode(', ', $validTypes),
is_object($type) ? get_class($type) : var_export($type, true)
));
}
$this->data['episodeType'] = $type;
return $this;
}
/**
* Set the status of closed captioning
*
* @param bool $status
* @return self
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesIsClosedCaptioned($status)
{
if (! is_bool($status)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "isClosedCaptioned" MUST be a boolean; received %s',
is_object($status) ? get_class($status) : var_export($status, true)
));
}
if (! $status) {
return $this;
}
$this->data['isClosedCaptioned'] = true;
return $this;
}
/**
* Set the season number to which the episode belongs
*
* @param int $number
* @return self
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesSeason($number)
{
if (! is_numeric($number) || is_float($number)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "season" may only be an integer; received %s',
is_object($number) ? get_class($number) : gettype($number)
));
}
$this->data['season'] = (int) $number;
return $this;
}
/**
* Overloading to itunes specific setters
*
* @param string $method
* @param array $params
* @throws Writer\Exception\BadMethodCallException
* @return mixed
*/
public function __call($method, array $params)
{
$point = lcfirst(substr($method, 9));
if (! method_exists($this, 'setItunes' . ucfirst($point))
&& ! method_exists($this, 'addItunes' . ucfirst($point))
) {
throw new Writer\Exception\BadMethodCallException(
'invalid method: ' . $method
);
}
if (! array_key_exists($point, $this->data)
|| empty($this->data[$point])
) {
return;
}
return $this->data[$point];
}
}