Utility classes for atom feeds
This commit is contained in:
parent
1773d12a24
commit
ce3c3be1bf
|
@ -145,7 +145,26 @@ class ApiTimelineUserAction extends ApiBareAuthAction
|
||||||
);
|
);
|
||||||
break;
|
break;
|
||||||
case 'atom':
|
case 'atom':
|
||||||
|
|
||||||
|
header('Content-Type: application/atom+xml; charset=utf-8');
|
||||||
|
|
||||||
|
$atom = new AtomNoticeFeed();
|
||||||
|
|
||||||
|
$atom->addLink(
|
||||||
|
common_local_url(
|
||||||
|
'showstream',
|
||||||
|
array('nickname' => $this->user->nickname)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
$atom->setId($id);
|
||||||
|
$atom->setTitle($title);
|
||||||
|
$atom->setSubtitle($subtitle);
|
||||||
|
$atom->setLogo($logo);
|
||||||
|
$atom->setUpdated('now');
|
||||||
|
|
||||||
$id = $this->arg('id');
|
$id = $this->arg('id');
|
||||||
|
|
||||||
if ($id) {
|
if ($id) {
|
||||||
$selfuri = common_root_url() .
|
$selfuri = common_root_url() .
|
||||||
'api/statuses/user_timeline/' .
|
'api/statuses/user_timeline/' .
|
||||||
|
@ -154,10 +173,24 @@ class ApiTimelineUserAction extends ApiBareAuthAction
|
||||||
$selfuri = common_root_url() .
|
$selfuri = common_root_url() .
|
||||||
'api/statuses/user_timeline.atom';
|
'api/statuses/user_timeline.atom';
|
||||||
}
|
}
|
||||||
$this->showAtomTimeline(
|
|
||||||
$this->notices, $title, $id, $link,
|
$atom->addLink(
|
||||||
$subtitle, $suplink, $selfuri, $logo
|
$selfuri,
|
||||||
|
array('rel' => 'self', 'type' => 'application/atom+xml')
|
||||||
);
|
);
|
||||||
|
|
||||||
|
$atom->addLink(
|
||||||
|
$suplink,
|
||||||
|
array(
|
||||||
|
'rel' => 'http://api.friendfeed.com/2008/03#sup',
|
||||||
|
'type' => 'application/json'
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
$atom->addEntryFromNotices($this->notices);
|
||||||
|
|
||||||
|
print $atom->getString();
|
||||||
|
|
||||||
break;
|
break;
|
||||||
case 'json':
|
case 'json':
|
||||||
$this->showJsonTimeline($this->notices);
|
$this->showJsonTimeline($this->notices);
|
||||||
|
|
58
lib/atom10entry.php
Normal file
58
lib/atom10entry.php
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
class Atom10EntryException extends Exception
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
class Atom10Entry extends XMLStringer
|
||||||
|
{
|
||||||
|
private $namespaces;
|
||||||
|
private $categories;
|
||||||
|
private $content;
|
||||||
|
private $contributors;
|
||||||
|
private $id;
|
||||||
|
private $links;
|
||||||
|
private $published;
|
||||||
|
private $rights;
|
||||||
|
private $source;
|
||||||
|
private $summary;
|
||||||
|
private $title;
|
||||||
|
|
||||||
|
function __construct($indent = true) {
|
||||||
|
parent::__construct($indent);
|
||||||
|
$this->namespaces = array();
|
||||||
|
}
|
||||||
|
|
||||||
|
function addNamespace($namespace, $uri)
|
||||||
|
{
|
||||||
|
$ns = array($namespace => $uri);
|
||||||
|
$this->namespaces = array_merge($this->namespaces, $ns);
|
||||||
|
}
|
||||||
|
|
||||||
|
function initEntry()
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function endEntry()
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function validate
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
function getString()
|
||||||
|
{
|
||||||
|
$this->validate();
|
||||||
|
|
||||||
|
$this->initEntry();
|
||||||
|
$this->renderEntries();
|
||||||
|
$this->endEntry();
|
||||||
|
|
||||||
|
return $this->xw->outputMemory();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
177
lib/atom10feed.php
Normal file
177
lib/atom10feed.php
Normal file
|
@ -0,0 +1,177 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
class Atom10FeedException extends Exception
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
class Atom10Feed extends XMLStringer
|
||||||
|
{
|
||||||
|
public $xw;
|
||||||
|
private $namespaces;
|
||||||
|
private $authors;
|
||||||
|
private $categories;
|
||||||
|
private $contributors;
|
||||||
|
private $generator;
|
||||||
|
private $icon;
|
||||||
|
private $links;
|
||||||
|
private $logo;
|
||||||
|
private $rights;
|
||||||
|
private $subtitle;
|
||||||
|
private $title;
|
||||||
|
private $published;
|
||||||
|
private $updated;
|
||||||
|
private $entries;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* undocumented function
|
||||||
|
*
|
||||||
|
* @param array $entries an array of FeedItems
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
function __construct($indent = true) {
|
||||||
|
parent::__construct($indent);
|
||||||
|
$this->namespaces = array();
|
||||||
|
$this->links = array();
|
||||||
|
$this->entries = array();
|
||||||
|
$this->addNamespace('xmlns', 'http://www.w3.org/2005/Atom');
|
||||||
|
}
|
||||||
|
|
||||||
|
function addNamespace($namespace, $uri)
|
||||||
|
{
|
||||||
|
$ns = array($namespace => $uri);
|
||||||
|
$this->namespaces = array_merge($this->namespaces, $ns);
|
||||||
|
}
|
||||||
|
|
||||||
|
function getNamespaces()
|
||||||
|
{
|
||||||
|
return $this->namespaces;
|
||||||
|
}
|
||||||
|
|
||||||
|
function initFeed()
|
||||||
|
{
|
||||||
|
$this->xw->startDocument('1.0', 'UTF-8');
|
||||||
|
$commonAttrs = array('xml:lang' => 'en-US');
|
||||||
|
$commonAttrs = array_merge($commonAttrs, $this->namespaces);
|
||||||
|
$this->elementStart('feed', $commonAttrs);
|
||||||
|
|
||||||
|
$this->element('id', null, $this->id);
|
||||||
|
$this->element('title', null, $this->title);
|
||||||
|
$this->element('subtitle', null, $this->subtitle);
|
||||||
|
$this->element('logo', null, $this->logo);
|
||||||
|
$this->element('updated', null, $this->updated);
|
||||||
|
|
||||||
|
$this->renderLinks();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check that all required elements have been set, etc.
|
||||||
|
* Throws an Atom10FeedException if something's missing.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function validate()
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderLinks()
|
||||||
|
{
|
||||||
|
foreach ($this->links as $attrs)
|
||||||
|
{
|
||||||
|
$this->element('link', $attrs, null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function addEntryRaw($entry)
|
||||||
|
{
|
||||||
|
array_push($this->entries, $entry);
|
||||||
|
}
|
||||||
|
|
||||||
|
function addEntry($entry)
|
||||||
|
{
|
||||||
|
array_push($this->entries, $entry->getString());
|
||||||
|
}
|
||||||
|
|
||||||
|
function renderEntries()
|
||||||
|
{
|
||||||
|
foreach ($this->entries as $entry) {
|
||||||
|
$this->raw($entry);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function endFeed()
|
||||||
|
{
|
||||||
|
$this->elementEnd('feed');
|
||||||
|
$this->xw->endDocument();
|
||||||
|
}
|
||||||
|
|
||||||
|
function getString()
|
||||||
|
{
|
||||||
|
$this->validate();
|
||||||
|
|
||||||
|
$this->initFeed();
|
||||||
|
$this->renderEntries();
|
||||||
|
$this->endFeed();
|
||||||
|
|
||||||
|
return $this->xw->outputMemory();
|
||||||
|
}
|
||||||
|
|
||||||
|
function setId($id)
|
||||||
|
{
|
||||||
|
$this->id = $id;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setTitle($title)
|
||||||
|
{
|
||||||
|
$this->title = $title;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setSubtitle($subtitle)
|
||||||
|
{
|
||||||
|
$this->subtitle = $subtitle;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setLogo($logo)
|
||||||
|
{
|
||||||
|
$this->logo = $logo;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setUpdated($dt)
|
||||||
|
{
|
||||||
|
$this->updated = common_date_iso8601($dt);
|
||||||
|
}
|
||||||
|
|
||||||
|
function setPublished($dt)
|
||||||
|
{
|
||||||
|
$this->published = common_date_iso8601($dt);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a link element into the Atom document
|
||||||
|
*
|
||||||
|
* Assumes you want rel="alternate" and type="text/html" unless
|
||||||
|
* you send in $otherAttrs.
|
||||||
|
*
|
||||||
|
* @param string $uri the uri the href need to point to
|
||||||
|
* @param array $otherAttrs other attributes to stick in
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function addLink($uri, $otherAttrs = null) {
|
||||||
|
$attrs = array('href' => $uri);
|
||||||
|
|
||||||
|
if (is_null($otherAttrs)) {
|
||||||
|
$attrs['rel'] = 'alternate';
|
||||||
|
$attrs['type'] = 'text/html';
|
||||||
|
} else {
|
||||||
|
$attrs = array_merge($attrs, $otherAttrs);
|
||||||
|
}
|
||||||
|
|
||||||
|
array_push($this->links, $attrs);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
34
lib/atomnoticefeed.php
Normal file
34
lib/atomnoticefeed.php
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
class AtomNoticeFeed extends Atom10Feed
|
||||||
|
{
|
||||||
|
function __construct($indent = true) {
|
||||||
|
parent::__construct($indent);
|
||||||
|
|
||||||
|
// Feeds containing notice info use the Atom Threading Extensions
|
||||||
|
|
||||||
|
$this->addNamespace(
|
||||||
|
'xmlns:thr',
|
||||||
|
'http://purl.org/syndication/thread/1.0'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function addEntryFromNotices($notices)
|
||||||
|
{
|
||||||
|
if (is_array($notices)) {
|
||||||
|
foreach ($notices as $notice) {
|
||||||
|
$this->addEntryFromNotice($notice);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
while ($notices->fetch()) {
|
||||||
|
$this->addEntryFromNotice($notice);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function addEntryFromNotice($notice)
|
||||||
|
{
|
||||||
|
$this->addEntryRaw($notice->asAtomEntry());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user