Skip to content

Commit

Permalink
Move JDocumentFeed renderers to autoload format, minor class cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Babker committed Nov 21, 2015
1 parent dc79ed6 commit 2c73d3d
Show file tree
Hide file tree
Showing 5 changed files with 491 additions and 454 deletions.
14 changes: 7 additions & 7 deletions libraries/joomla/document/feed.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class JDocumentFeed extends JDocument
*
* optional
*
* @var object
* @var JFeedImage
* @since 11.1
*/
public $image = null;
Expand Down Expand Up @@ -157,7 +157,7 @@ class JDocumentFeed extends JDocument
/**
* The feed items collection
*
* @var array
* @var JFeedItem[]
* @since 11.1
*/
public $items = array();
Expand Down Expand Up @@ -185,9 +185,9 @@ public function __construct($options = array())
*
* @return The rendered data
*
* @since 11.1
* @throws Exception
* @todo Make this cacheable
* @since 11.1
* @throws Exception
* @todo Make this cacheable
*/
public function render($cache = false, $params = array())
{
Expand All @@ -197,7 +197,7 @@ public function render($cache = false, $params = array())
// Instantiate feed renderer and set the mime encoding
$renderer = $this->loadRenderer(($type) ? $type : 'rss');

if (!is_a($renderer, 'JDocumentRenderer'))
if (!($renderer instanceof JDocumentRenderer))
{
throw new Exception(JText::_('JGLOBAL_RESOURCE_NOT_FOUND'), 404);
}
Expand Down Expand Up @@ -321,7 +321,7 @@ class JFeedItem
/**
* Enclosure element
*
* @var object
* @var JFeedEnclosure
* @since 11.1
*/
public $enclosure = null;
Expand Down
197 changes: 5 additions & 192 deletions libraries/joomla/document/feed/renderer/atom.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,203 +10,16 @@
defined('JPATH_PLATFORM') or die;

/**
* JDocumentRenderer_Atom is a feed that implements the atom specification
* JDocumentRendererAtom is a feed that implements the atom specification
*
* Please note that just by using this class you won't automatically
* produce valid atom files. For example, you have to specify either an editor
* for the feed or an author for every single feed item.
*
* @see http://www.atomenabled.org/developers/syndication/atom-format-spec.php
* @since 11.1
* @see http://www.atomenabled.org/developers/syndication/atom-format-spec.php
* @since 11.1
* @deprecated 4.0 Use JDocumentRendererFeedAtom instead
*/
class JDocumentRendererAtom extends JDocumentRenderer
class JDocumentRendererAtom extends JDocumentRendererFeedAtom
{
/**
* Document mime type
*
* @var string
* @since 11.1
*/
protected $_mime = "application/atom+xml";

/**
* Render the feed.
*
* @param string $name The name of the element to render
* @param array $params Array of values
* @param string $content Override the output of the renderer
*
* @return string The output of the script
*
* @see JDocumentRenderer::render()
* @since 11.1
*/
public function render($name = '', $params = null, $content = null)
{
$app = JFactory::getApplication();

// Gets and sets timezone offset from site configuration
$tz = new DateTimeZone($app->getCfg('offset'));
$now = JFactory::getDate();
$now->setTimeZone($tz);

$data = $this->_doc;

$uri = JUri::getInstance();
$url = $uri->toString(array('scheme', 'user', 'pass', 'host', 'port'));
$syndicationURL = JRoute::_('&format=feed&type=atom');

if ($app->getCfg('sitename_pagetitles', 0) == 1)
{
$title = JText::sprintf('JPAGETITLE', $app->getCfg('sitename'), $data->title);
}
elseif ($app->getCfg('sitename_pagetitles', 0) == 2)
{
$title = JText::sprintf('JPAGETITLE', $data->title, $app->getCfg('sitename'));
}
else
{
$title = $data->title;
}

$feed_title = htmlspecialchars($title, ENT_COMPAT, 'UTF-8');

$feed = "<feed xmlns=\"http://www.w3.org/2005/Atom\" ";

if ($data->language != "")
{
$feed .= " xml:lang=\"" . $data->language . "\"";
}

$feed .= ">\n";
$feed .= " <title type=\"text\">" . $feed_title . "</title>\n";
$feed .= " <subtitle type=\"text\">" . htmlspecialchars($data->description, ENT_COMPAT, 'UTF-8') . "</subtitle>\n";

if (empty($data->category) === false)
{
if (is_array($data->category))
{
foreach ($data->category as $cat)
{
$feed .= " <category term=\"" . htmlspecialchars($cat, ENT_COMPAT, 'UTF-8') . "\" />\n";
}
}
else
{
$feed .= " <category term=\"" . htmlspecialchars($data->category, ENT_COMPAT, 'UTF-8') . "\" />\n";
}
}

$feed .= " <link rel=\"alternate\" type=\"text/html\" href=\"" . $url . "\"/>\n";
$feed .= " <id>" . str_replace(' ', '%20', $data->getBase()) . "</id>\n";
$feed .= " <updated>" . htmlspecialchars($now->toISO8601(true), ENT_COMPAT, 'UTF-8') . "</updated>\n";

if ($data->editor != "")
{
$feed .= " <author>\n";
$feed .= " <name>" . $data->editor . "</name>\n";

if ($data->editorEmail != "")
{
$feed .= " <email>" . htmlspecialchars($data->editorEmail, ENT_COMPAT, 'UTF-8') . "</email>\n";
}

$feed .= " </author>\n";
}

if ($app->get('MetaVersion', 0))
{
$version = new JVersion;

$versionHtmlEscaped = ' version="' . htmlspecialchars($version->RELEASE, ENT_COMPAT, 'UTF-8') . '"';
}
else
{
$versionHtmlEscaped = '';
}

$feed .= " <generator uri=\"http://joomla.org\"" . $versionHtmlEscaped . ">" . $data->getGenerator() . "</generator>\n";
$feed .= ' <link rel="self" type="application/atom+xml" href="' . str_replace(' ', '%20', $url . $syndicationURL) . "\"/>\n";

for ($i = 0, $count = count($data->items); $i < $count; $i++)
{
if (!preg_match('/[\x80-\xFF]/', $data->items[$i]->link))
{
$itemlink = $data->items[$i]->link;
}
else
{
$itemlink = implode("/", array_map("rawurlencode", explode("/", $data->items[$i]->link)));
}

$feed .= " <entry>\n";
$feed .= " <title>" . htmlspecialchars(strip_tags($data->items[$i]->title), ENT_COMPAT, 'UTF-8') . "</title>\n";
$feed .= ' <link rel="alternate" type="text/html" href="' . $url . $itemlink . "\"/>\n";

if ($data->items[$i]->date == "")
{
$data->items[$i]->date = $now->toUnix();
}

$itemDate = JFactory::getDate($data->items[$i]->date);
$itemDate->setTimeZone($tz);
$feed .= " <published>" . htmlspecialchars($itemDate->toISO8601(true), ENT_COMPAT, 'UTF-8') . "</published>\n";
$feed .= " <updated>" . htmlspecialchars($itemDate->toISO8601(true), ENT_COMPAT, 'UTF-8') . "</updated>\n";

if (empty($data->items[$i]->guid) === true)
{
$feed .= " <id>" . str_replace(' ', '%20', $url . $itemlink) . "</id>\n";
}
else
{
$feed .= " <id>" . htmlspecialchars($data->items[$i]->guid, ENT_COMPAT, 'UTF-8') . "</id>\n";
}

if ($data->items[$i]->author != "")
{
$feed .= " <author>\n";
$feed .= " <name>" . htmlspecialchars($data->items[$i]->author, ENT_COMPAT, 'UTF-8') . "</name>\n";

if ($data->items[$i]->authorEmail != "")
{
$feed .= " <email>" . htmlspecialchars($data->items[$i]->authorEmail, ENT_COMPAT, 'UTF-8') . "</email>\n";
}

$feed .= " </author>\n";
}

if ($data->items[$i]->description != "")
{
$feed .= " <summary type=\"html\">" . htmlspecialchars($this->_relToAbs($data->items[$i]->description), ENT_COMPAT, 'UTF-8') . "</summary>\n";
$feed .= " <content type=\"html\">" . htmlspecialchars($data->items[$i]->description, ENT_COMPAT, 'UTF-8') . "</content>\n";
}

if (empty($data->items[$i]->category) === false)
{
if (is_array($data->items[$i]->category))
{
foreach ($data->items[$i]->category as $cat)
{
$feed .= " <category term=\"" . htmlspecialchars($cat, ENT_COMPAT, 'UTF-8') . "\" />\n";
}
}
else
{
$feed .= " <category term=\"" . htmlspecialchars($data->items[$i]->category, ENT_COMPAT, 'UTF-8') . "\" />\n";
}
}

if ($data->items[$i]->enclosure != null)
{
$feed .= " <link rel=\"enclosure\" href=\"" . $data->items[$i]->enclosure->url . "\" type=\""
. $data->items[$i]->enclosure->type . "\" length=\"" . $data->items[$i]->enclosure->length . "\" />\n";
}

$feed .= " </entry>\n";
}

$feed .= "</feed>\n";

return $feed;
}
}

0 comments on commit 2c73d3d

Please sign in to comment.