3 * StatusNet, the distributed open-source microblogging tool
5 * Class for building an Atom feed in memory
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Zach Copley <zach@status.net>
25 * @copyright 2010 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET'))
35 class Atom10FeedException extends Exception
40 * Class for building an Atom feed in memory. Get the finished doc
41 * as a string with Atom10Feed::getString().
45 * @author Zach Copley <zach@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
49 class Atom10Feed extends XMLStringer
53 // @fixme most of these should probably be read-only properties
58 private $contributors;
63 private $selfLinkType;
75 * @param boolean $indent flag to turn indenting on or off
79 function __construct($indent = true) {
80 parent::__construct($indent);
81 $this->namespaces = array();
82 $this->authors = array();
83 $this->links = array();
84 $this->entries = array();
85 $this->addNamespace('', 'http://www.w3.org/2005/Atom');
89 * Add another namespace to the feed
91 * @param string $namespace the namespace
92 * @param string $uri namspace uri
96 function addNamespace($namespace, $uri)
98 $ns = array($namespace => $uri);
99 $this->namespaces = array_merge($this->namespaces, $ns);
102 function addAuthor($name, $uri = null, $email = null)
104 $xs = new XMLStringer(true);
106 $xs->elementStart('author');
109 $xs->element('name', null, $name);
111 throw new Atom10FeedException(
112 // TRANS: Atom feed exception thrown when an author element does not contain a name element.
113 _('Author element must contain a name element.')
118 $xs->element('uri', null, $uri);
122 $xs->element('email', null, $email);
125 $xs->elementEnd('author');
127 array_push($this->authors, $xs->getString());
131 * Add an Author to the feed via raw XML string
133 * @param string $xmlAuthor An XML string representation author
137 function addAuthorRaw($xmlAuthor)
139 array_push($this->authors, $xmlAuthor);
142 function renderAuthors()
144 foreach ($this->authors as $author) {
150 * Deprecated <activity:subject>; ignored
152 * @param string $xmlSubject An XML string representation of the subject
157 function setActivitySubject($xmlSubject)
159 // TRANS: Server exception thrown when using the method setActivitySubject() in the class Atom10Feed.
160 throw new ServerException(_('Do not use this method!'));
163 function getNamespaces()
165 return $this->namespaces;
170 $this->xw->startDocument('1.0', 'UTF-8');
171 $commonAttrs = array('xml:lang' => 'en-US');
172 foreach ($this->namespaces as $prefix => $uri) {
176 $attr = 'xmlns:' . $prefix;
178 $commonAttrs[$attr] = $uri;
180 $this->elementStart('feed', $commonAttrs);
184 'uri' => 'http://status.net',
185 'version' => STATUSNET_VERSION
190 $this->element('id', null, $this->id);
191 $this->element('title', null, $this->title);
192 $this->element('subtitle', null, $this->subtitle);
194 if (!empty($this->logo)) {
195 $this->element('logo', null, $this->logo);
198 $this->element('updated', null, $this->updated);
200 $this->renderAuthors();
202 if ($this->selfLink) {
203 $this->addLink($this->selfLink, array('rel' => 'self',
204 'type' => $this->selfLinkType));
206 $this->renderLinks();
210 * Check that all required elements have been set, etc.
211 * Throws an Atom10FeedException if something's missing.
219 function renderLinks()
221 foreach ($this->links as $attrs)
223 $this->element('link', $attrs, null);
227 function addEntryRaw($xmlEntry)
229 array_push($this->entries, $xmlEntry);
232 function addEntry($entry)
234 array_push($this->entries, $entry->getString());
237 function renderEntries()
239 foreach ($this->entries as $entry) {
246 $this->elementEnd('feed');
247 $this->xw->endDocument();
252 if (Event::handle('StartApiAtom', array($this))) {
257 if (!empty($this->subject)) {
258 $this->raw($this->subject);
261 $this->renderEntries();
264 Event::handle('EndApiAtom', array($this));
267 return $this->xw->outputMemory();
275 function setSelfLink($url, $type='application/atom+xml')
277 $this->selfLink = $url;
278 $this->selfLinkType = $type;
281 function setTitle($title)
283 $this->title = $title;
286 function setSubtitle($subtitle)
288 $this->subtitle = $subtitle;
291 function setLogo($logo)
296 function setUpdated($dt)
298 $this->updated = common_date_iso8601($dt);
301 function setPublished($dt)
303 $this->published = common_date_iso8601($dt);
307 * Adds a link element into the Atom document
309 * Assumes you want rel="alternate" and type="text/html" unless
310 * you send in $otherAttrs.
312 * @param string $uri the uri the href needs to point to
313 * @param array $otherAttrs other attributes to stick in
317 function addLink($uri, $otherAttrs = null) {
318 $attrs = array('href' => $uri);
320 if (is_null($otherAttrs)) {
321 $attrs['rel'] = 'alternate';
322 $attrs['type'] = 'text/html';
324 $attrs = array_merge($attrs, $otherAttrs);
327 array_push($this->links, $attrs);