mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-06 17:51:34 +02:00
This changes the behaviour of output to browser to use the standard SilverStripe rendering process rather than an echo statement to enable easier testability.
337 lines
7.5 KiB
PHP
337 lines
7.5 KiB
PHP
<?php
|
|
/**
|
|
* RSSFeed class
|
|
*
|
|
* This class is used to create an RSS feed.
|
|
* @todo Improve documentation
|
|
* @package framework
|
|
* @subpackage integration
|
|
*/
|
|
class RSSFeed extends ViewableData {
|
|
|
|
/**
|
|
* Casting information for this object's methods.
|
|
* Let's us use $Title.XML in templates
|
|
*/
|
|
public static $casting = array(
|
|
"Title" => "Varchar",
|
|
"Description" => "Varchar",
|
|
);
|
|
|
|
/**
|
|
* Holds the feed entries
|
|
*
|
|
* @var SS_List
|
|
*/
|
|
protected $entries;
|
|
|
|
/**
|
|
* Title of the feed
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $title;
|
|
|
|
/**
|
|
* Description of the feed
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $description;
|
|
|
|
/**
|
|
* Link to the feed
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $link;
|
|
|
|
/**
|
|
* Name of the title field of feed entries
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $titleField;
|
|
|
|
/**
|
|
* Name of the description field of feed entries
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $descriptionField;
|
|
|
|
/**
|
|
* Name of the author field of feed entries
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $authorField;
|
|
|
|
/**
|
|
* Last modification of the RSS feed
|
|
*
|
|
* @var int Unix timestamp of the last modification
|
|
*/
|
|
protected $lastModified;
|
|
|
|
/**
|
|
* ETag for the RSS feed (used for client-site caching)
|
|
*
|
|
* @var string The value for the HTTP ETag header.
|
|
*/
|
|
protected $etag;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $template = 'RSSFeed';
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param SS_List $entries RSS feed entries
|
|
* @param string $link Link to the feed
|
|
* @param string $title Title of the feed
|
|
* @param string $description Description of the field
|
|
* @param string $titleField Name of the field that should be used for the
|
|
* titles for the feed entries
|
|
* @param string $descriptionField Name of the field that should be used
|
|
* for the description for the feed
|
|
* entries
|
|
* @param string $authorField Name of the field that should be used for
|
|
* the author for the feed entries
|
|
* @param int $lastModified Unix timestamp of the latest modification
|
|
* (latest posting)
|
|
* @param string $etag The ETag is an unique identifier that is changed
|
|
* every time the representation does
|
|
*/
|
|
function __construct(SS_List $entries, $link, $title,
|
|
$description = null, $titleField = "Title",
|
|
$descriptionField = "Content", $authorField = null,
|
|
$lastModified = null, $etag = null) {
|
|
$this->entries = $entries;
|
|
$this->link = $link;
|
|
$this->description = $description;
|
|
$this->title = $title;
|
|
|
|
$this->titleField = $titleField;
|
|
$this->descriptionField = $descriptionField;
|
|
$this->authorField = $authorField;
|
|
|
|
$this->lastModified = $lastModified;
|
|
$this->etag = $etag;
|
|
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Include an link to the feed
|
|
*
|
|
* @param string $url URL of the feed
|
|
* @param string $title Title to show
|
|
*/
|
|
static function linkToFeed($url, $title = null) {
|
|
$title = Convert::raw2xml($title);
|
|
Requirements::insertHeadTags(
|
|
'<link rel="alternate" type="application/rss+xml" title="' . $title .
|
|
'" href="' . $url . '" />');
|
|
}
|
|
|
|
/**
|
|
* Get the RSS feed entries
|
|
*
|
|
* @return SS_List Returns the {@link RSSFeed_Entry} objects.
|
|
*/
|
|
function Entries() {
|
|
$output = new ArrayList();
|
|
|
|
if(isset($this->entries)) {
|
|
foreach($this->entries as $entry) {
|
|
$output->push(new RSSFeed_Entry($entry, $this->titleField, $this->descriptionField, $this->authorField));
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Get the title of thisfeed
|
|
*
|
|
* @return string Returns the title of the feed.
|
|
*/
|
|
function Title() {
|
|
return $this->title;
|
|
}
|
|
|
|
/**
|
|
* Get the URL of this feed
|
|
*
|
|
* @param string $action
|
|
* @return string Returns the URL of the feed.
|
|
*/
|
|
function Link($action = null) {
|
|
return Controller::join_links(Director::absoluteURL($this->link), $action);
|
|
}
|
|
|
|
/**
|
|
* Get the description of this feed
|
|
*
|
|
* @return string Returns the description of the feed.
|
|
*/
|
|
function Description() {
|
|
return $this->description;
|
|
}
|
|
|
|
/**
|
|
* Output the feed to the browser
|
|
*/
|
|
public function outputToBrowser() {
|
|
$prevState = SSViewer::get_source_file_comments();
|
|
SSViewer::set_source_file_comments(false);
|
|
|
|
if(is_int($this->lastModified)) {
|
|
HTTP::register_modification_timestamp($this->lastModified);
|
|
header('Last-Modified: ' . gmdate("D, d M Y H:i:s", $this->lastModified) . ' GMT');
|
|
}
|
|
if(!empty($this->etag)) {
|
|
HTTP::register_etag($this->etag);
|
|
}
|
|
|
|
if(!headers_sent()) {
|
|
HTTP::add_cache_headers();
|
|
header("Content-type: text/xml");
|
|
}
|
|
|
|
SSViewer::set_source_file_comments($prevState);
|
|
|
|
return $this->renderWith($this->getTemplate());
|
|
}
|
|
|
|
/**
|
|
* Set the name of the template to use. Actual template will be resolved
|
|
* via the standard template inclusion process.
|
|
*
|
|
* @param string
|
|
*/
|
|
public function setTemplate($template) {
|
|
$this->template = $template;
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the template to use.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getTemplate() {
|
|
return $this->template;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* RSSFeed_Entry class
|
|
*
|
|
* This class is used for entries of an RSS feed.
|
|
*
|
|
* @see RSSFeed
|
|
* @package framework
|
|
* @subpackage integration
|
|
*/
|
|
class RSSFeed_Entry extends ViewableData {
|
|
/**
|
|
* The object that represents the item, it contains all the data.
|
|
*
|
|
* @var mixed
|
|
*/
|
|
protected $failover;
|
|
|
|
/**
|
|
* Name of the title field of feed entries
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $titleField;
|
|
|
|
/**
|
|
* Name of the description field of feed entries
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $descriptionField;
|
|
|
|
/**
|
|
* Name of the author field of feed entries
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $authorField;
|
|
|
|
/**
|
|
* Create a new RSSFeed entry.
|
|
*/
|
|
function __construct($entry, $titleField, $descriptionField,
|
|
$authorField) {
|
|
$this->failover = $entry;
|
|
$this->titleField = $titleField;
|
|
$this->descriptionField = $descriptionField;
|
|
$this->authorField = $authorField;
|
|
|
|
parent::__construct();
|
|
}
|
|
|
|
/**
|
|
* Get the description of this entry
|
|
*
|
|
* @return string Returns the description of the entry.
|
|
*/
|
|
function Title() {
|
|
return $this->rssField($this->titleField, 'Varchar');
|
|
}
|
|
|
|
/**
|
|
* Get the description of this entry
|
|
*
|
|
* @return string Returns the description of the entry.
|
|
*/
|
|
function Description() {
|
|
return $this->rssField($this->descriptionField, 'Text');
|
|
}
|
|
|
|
/**
|
|
* Get the author of this entry
|
|
*
|
|
* @return string Returns the author of the entry.
|
|
*/
|
|
function Author() {
|
|
if($this->authorField) return $this->failover->obj($this->authorField);
|
|
}
|
|
|
|
/**
|
|
* Return the named field as an obj() call from $this->failover.
|
|
* Default to the given class if there's no casting information.
|
|
*/
|
|
function rssField($fieldName, $defaultClass = 'Varchar') {
|
|
if($fieldName) {
|
|
if($this->failover->castingHelper($fieldName)) {
|
|
$value = $this->failover->$fieldName;
|
|
$obj = $this->failover->obj($fieldName);
|
|
$obj->setValue($value);
|
|
return $obj;
|
|
} else {
|
|
$obj = new $defaultClass($fieldName);
|
|
$obj->setValue($this->failover->XML_val($fieldName));
|
|
return $obj;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get a link to this entry
|
|
*
|
|
* @return string Returns the URL of this entry
|
|
*/
|
|
function AbsoluteLink() {
|
|
if($this->failover->hasMethod('AbsoluteLink')) return $this->failover->AbsoluteLink();
|
|
else if($this->failover->hasMethod('Link')) return Director::absoluteURL($this->failover->Link());
|
|
else user_error($this->failover->class . " object has neither an AbsoluteLink nor a Link method. Can't put a link in the RSS feed", E_USER_WARNING);
|
|
}
|
|
}
|