FeedDocument.php
3.98 KB
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
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Document;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Document\Feed\FeedImage;
use Joomla\CMS\Document\Feed\FeedItem;
/**
* FeedDocument class, provides an easy interface to parse and display any feed document
*
* @since 1.7.0
*/
class FeedDocument extends Document
{
/**
* Syndication URL feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $syndicationURL = '';
/**
* Image feed element
*
* optional
*
* @var FeedImage
* @since 1.7.0
*/
public $image = null;
/**
* Copyright feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $copyright = '';
/**
* Published date feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $pubDate = '';
/**
* Lastbuild date feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $lastBuildDate = '';
/**
* Editor feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $editor = '';
/**
* Docs feed element
*
* @var string
* @since 1.7.0
*/
public $docs = '';
/**
* Editor email feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $editorEmail = '';
/**
* Webmaster email feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $webmaster = '';
/**
* Category feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $category = '';
/**
* TTL feed attribute
*
* optional
*
* @var string
* @since 1.7.0
*/
public $ttl = '';
/**
* Rating feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $rating = '';
/**
* Skiphours feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $skipHours = '';
/**
* Skipdays feed element
*
* optional
*
* @var string
* @since 1.7.0
*/
public $skipDays = '';
/**
* The feed items collection
*
* @var FeedItem[]
* @since 1.7.0
*/
public $items = array();
/**
* Class constructor
*
* @param array $options Associative array of options
*
* @since 1.7.0
*/
public function __construct($options = array())
{
parent::__construct($options);
// Set document type
$this->_type = 'feed';
}
/**
* Render the document
*
* @param boolean $cache If true, cache the output
* @param array $params Associative array of attributes
*
* @return string The rendered data
*
* @since 1.7.0
* @throws \Exception
* @todo Make this cacheable
*/
public function render($cache = false, $params = array())
{
// Get the feed type
$type = \JFactory::getApplication()->input->get('type', 'rss');
// Instantiate feed renderer and set the mime encoding
$renderer = $this->loadRenderer(($type) ? $type : 'rss');
if (!($renderer instanceof DocumentRenderer))
{
throw new \Exception(JText::_('JGLOBAL_RESOURCE_NOT_FOUND'), 404);
}
$this->setMimeEncoding($renderer->getContentType());
// Output
// Generate prolog
$data = "<?xml version=\"1.0\" encoding=\"" . $this->_charset . "\"?>\n";
$data .= "<!-- generator=\"" . $this->getGenerator() . "\" -->\n";
// Generate stylesheet links
foreach ($this->_styleSheets as $src => $attr)
{
$data .= "<?xml-stylesheet href=\"$src\" type=\"" . $attr['type'] . "\"?>\n";
}
// Render the feed
$data .= $renderer->render();
parent::render($cache, $params);
return $data;
}
/**
* Adds a FeedItem to the feed.
*
* @param FeedItem $item The feeditem to add to the feed.
*
* @return FeedDocument instance of $this to allow chaining
*
* @since 1.7.0
*/
public function addItem(FeedItem $item)
{
$item->source = $this->link;
$this->items[] = $item;
return $this;
}
}