This repository has been archived by the owner on Jan 8, 2020. It is now read-only.
/
Feed.php
238 lines (218 loc) · 6.26 KB
/
Feed.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
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @package Zend_Feed
*/
namespace Zend\Feed\Writer;
use Countable;
use Iterator;
use Zend\Feed\Writer\Renderer;
/**
* @category Zend
* @package Zend_Feed_Writer
*/
class Feed extends AbstractFeed implements Iterator, Countable
{
/**
* Contains all entry objects
*
* @var array
*/
protected $entries = array();
/**
* A pointer for the iterator to keep track of the entries array
*
* @var int
*/
protected $entriesKey = 0;
/**
* Creates a new Zend\Feed\Writer\Entry data container for use. This is NOT
* added to the current feed automatically, but is necessary to create a
* container with some initial values preset based on the current feed data.
*
* @return \Zend\Feed\Writer\Entry
*/
public function createEntry()
{
$entry = new Entry;
if ($this->getEncoding()) {
$entry->setEncoding($this->getEncoding());
}
$entry->setType($this->getType());
return $entry;
}
/**
* Appends a Zend\Feed\Writer\Deleted object representing a new entry tombstone
* to the feed data container's internal group of entries.
*
* @param Deleted $deleted
* @return void
*/
public function addTombstone(Deleted $deleted)
{
$this->entries[] = $deleted;
}
/**
* Creates a new Zend\Feed\Writer\Deleted data container for use. This is NOT
* added to the current feed automatically, but is necessary to create a
* container with some initial values preset based on the current feed data.
*
* @return Deleted
*/
public function createTombstone()
{
$deleted = new Deleted;
if ($this->getEncoding()) {
$deleted->setEncoding($this->getEncoding());
}
$deleted->setType($this->getType());
return $deleted;
}
/**
* Appends a Zend\Feed\Writer\Entry object representing a new entry/item
* the feed data container's internal group of entries.
*
* @param Entry $entry
*/
public function addEntry(Entry $entry)
{
$this->entries[] = $entry;
}
/**
* Removes a specific indexed entry from the internal queue. Entries must be
* added to a feed container in order to be indexed.
*
* @param int $index
* @throws Exception\InvalidArgumentException
*/
public function removeEntry($index)
{
if (!isset($this->entries[$index])) {
throw new Exception\InvalidArgumentException('Undefined index: ' . $index . '. Entry does not exist.');
}
unset($this->entries[$index]);
}
/**
* Retrieve a specific indexed entry from the internal queue. Entries must be
* added to a feed container in order to be indexed.
*
* @param int $index
* @throws Exception\InvalidArgumentException
*/
public function getEntry($index = 0)
{
if (isset($this->entries[$index])) {
return $this->entries[$index];
}
throw new Exception\InvalidArgumentException('Undefined index: ' . $index . '. Entry does not exist.');
}
/**
* Orders all indexed entries by date, thus offering date ordered readable
* content where a parser (or Homo Sapien) ignores the generic rule that
* XML element order is irrelevant and has no intrinsic meaning.
*
* Using this method will alter the original indexation.
*
* @return void
*/
public function orderByDate()
{
/**
* Could do with some improvement for performance perhaps
*/
$timestamp = time();
$entries = array();
foreach ($this->entries as $entry) {
if ($entry->getDateModified()) {
$timestamp = (int) $entry->getDateModified()->getTimestamp();
} elseif ($entry->getDateCreated()) {
$timestamp = (int) $entry->getDateCreated()->getTimestamp();
}
$entries[$timestamp] = $entry;
}
krsort($entries, \SORT_NUMERIC);
$this->entries = array_values($entries);
}
/**
* Get the number of feed entries.
* Required by the Iterator interface.
*
* @return int
*/
public function count()
{
return count($this->entries);
}
/**
* Return the current entry
*
* @return Entry
*/
public function current()
{
return $this->entries[$this->key()];
}
/**
* Return the current feed key
*
* @return mixed
*/
public function key()
{
return $this->entriesKey;
}
/**
* Move the feed pointer forward
*
* @return void
*/
public function next()
{
++$this->entriesKey;
}
/**
* Reset the pointer in the feed object
*
* @return void
*/
public function rewind()
{
$this->entriesKey = 0;
}
/**
* Check to see if the iterator is still valid
*
* @return boolean
*/
public function valid()
{
return 0 <= $this->entriesKey && $this->entriesKey < $this->count();
}
/**
* Attempt to build and return the feed resulting from the data set
*
* @param string $type The feed type "rss" or "atom" to export as
* @param bool $ignoreExceptions
* @throws Exception\InvalidArgumentException
* @return string
*/
public function export($type, $ignoreExceptions = false)
{
$this->setType(strtolower($type));
$type = ucfirst($this->getType());
if ($type !== 'Rss' && $type !== 'Atom') {
throw new Exception\InvalidArgumentException('Invalid feed type specified: ' . $type . '.'
. ' Should be one of "rss" or "atom".');
}
$renderClass = 'Zend\\Feed\\Writer\\Renderer\\Feed\\' . $type;
$renderer = new $renderClass($this);
if ($ignoreExceptions) {
$renderer->ignoreExceptions();
}
return $renderer->render()->saveXml();
}
}