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 'author element must contain a name element.'
117 $xs->element('uri', null, $uri);
121 $xs->element('email', null, $email);
124 $xs->elementEnd('author');
126 array_push($this->authors, $xs->getString());
130 * Add an Author to the feed via raw XML string
132 * @param string $xmlAuthor An XML string representation author
136 function addAuthorRaw($xmlAuthor)
138 array_push($this->authors, $xmlAuthor);
141 function renderAuthors()
143 foreach ($this->authors as $author) {
149 * Add a activity feed subject via raw XML string
151 * @param string $xmlSubject An XML string representation of the subject
155 function setActivitySubject($xmlSubject)
157 $this->subject = $xmlSubject;
160 function getNamespaces()
162 return $this->namespaces;
167 $this->xw->startDocument('1.0', 'UTF-8');
168 $commonAttrs = array('xml:lang' => 'en-US');
169 foreach ($this->namespaces as $prefix => $uri) {
173 $attr = 'xmlns:' . $prefix;
175 $commonAttrs[$attr] = $uri;
177 $this->elementStart('feed', $commonAttrs);
179 $this->element('id', null, $this->id);
180 $this->element('title', null, $this->title);
181 $this->element('subtitle', null, $this->subtitle);
183 if (!empty($this->logo)) {
184 $this->element('logo', null, $this->logo);
187 $this->element('updated', null, $this->updated);
189 $this->renderAuthors();
191 if ($this->selfLink) {
192 $this->addLink($this->selfLink, array('rel' => 'self',
193 'type' => $this->selfLinkType));
195 $this->renderLinks();
199 * Check that all required elements have been set, etc.
200 * Throws an Atom10FeedException if something's missing.
208 function renderLinks()
210 foreach ($this->links as $attrs)
212 $this->element('link', $attrs, null);
216 function addEntryRaw($xmlEntry)
218 array_push($this->entries, $xmlEntry);
221 function addEntry($entry)
223 array_push($this->entries, $entry->getString());
226 function renderEntries()
228 foreach ($this->entries as $entry) {
235 $this->elementEnd('feed');
236 $this->xw->endDocument();
241 if (Event::handle('StartApiAtom', array($this))) {
246 if (!empty($this->subject)) {
247 $this->raw($this->subject);
250 $this->renderEntries();
253 Event::handle('EndApiAtom', array($this));
256 return $this->xw->outputMemory();
264 function setSelfLink($url, $type='application/atom+xml')
266 $this->selfLink = $url;
267 $this->selfLinkType = $type;
270 function setTitle($title)
272 $this->title = $title;
275 function setSubtitle($subtitle)
277 $this->subtitle = $subtitle;
280 function setLogo($logo)
285 function setUpdated($dt)
287 $this->updated = common_date_iso8601($dt);
290 function setPublished($dt)
292 $this->published = common_date_iso8601($dt);
296 * Adds a link element into the Atom document
298 * Assumes you want rel="alternate" and type="text/html" unless
299 * you send in $otherAttrs.
301 * @param string $uri the uri the href needs to point to
302 * @param array $otherAttrs other attributes to stick in
306 function addLink($uri, $otherAttrs = null) {
307 $attrs = array('href' => $uri);
309 if (is_null($otherAttrs)) {
310 $attrs['rel'] = 'alternate';
311 $attrs['type'] = 'text/html';
313 $attrs = array_merge($attrs, $otherAttrs);
316 array_push($this->links, $attrs);