forked from zendframework/zendframework
/
AbstractAtom.php
422 lines (400 loc) · 13 KB
/
AbstractAtom.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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Feed_Writer
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: AtomAbstract.php 22099 2010-05-04 18:51:58Z padraic $
*/
/**
* @namespace
*/
namespace Zend\Feed\Writer\Renderer\Feed;
use Zend\Feed\Writer\Renderer;
use Zend\Date;
use Zend\Feed\Writer;
/**
* @uses \Zend\Date\Date
* @uses \Zend\Feed\Exception
* @uses \Zend\Feed\Writer\Feed\Feed
* @uses \Zend\Feed\Writer\Renderer\Entry\Atom\Atom
* @uses \Zend\Feed\Writer\Renderer\RendererAbstract
* @uses \Zend\Feed\Writer\Renderer\RendererInterface
* @uses \Zend\Version
* @category Zend
* @package Zend_Feed_Writer
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class AbstractAtom extends Renderer\AbstractRenderer
{
/**
* Constructor
*
* @param Zend_Feed_Writer_Feed $container
* @return void
*/
public function __construct ($container)
{
parent::__construct($container);
}
/**
* Set feed language
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setLanguage(\DOMDocument $dom, \DOMElement $root)
{
if ($this->getDataContainer()->getLanguage()) {
$root->setAttribute('xml:lang', $this->getDataContainer()
->getLanguage());
}
}
/**
* Set feed title
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setTitle(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getTitle()) {
$message = 'Atom 1.0 feed elements MUST contain exactly one'
. ' atom:title element but a title has not been set';
$exception = new Writer\Exception($message);
if (!$this->_ignoreExceptions) {
throw $exception;
} else {
$this->_exceptions[] = $exception;
return;
}
}
$title = $dom->createElement('title');
$root->appendChild($title);
$title->setAttribute('type', 'text');
$text = $dom->createTextNode($this->getDataContainer()->getTitle());
$title->appendChild($text);
}
/**
* Set feed description
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setDescription(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getDescription()) {
return;
}
$subtitle = $dom->createElement('subtitle');
$root->appendChild($subtitle);
$subtitle->setAttribute('type', 'text');
$text = $dom->createTextNode($this->getDataContainer()->getDescription());
$subtitle->appendChild($text);
}
/**
* Set date feed was last modified
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setDateModified(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getDateModified()) {
$message = 'Atom 1.0 feed elements MUST contain exactly one'
. ' atom:updated element but a modification date has not been set';
$exception = new Writer\Exception($message);
if (!$this->_ignoreExceptions) {
throw $exception;
} else {
$this->_exceptions[] = $exception;
return;
}
}
$updated = $dom->createElement('updated');
$root->appendChild($updated);
$text = $dom->createTextNode(
$this->getDataContainer()->getDateModified()->get(Date\Date::ISO_8601)
);
$updated->appendChild($text);
}
/**
* Set feed generator string
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setGenerator(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getGenerator()) {
$this->getDataContainer()->setGenerator('Zend_Feed_Writer',
\Zend\Version::VERSION, 'http://framework.zend.com');
}
$gdata = $this->getDataContainer()->getGenerator();
$generator = $dom->createElement('generator');
$root->appendChild($generator);
$text = $dom->createTextNode($gdata['name']);
$generator->appendChild($text);
if (array_key_exists('uri', $gdata)) {
$generator->setAttribute('uri', $gdata['uri']);
}
if (array_key_exists('version', $gdata)) {
$generator->setAttribute('version', $gdata['version']);
}
}
/**
* Set link to feed
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setLink(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getLink()) {
return;
}
$link = $dom->createElement('link');
$root->appendChild($link);
$link->setAttribute('rel', 'alternate');
$link->setAttribute('type', 'text/html');
$link->setAttribute('href', $this->getDataContainer()->getLink());
}
/**
* Set feed links
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setFeedLinks(\DOMDocument $dom, \DOMElement $root)
{
$flinks = $this->getDataContainer()->getFeedLinks();
if(!$flinks || !array_key_exists('atom', $flinks)) {
$message = 'Atom 1.0 feed elements SHOULD contain one atom:link '
. 'element with a rel attribute value of "self". This is the '
. 'preferred URI for retrieving Atom Feed Documents representing '
. 'this Atom feed but a feed link has not been set';
$exception = new Writer\Exception($message);
if (!$this->_ignoreExceptions) {
throw $exception;
} else {
$this->_exceptions[] = $exception;
return;
}
}
foreach ($flinks as $type => $href) {
$mime = 'application/' . strtolower($type) . '+xml';
$flink = $dom->createElement('link');
$root->appendChild($flink);
$flink->setAttribute('rel', 'self');
$flink->setAttribute('type', $mime);
$flink->setAttribute('href', $href);
}
}
/**
* Set feed authors
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setAuthors(\DOMDocument $dom, \DOMElement $root)
{
$authors = $this->_container->getAuthors();
if (!$authors || empty($authors)) {
/**
* Technically we should defer an exception until we can check
* that all entries contain an author. If any entry is missing
* an author, then a missing feed author element is invalid
*/
return;
}
foreach ($authors as $data) {
$author = $this->_dom->createElement('author');
$name = $this->_dom->createElement('name');
$author->appendChild($name);
$root->appendChild($author);
$text = $dom->createTextNode($data['name']);
$name->appendChild($text);
if (array_key_exists('email', $data)) {
$email = $this->_dom->createElement('email');
$author->appendChild($email);
$text = $dom->createTextNode($data['email']);
$email->appendChild($text);
}
if (array_key_exists('uri', $data)) {
$uri = $this->_dom->createElement('uri');
$author->appendChild($uri);
$text = $dom->createTextNode($data['uri']);
$uri->appendChild($text);
}
}
}
/**
* Set feed identifier
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setId(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getId()
&& !$this->getDataContainer()->getLink()) {
$message = 'Atom 1.0 feed elements MUST contain exactly one '
. 'atom:id element, or as an alternative, we can use the same '
. 'value as atom:link however neither a suitable link nor an '
. 'id have been set';
$exception = new Writer\Exception($message);
if (!$this->_ignoreExceptions) {
throw $exception;
} else {
$this->_exceptions[] = $exception;
return;
}
}
if (!$this->getDataContainer()->getId()) {
$this->getDataContainer()->setId(
$this->getDataContainer()->getLink());
}
$id = $dom->createElement('id');
$root->appendChild($id);
$text = $dom->createTextNode($this->getDataContainer()->getId());
$id->appendChild($text);
}
/**
* Set feed copyright
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setCopyright(\DOMDocument $dom, \DOMElement $root)
{
$copyright = $this->getDataContainer()->getCopyright();
if (!$copyright) {
return;
}
$copy = $dom->createElement('rights');
$root->appendChild($copy);
$text = $dom->createTextNode($copyright);
$copy->appendChild($text);
}
/**
* Set feed level logo (image)
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setImage(\DOMDocument $dom, \DOMElement $root)
{
$image = $this->getDataContainer()->getImage();
if (!$image) {
return;
}
$img = $dom->createElement('logo');
$root->appendChild($img);
$text = $dom->createTextNode($image['uri']);
$img->appendChild($text);
}
/**
* Set date feed was created
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setDateCreated(\DOMDocument $dom, \DOMElement $root)
{
if(!$this->getDataContainer()->getDateCreated()) {
return;
}
if(!$this->getDataContainer()->getDateModified()) {
$this->getDataContainer()->setDateModified(
$this->getDataContainer()->getDateCreated()
);
}
}
/**
* Set base URL to feed links
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setBaseUrl(\DOMDocument $dom, \DOMElement $root)
{
$baseUrl = $this->getDataContainer()->getBaseUrl();
if (!$baseUrl) {
return;
}
$root->setAttribute('xml:base', $baseUrl);
}
/**
* Set hubs to which this feed pushes
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setHubs(\DOMDocument $dom, \DOMElement $root)
{
$hubs = $this->getDataContainer()->getHubs();
if (!$hubs) {
return;
}
foreach ($hubs as $hubUrl) {
$hub = $dom->createElement('link');
$hub->setAttribute('rel', 'hub');
$hub->setAttribute('href', $hubUrl);
$root->appendChild($hub);
}
}
/**
* Set feed cateories
*
* @param \DOMDocument $dom
* @param \DOMElement $root
* @return void
*/
protected function _setCategories(\DOMDocument $dom, \DOMElement $root)
{
$categories = $this->getDataContainer()->getCategories();
if (!$categories) {
return;
}
foreach ($categories as $cat) {
$category = $dom->createElement('category');
$category->setAttribute('term', $cat['term']);
if (isset($cat['label'])) {
$category->setAttribute('label', $cat['label']);
} else {
$category->setAttribute('label', $cat['term']);
}
if (isset($cat['scheme'])) {
$category->setAttribute('scheme', $cat['scheme']);
}
$root->appendChild($category);
}
}
}