Stop loading feed.php every time by moving available feeds classes in defines.php...

[lhc/web/wiklou.git] / includes / Feed.php

diff --git a/includes/Feed.php b/includes/Feed.php
index a34dae4..f154c86 100644 (file)
--- a/includes/Feed.php
+++ b/includes/Feed.php
@@ -1,4 +1,5 @@
 <?php
+# $Id$
 # Basic support for outputting syndication feeds in RSS, other formats
 # 
 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
@@ -20,27 +21,31 @@
 # http://www.gnu.org/copyleft/gpl.html
 
 /**
- * Contain class to build rss / atom ... feeds
+ * Contain a feed class as well as classes to build rss / atom ... feeds
+ * Available feeds are defined in Defines.php
+ * @package MediaWiki
  */
 
-/**
- * Available feeds objects
- */
-$wgFeedClasses = array(
-       'rss' => 'RSSFeed',
-       'atom' => 'AtomFeed',
-       );
 
 /**
  * @todo document
+ * @package MediaWiki
  */
 class FeedItem {
+       /**#@+
+        * @var string
+        * @access private
+        */
        var $Title = 'Wiki';
        var $Description = '';
        var $Url = '';
        var $Date = '';
        var $Author = '';
+       /**#@-*/
        
+       /**
+        * @todo document
+        */
        function FeedItem( $Title, $Description, $Url, $Date = '', $Author = '', $Comments = '' ) {
                $this->Title = $Title;
                $this->Description = $Description;
@@ -50,7 +55,10 @@ class FeedItem {
                $this->Comments = $Comments;
        }
        
-       /* Static... */
+       /**
+        * @static
+        * @todo document
+        */
        function xmlEncode( $string ) {
                global $wgInputEncoding, $wgLang;
                $string = str_replace( "\r\n", "\n", $string );
@@ -59,45 +67,77 @@ class FeedItem {
                }
                return htmlspecialchars( $string );
        }
-       function getTitle() {
-               return $this->xmlEncode( $this->Title );
-       }
-       function getUrl() {
-               return $this->xmlEncode( $this->Url );
-       }
-       function getDescription() {
-               return $this->xmlEncode( $this->Description );
-       }
+       
+       /**
+        * @todo document
+        */
+       function getTitle() { return $this->xmlEncode( $this->Title ); }
+       /**
+        * @todo document
+        */
+       function getUrl() { return $this->xmlEncode( $this->Url ); }
+       /**
+        * @todo document
+        */
+       function getDescription() { return $this->xmlEncode( $this->Description ); }
+       /**
+        * @todo document
+        */
        function getLanguage() {
                global $wgLanguageCode;
                return $wgLanguageCode;
        }
-       function getDate() {
-               return $this->Date;
-       }
-       function getAuthor() {
-               return $this->xmlEncode( $this->Author );
-       }
-       function getComments() {
-               return $this->xmlEncode( $this->Comments );
-       }
+       /**
+        * @todo document
+        */
+       function getDate() { return $this->Date; }
+       /**
+        * @todo document
+        */
+       function getAuthor() { return $this->xmlEncode( $this->Author ); }
+       /**
+        * @todo document
+        */
+       function getComments() { return $this->xmlEncode( $this->Comments ); }
 }
 
 /**
  * @todo document
+ * @package MediaWiki
  */
 class ChannelFeed extends FeedItem {
-       /* Abstract functions, override! */
+       /**#@+
+        * Abstract function, override!
+        * @abstract
+        */
+        
+       /**
+        * Generate Header of the feed
+        */
        function outHeader() {
                # print "<feed>";
        }
+       
+       /**
+        * Generate an item
+        * @param $item
+        */
        function outItem( $item ) {
                # print "<item>...</item>";
        }
+       
+       /**
+        * Generate Footer of the feed
+        */
        function outFooter() {
                # print "</feed>";
        }
+       /**#@-*/
        
+       /**
+        * @todo document
+        * @param string $mimetype (optional) type of output
+        */
        function outXmlHeader( $mimetype='application/xml' ) {
                global $wgServer, $wgStylePath, $wgOut;
                
@@ -115,13 +155,22 @@ class ChannelFeed extends FeedItem {
 /**
  * Generate a RSS feed
  * @todo document
+ * @package MediaWiki
  */
 class RSSFeed extends ChannelFeed {
 
+       /**
+        * Format a date given a timestamp
+        * @param integer $ts Timestamp
+        * @return string Date string
+        */
        function formatTime( $ts ) {
-               return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp2Unix( $ts ) );
+               return gmdate( 'D, d M Y H:i:s \G\M\T', wfTimestamp( TS_UNIX, $ts ) );
        }
        
+       /**
+        * Ouput an RSS 2.0 header
+        */
        function outHeader() {
                global $wgVersion;
                
@@ -137,6 +186,10 @@ class RSSFeed extends ChannelFeed {
 <?php
        }
        
+       /**
+        * Output an RSS 2.0 item
+        * @param FeedItem item to be output
+        */
        function outItem( $item ) {
        ?>
                <item>
@@ -150,6 +203,9 @@ class RSSFeed extends ChannelFeed {
 <?php
        }
 
+       /**
+        * Ouput an RSS 2.0 footer
+        */
        function outFooter() {
        ?>
        </channel>
@@ -160,13 +216,20 @@ class RSSFeed extends ChannelFeed {
 /**
  * Generate an Atom feed
  * @todo document
+ * @package MediaWiki
  */
 class AtomFeed extends ChannelFeed {
+       /**
+        * @todo document
+        */
        function formatTime( $ts ) {
                // need to use RFC 822 time format at least for rss2.0
-               return gmdate( 'Y-m-d\TH:i:s', wfTimestamp2Unix( $ts ) );
+               return gmdate( 'Y-m-d\TH:i:s', wfTimestamp( TS_UNIX, $ts ) );
        }
 
+       /**
+        * @todo document
+        */
        function outHeader() {
                global $wgVersion, $wgOut;
                
@@ -181,6 +244,9 @@ class AtomFeed extends ChannelFeed {
 <?php
        }
        
+       /**
+        * @todo document
+        */
        function outItem( $item ) {
                global $wgMimeType;
        ?>
@@ -202,6 +268,9 @@ class AtomFeed extends ChannelFeed {
       */
        }
        
+       /**
+        * @todo document
+        */
        function outFooter() {?>
        </feed><?php
        }