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
55 private $contributors;
70 * @param boolean $indent flag to turn indenting on or off
74 function __construct($indent = true) {
75 parent::__construct($indent);
76 $this->namespaces = array();
77 $this->links = array();
78 $this->entries = array();
79 $this->addNamespace('xmlns', 'http://www.w3.org/2005/Atom');
83 * Add another namespace to the feed
85 * @param string $namespace the namespace
86 * @param string $uri namspace uri
90 function addNamespace($namespace, $uri)
92 $ns = array($namespace => $uri);
93 $this->namespaces = array_merge($this->namespaces, $ns);
96 function getNamespaces()
98 return $this->namespaces;
103 $this->xw->startDocument('1.0', 'UTF-8');
104 $commonAttrs = array('xml:lang' => 'en-US');
105 $commonAttrs = array_merge($commonAttrs, $this->namespaces);
106 $this->elementStart('feed', $commonAttrs);
108 $this->element('id', null, $this->id);
109 $this->element('title', null, $this->title);
110 $this->element('subtitle', null, $this->subtitle);
112 if (!empty($this->logo)) {
113 $this->element('logo', null, $this->logo);
116 $this->element('updated', null, $this->updated);
118 $this->renderLinks();
122 * Check that all required elements have been set, etc.
123 * Throws an Atom10FeedException if something's missing.
131 function renderLinks()
133 foreach ($this->links as $attrs)
135 $this->element('link', $attrs, null);
139 function addEntryRaw($entry)
141 array_push($this->entries, $entry);
144 function addEntry($entry)
146 array_push($this->entries, $entry->getString());
149 function renderEntries()
151 foreach ($this->entries as $entry) {
158 $this->elementEnd('feed');
159 $this->xw->endDocument();
167 $this->renderEntries();
170 return $this->xw->outputMemory();
178 function setTitle($title)
180 $this->title = $title;
183 function setSubtitle($subtitle)
185 $this->subtitle = $subtitle;
188 function setLogo($logo)
193 function setUpdated($dt)
195 $this->updated = common_date_iso8601($dt);
198 function setPublished($dt)
200 $this->published = common_date_iso8601($dt);
204 * Adds a link element into the Atom document
206 * Assumes you want rel="alternate" and type="text/html" unless
207 * you send in $otherAttrs.
209 * @param string $uri the uri the href needs to point to
210 * @param array $otherAttrs other attributes to stick in
214 function addLink($uri, $otherAttrs = null) {
215 $attrs = array('href' => $uri);
217 if (is_null($otherAttrs)) {
218 $attrs['rel'] = 'alternate';
219 $attrs['type'] = 'text/html';
221 $attrs = array_merge($attrs, $otherAttrs);
224 array_push($this->links, $attrs);