Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@0
|
3 * Zend Framework (http://framework.zend.com/)
|
Chris@0
|
4 *
|
Chris@0
|
5 * @link http://github.com/zendframework/zf2 for the canonical source repository
|
Chris@0
|
6 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
|
Chris@0
|
7 * @license http://framework.zend.com/license/new-bsd New BSD License
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@0
|
10 namespace Zend\Feed\Writer\Renderer\Feed;
|
Chris@0
|
11
|
Chris@0
|
12 use DateTime;
|
Chris@0
|
13 use DOMDocument;
|
Chris@0
|
14 use DOMElement;
|
Chris@0
|
15 use Zend\Feed\Writer;
|
Chris@0
|
16 use Zend\Feed\Writer\Renderer;
|
Chris@0
|
17 use Zend\Feed\Writer\Version;
|
Chris@0
|
18
|
Chris@0
|
19 /**
|
Chris@0
|
20 */
|
Chris@0
|
21 class AbstractAtom extends Renderer\AbstractRenderer
|
Chris@0
|
22 {
|
Chris@0
|
23 /**
|
Chris@0
|
24 * Constructor
|
Chris@0
|
25 *
|
Chris@0
|
26 * @param Writer\AbstractFeed $container
|
Chris@0
|
27 */
|
Chris@0
|
28 public function __construct($container)
|
Chris@0
|
29 {
|
Chris@0
|
30 parent::__construct($container);
|
Chris@0
|
31 }
|
Chris@0
|
32
|
Chris@0
|
33 /**
|
Chris@0
|
34 * Set feed language
|
Chris@0
|
35 *
|
Chris@0
|
36 * @param DOMDocument $dom
|
Chris@0
|
37 * @param DOMElement $root
|
Chris@0
|
38 * @return void
|
Chris@0
|
39 */
|
Chris@12
|
40 // @codingStandardsIgnoreStart
|
Chris@0
|
41 protected function _setLanguage(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
42 {
|
Chris@12
|
43 // @codingStandardsIgnoreEnd
|
Chris@0
|
44 if ($this->getDataContainer()->getLanguage()) {
|
Chris@0
|
45 $root->setAttribute('xml:lang', $this->getDataContainer()
|
Chris@0
|
46 ->getLanguage());
|
Chris@0
|
47 }
|
Chris@0
|
48 }
|
Chris@0
|
49
|
Chris@0
|
50 /**
|
Chris@0
|
51 * Set feed title
|
Chris@0
|
52 *
|
Chris@0
|
53 * @param DOMDocument $dom
|
Chris@0
|
54 * @param DOMElement $root
|
Chris@0
|
55 * @return void
|
Chris@0
|
56 * @throws Writer\Exception\InvalidArgumentException
|
Chris@0
|
57 */
|
Chris@12
|
58 // @codingStandardsIgnoreStart
|
Chris@0
|
59 protected function _setTitle(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
60 {
|
Chris@12
|
61 // @codingStandardsIgnoreEnd
|
Chris@12
|
62 if (! $this->getDataContainer()->getTitle()) {
|
Chris@0
|
63 $message = 'Atom 1.0 feed elements MUST contain exactly one'
|
Chris@0
|
64 . ' atom:title element but a title has not been set';
|
Chris@0
|
65 $exception = new Writer\Exception\InvalidArgumentException($message);
|
Chris@12
|
66 if (! $this->ignoreExceptions) {
|
Chris@0
|
67 throw $exception;
|
Chris@0
|
68 } else {
|
Chris@0
|
69 $this->exceptions[] = $exception;
|
Chris@0
|
70 return;
|
Chris@0
|
71 }
|
Chris@0
|
72 }
|
Chris@0
|
73
|
Chris@0
|
74 $title = $dom->createElement('title');
|
Chris@0
|
75 $root->appendChild($title);
|
Chris@0
|
76 $title->setAttribute('type', 'text');
|
Chris@0
|
77 $text = $dom->createTextNode($this->getDataContainer()->getTitle());
|
Chris@0
|
78 $title->appendChild($text);
|
Chris@0
|
79 }
|
Chris@0
|
80
|
Chris@0
|
81 /**
|
Chris@0
|
82 * Set feed description
|
Chris@0
|
83 *
|
Chris@0
|
84 * @param DOMDocument $dom
|
Chris@0
|
85 * @param DOMElement $root
|
Chris@0
|
86 * @return void
|
Chris@0
|
87 */
|
Chris@12
|
88 // @codingStandardsIgnoreStart
|
Chris@0
|
89 protected function _setDescription(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
90 {
|
Chris@12
|
91 // @codingStandardsIgnoreEnd
|
Chris@12
|
92 if (! $this->getDataContainer()->getDescription()) {
|
Chris@0
|
93 return;
|
Chris@0
|
94 }
|
Chris@0
|
95 $subtitle = $dom->createElement('subtitle');
|
Chris@0
|
96 $root->appendChild($subtitle);
|
Chris@0
|
97 $subtitle->setAttribute('type', 'text');
|
Chris@0
|
98 $text = $dom->createTextNode($this->getDataContainer()->getDescription());
|
Chris@0
|
99 $subtitle->appendChild($text);
|
Chris@0
|
100 }
|
Chris@0
|
101
|
Chris@0
|
102 /**
|
Chris@0
|
103 * Set date feed was last modified
|
Chris@0
|
104 *
|
Chris@0
|
105 * @param DOMDocument $dom
|
Chris@0
|
106 * @param DOMElement $root
|
Chris@0
|
107 * @return void
|
Chris@0
|
108 * @throws Writer\Exception\InvalidArgumentException
|
Chris@0
|
109 */
|
Chris@12
|
110 // @codingStandardsIgnoreStart
|
Chris@0
|
111 protected function _setDateModified(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
112 {
|
Chris@12
|
113 // @codingStandardsIgnoreEnd
|
Chris@12
|
114 if (! $this->getDataContainer()->getDateModified()) {
|
Chris@0
|
115 $message = 'Atom 1.0 feed elements MUST contain exactly one'
|
Chris@0
|
116 . ' atom:updated element but a modification date has not been set';
|
Chris@0
|
117 $exception = new Writer\Exception\InvalidArgumentException($message);
|
Chris@12
|
118 if (! $this->ignoreExceptions) {
|
Chris@0
|
119 throw $exception;
|
Chris@0
|
120 } else {
|
Chris@0
|
121 $this->exceptions[] = $exception;
|
Chris@0
|
122 return;
|
Chris@0
|
123 }
|
Chris@0
|
124 }
|
Chris@0
|
125
|
Chris@0
|
126 $updated = $dom->createElement('updated');
|
Chris@0
|
127 $root->appendChild($updated);
|
Chris@0
|
128 $text = $dom->createTextNode(
|
Chris@0
|
129 $this->getDataContainer()->getDateModified()->format(DateTime::ATOM)
|
Chris@0
|
130 );
|
Chris@0
|
131 $updated->appendChild($text);
|
Chris@0
|
132 }
|
Chris@0
|
133
|
Chris@0
|
134 /**
|
Chris@0
|
135 * Set feed generator string
|
Chris@0
|
136 *
|
Chris@0
|
137 * @param DOMDocument $dom
|
Chris@0
|
138 * @param DOMElement $root
|
Chris@0
|
139 * @return void
|
Chris@0
|
140 */
|
Chris@12
|
141 // @codingStandardsIgnoreStart
|
Chris@0
|
142 protected function _setGenerator(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
143 {
|
Chris@12
|
144 // @codingStandardsIgnoreEnd
|
Chris@12
|
145 if (! $this->getDataContainer()->getGenerator()) {
|
Chris@12
|
146 $this->getDataContainer()->setGenerator(
|
Chris@12
|
147 'Zend_Feed_Writer',
|
Chris@12
|
148 Version::VERSION,
|
Chris@12
|
149 'http://framework.zend.com'
|
Chris@12
|
150 );
|
Chris@0
|
151 }
|
Chris@0
|
152
|
Chris@0
|
153 $gdata = $this->getDataContainer()->getGenerator();
|
Chris@0
|
154 $generator = $dom->createElement('generator');
|
Chris@0
|
155 $root->appendChild($generator);
|
Chris@0
|
156 $text = $dom->createTextNode($gdata['name']);
|
Chris@0
|
157 $generator->appendChild($text);
|
Chris@0
|
158 if (array_key_exists('uri', $gdata)) {
|
Chris@0
|
159 $generator->setAttribute('uri', $gdata['uri']);
|
Chris@0
|
160 }
|
Chris@0
|
161 if (array_key_exists('version', $gdata)) {
|
Chris@0
|
162 $generator->setAttribute('version', $gdata['version']);
|
Chris@0
|
163 }
|
Chris@0
|
164 }
|
Chris@0
|
165
|
Chris@0
|
166 /**
|
Chris@0
|
167 * Set link to feed
|
Chris@0
|
168 *
|
Chris@0
|
169 * @param DOMDocument $dom
|
Chris@0
|
170 * @param DOMElement $root
|
Chris@0
|
171 * @return void
|
Chris@0
|
172 */
|
Chris@12
|
173 // @codingStandardsIgnoreStart
|
Chris@0
|
174 protected function _setLink(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
175 {
|
Chris@12
|
176 // @codingStandardsIgnoreEnd
|
Chris@12
|
177 if (! $this->getDataContainer()->getLink()) {
|
Chris@0
|
178 return;
|
Chris@0
|
179 }
|
Chris@0
|
180 $link = $dom->createElement('link');
|
Chris@0
|
181 $root->appendChild($link);
|
Chris@0
|
182 $link->setAttribute('rel', 'alternate');
|
Chris@0
|
183 $link->setAttribute('type', 'text/html');
|
Chris@0
|
184 $link->setAttribute('href', $this->getDataContainer()->getLink());
|
Chris@0
|
185 }
|
Chris@0
|
186
|
Chris@0
|
187 /**
|
Chris@0
|
188 * Set feed links
|
Chris@0
|
189 *
|
Chris@0
|
190 * @param DOMDocument $dom
|
Chris@0
|
191 * @param DOMElement $root
|
Chris@0
|
192 * @return void
|
Chris@0
|
193 * @throws Writer\Exception\InvalidArgumentException
|
Chris@0
|
194 */
|
Chris@12
|
195 // @codingStandardsIgnoreStart
|
Chris@0
|
196 protected function _setFeedLinks(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
197 {
|
Chris@12
|
198 // @codingStandardsIgnoreEnd
|
Chris@0
|
199 $flinks = $this->getDataContainer()->getFeedLinks();
|
Chris@12
|
200 if (! $flinks || ! array_key_exists('atom', $flinks)) {
|
Chris@0
|
201 $message = 'Atom 1.0 feed elements SHOULD contain one atom:link '
|
Chris@0
|
202 . 'element with a rel attribute value of "self". This is the '
|
Chris@0
|
203 . 'preferred URI for retrieving Atom Feed Documents representing '
|
Chris@0
|
204 . 'this Atom feed but a feed link has not been set';
|
Chris@0
|
205 $exception = new Writer\Exception\InvalidArgumentException($message);
|
Chris@12
|
206 if (! $this->ignoreExceptions) {
|
Chris@0
|
207 throw $exception;
|
Chris@0
|
208 } else {
|
Chris@0
|
209 $this->exceptions[] = $exception;
|
Chris@0
|
210 return;
|
Chris@0
|
211 }
|
Chris@0
|
212 }
|
Chris@0
|
213
|
Chris@0
|
214 foreach ($flinks as $type => $href) {
|
Chris@0
|
215 $mime = 'application/' . strtolower($type) . '+xml';
|
Chris@0
|
216 $flink = $dom->createElement('link');
|
Chris@0
|
217 $root->appendChild($flink);
|
Chris@0
|
218 $flink->setAttribute('rel', 'self');
|
Chris@0
|
219 $flink->setAttribute('type', $mime);
|
Chris@0
|
220 $flink->setAttribute('href', $href);
|
Chris@0
|
221 }
|
Chris@0
|
222 }
|
Chris@0
|
223
|
Chris@0
|
224 /**
|
Chris@0
|
225 * Set feed authors
|
Chris@0
|
226 *
|
Chris@0
|
227 * @param DOMDocument $dom
|
Chris@0
|
228 * @param DOMElement $root
|
Chris@0
|
229 * @return void
|
Chris@0
|
230 */
|
Chris@12
|
231 // @codingStandardsIgnoreStart
|
Chris@0
|
232 protected function _setAuthors(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
233 {
|
Chris@12
|
234 // @codingStandardsIgnoreEnd
|
Chris@0
|
235 $authors = $this->container->getAuthors();
|
Chris@12
|
236 if (! $authors || empty($authors)) {
|
Chris@0
|
237 /**
|
Chris@0
|
238 * Technically we should defer an exception until we can check
|
Chris@0
|
239 * that all entries contain an author. If any entry is missing
|
Chris@0
|
240 * an author, then a missing feed author element is invalid
|
Chris@0
|
241 */
|
Chris@0
|
242 return;
|
Chris@0
|
243 }
|
Chris@0
|
244 foreach ($authors as $data) {
|
Chris@0
|
245 $author = $this->dom->createElement('author');
|
Chris@0
|
246 $name = $this->dom->createElement('name');
|
Chris@0
|
247 $author->appendChild($name);
|
Chris@0
|
248 $root->appendChild($author);
|
Chris@0
|
249 $text = $dom->createTextNode($data['name']);
|
Chris@0
|
250 $name->appendChild($text);
|
Chris@0
|
251 if (array_key_exists('email', $data)) {
|
Chris@0
|
252 $email = $this->dom->createElement('email');
|
Chris@0
|
253 $author->appendChild($email);
|
Chris@0
|
254 $text = $dom->createTextNode($data['email']);
|
Chris@0
|
255 $email->appendChild($text);
|
Chris@0
|
256 }
|
Chris@0
|
257 if (array_key_exists('uri', $data)) {
|
Chris@0
|
258 $uri = $this->dom->createElement('uri');
|
Chris@0
|
259 $author->appendChild($uri);
|
Chris@0
|
260 $text = $dom->createTextNode($data['uri']);
|
Chris@0
|
261 $uri->appendChild($text);
|
Chris@0
|
262 }
|
Chris@0
|
263 }
|
Chris@0
|
264 }
|
Chris@0
|
265
|
Chris@0
|
266 /**
|
Chris@0
|
267 * Set feed identifier
|
Chris@0
|
268 *
|
Chris@0
|
269 * @param DOMDocument $dom
|
Chris@0
|
270 * @param DOMElement $root
|
Chris@0
|
271 * @return void
|
Chris@0
|
272 * @throws Writer\Exception\InvalidArgumentException
|
Chris@0
|
273 */
|
Chris@12
|
274 // @codingStandardsIgnoreStart
|
Chris@0
|
275 protected function _setId(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
276 {
|
Chris@12
|
277 // @codingStandardsIgnoreEnd
|
Chris@12
|
278 if (! $this->getDataContainer()->getId()
|
Chris@12
|
279 && ! $this->getDataContainer()->getLink()) {
|
Chris@0
|
280 $message = 'Atom 1.0 feed elements MUST contain exactly one '
|
Chris@0
|
281 . 'atom:id element, or as an alternative, we can use the same '
|
Chris@0
|
282 . 'value as atom:link however neither a suitable link nor an '
|
Chris@0
|
283 . 'id have been set';
|
Chris@0
|
284 $exception = new Writer\Exception\InvalidArgumentException($message);
|
Chris@12
|
285 if (! $this->ignoreExceptions) {
|
Chris@0
|
286 throw $exception;
|
Chris@0
|
287 } else {
|
Chris@0
|
288 $this->exceptions[] = $exception;
|
Chris@0
|
289 return;
|
Chris@0
|
290 }
|
Chris@0
|
291 }
|
Chris@0
|
292
|
Chris@12
|
293 if (! $this->getDataContainer()->getId()) {
|
Chris@0
|
294 $this->getDataContainer()->setId(
|
Chris@12
|
295 $this->getDataContainer()->getLink()
|
Chris@12
|
296 );
|
Chris@0
|
297 }
|
Chris@0
|
298 $id = $dom->createElement('id');
|
Chris@0
|
299 $root->appendChild($id);
|
Chris@0
|
300 $text = $dom->createTextNode($this->getDataContainer()->getId());
|
Chris@0
|
301 $id->appendChild($text);
|
Chris@0
|
302 }
|
Chris@0
|
303
|
Chris@0
|
304 /**
|
Chris@0
|
305 * Set feed copyright
|
Chris@0
|
306 *
|
Chris@0
|
307 * @param DOMDocument $dom
|
Chris@0
|
308 * @param DOMElement $root
|
Chris@0
|
309 * @return void
|
Chris@0
|
310 */
|
Chris@12
|
311 // @codingStandardsIgnoreStart
|
Chris@0
|
312 protected function _setCopyright(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
313 {
|
Chris@12
|
314 // @codingStandardsIgnoreEnd
|
Chris@0
|
315 $copyright = $this->getDataContainer()->getCopyright();
|
Chris@12
|
316 if (! $copyright) {
|
Chris@0
|
317 return;
|
Chris@0
|
318 }
|
Chris@0
|
319 $copy = $dom->createElement('rights');
|
Chris@0
|
320 $root->appendChild($copy);
|
Chris@0
|
321 $text = $dom->createTextNode($copyright);
|
Chris@0
|
322 $copy->appendChild($text);
|
Chris@0
|
323 }
|
Chris@0
|
324
|
Chris@0
|
325 /**
|
Chris@0
|
326 * Set feed level logo (image)
|
Chris@0
|
327 *
|
Chris@0
|
328 * @param DOMDocument $dom
|
Chris@0
|
329 * @param DOMElement $root
|
Chris@0
|
330 * @return void
|
Chris@0
|
331 */
|
Chris@12
|
332 // @codingStandardsIgnoreStart
|
Chris@0
|
333 protected function _setImage(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
334 {
|
Chris@12
|
335 // @codingStandardsIgnoreEnd
|
Chris@0
|
336 $image = $this->getDataContainer()->getImage();
|
Chris@12
|
337 if (! $image) {
|
Chris@0
|
338 return;
|
Chris@0
|
339 }
|
Chris@0
|
340 $img = $dom->createElement('logo');
|
Chris@0
|
341 $root->appendChild($img);
|
Chris@0
|
342 $text = $dom->createTextNode($image['uri']);
|
Chris@0
|
343 $img->appendChild($text);
|
Chris@0
|
344 }
|
Chris@0
|
345
|
Chris@0
|
346 /**
|
Chris@0
|
347 * Set date feed was created
|
Chris@0
|
348 *
|
Chris@0
|
349 * @param DOMDocument $dom
|
Chris@0
|
350 * @param DOMElement $root
|
Chris@0
|
351 * @return void
|
Chris@0
|
352 */
|
Chris@12
|
353 // @codingStandardsIgnoreStart
|
Chris@0
|
354 protected function _setDateCreated(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
355 {
|
Chris@12
|
356 // @codingStandardsIgnoreEnd
|
Chris@12
|
357 if (! $this->getDataContainer()->getDateCreated()) {
|
Chris@0
|
358 return;
|
Chris@0
|
359 }
|
Chris@12
|
360 if (! $this->getDataContainer()->getDateModified()) {
|
Chris@0
|
361 $this->getDataContainer()->setDateModified(
|
Chris@0
|
362 $this->getDataContainer()->getDateCreated()
|
Chris@0
|
363 );
|
Chris@0
|
364 }
|
Chris@0
|
365 }
|
Chris@0
|
366
|
Chris@0
|
367 /**
|
Chris@0
|
368 * Set base URL to feed links
|
Chris@0
|
369 *
|
Chris@0
|
370 * @param DOMDocument $dom
|
Chris@0
|
371 * @param DOMElement $root
|
Chris@0
|
372 * @return void
|
Chris@0
|
373 */
|
Chris@12
|
374 // @codingStandardsIgnoreStart
|
Chris@0
|
375 protected function _setBaseUrl(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
376 {
|
Chris@12
|
377 // @codingStandardsIgnoreEnd
|
Chris@0
|
378 $baseUrl = $this->getDataContainer()->getBaseUrl();
|
Chris@12
|
379 if (! $baseUrl) {
|
Chris@0
|
380 return;
|
Chris@0
|
381 }
|
Chris@0
|
382 $root->setAttribute('xml:base', $baseUrl);
|
Chris@0
|
383 }
|
Chris@0
|
384
|
Chris@0
|
385 /**
|
Chris@0
|
386 * Set hubs to which this feed pushes
|
Chris@0
|
387 *
|
Chris@0
|
388 * @param DOMDocument $dom
|
Chris@0
|
389 * @param DOMElement $root
|
Chris@0
|
390 * @return void
|
Chris@0
|
391 */
|
Chris@12
|
392 // @codingStandardsIgnoreStart
|
Chris@0
|
393 protected function _setHubs(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
394 {
|
Chris@12
|
395 // @codingStandardsIgnoreEnd
|
Chris@0
|
396 $hubs = $this->getDataContainer()->getHubs();
|
Chris@12
|
397 if (! $hubs) {
|
Chris@0
|
398 return;
|
Chris@0
|
399 }
|
Chris@0
|
400 foreach ($hubs as $hubUrl) {
|
Chris@0
|
401 $hub = $dom->createElement('link');
|
Chris@0
|
402 $hub->setAttribute('rel', 'hub');
|
Chris@0
|
403 $hub->setAttribute('href', $hubUrl);
|
Chris@0
|
404 $root->appendChild($hub);
|
Chris@0
|
405 }
|
Chris@0
|
406 }
|
Chris@0
|
407
|
Chris@0
|
408 /**
|
Chris@0
|
409 * Set feed categories
|
Chris@0
|
410 *
|
Chris@0
|
411 * @param DOMDocument $dom
|
Chris@0
|
412 * @param DOMElement $root
|
Chris@0
|
413 * @return void
|
Chris@0
|
414 */
|
Chris@12
|
415 // @codingStandardsIgnoreStart
|
Chris@0
|
416 protected function _setCategories(DOMDocument $dom, DOMElement $root)
|
Chris@0
|
417 {
|
Chris@12
|
418 // @codingStandardsIgnoreEnd
|
Chris@0
|
419 $categories = $this->getDataContainer()->getCategories();
|
Chris@12
|
420 if (! $categories) {
|
Chris@0
|
421 return;
|
Chris@0
|
422 }
|
Chris@0
|
423 foreach ($categories as $cat) {
|
Chris@0
|
424 $category = $dom->createElement('category');
|
Chris@0
|
425 $category->setAttribute('term', $cat['term']);
|
Chris@0
|
426 if (isset($cat['label'])) {
|
Chris@0
|
427 $category->setAttribute('label', $cat['label']);
|
Chris@0
|
428 } else {
|
Chris@0
|
429 $category->setAttribute('label', $cat['term']);
|
Chris@0
|
430 }
|
Chris@0
|
431 if (isset($cat['scheme'])) {
|
Chris@0
|
432 $category->setAttribute('scheme', $cat['scheme']);
|
Chris@0
|
433 }
|
Chris@0
|
434 $root->appendChild($category);
|
Chris@0
|
435 }
|
Chris@0
|
436 }
|
Chris@0
|
437 }
|