removed a debug output when setting up the dropbox for language variants
[lhc/web/wiklou.git] / includes / Feed.php
index fcb077a..8b36446 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+# $Id$
 # Basic support for outputting syndication feeds in RSS, other formats
 # 
 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
@@ -21,6 +22,7 @@
 
 /**
  * Contain a feed class as well as classes to build rss / atom ... feeds
+ * @package MediaWiki
  */
 
 /**
@@ -33,9 +35,10 @@ $wgFeedClasses = array(
 
 /**
  * @todo document
+ * @package MediaWiki
  */
 class FeedItem {
-       /**@#+
+       /**#@+
         * @var string
         * @access private
         */
@@ -44,7 +47,7 @@ class FeedItem {
        var $Url = '';
        var $Date = '';
        var $Author = '';
-       /**@#-*/
+       /**#@-*/
        
        /**
         * @todo document
@@ -106,35 +109,40 @@ class FeedItem {
 
 /**
  * @todo document
+ * @package MediaWiki
  */
 class ChannelFeed extends FeedItem {
-       /**@#+
+       /**#@+
         * Abstract function, override!
+        * @abstract
         */
         
        /**
-        * @todo document
+        * Generate Header of the feed
         */
        function outHeader() {
                # print "<feed>";
        }
        
        /**
-        * @todo document
+        * Generate an item
+        * @param $item
         */
        function outItem( $item ) {
                # print "<item>...</item>";
        }
        
        /**
-        * @todo document
+        * 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;
@@ -148,24 +156,26 @@ class ChannelFeed extends FeedItem {
                print '<' . '?xml-stylesheet type="text/css" href="' .
                        htmlspecialchars( "$wgServer$wgStylePath/feed.css" ) . '"?' . ">\n";
        }
-       /**@#-*/
 }
 
 /**
  * Generate a RSS feed
  * @todo document
+ * @package MediaWiki
  */
 class RSSFeed extends ChannelFeed {
 
        /**
-        * @todo document
+        * 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 ) );
        }
        
        /**
-        * @todo document
+        * Ouput an RSS 2.0 header
         */
        function outHeader() {
                global $wgVersion;
@@ -183,7 +193,8 @@ class RSSFeed extends ChannelFeed {
        }
        
        /**
-        * @todo document
+        * Output an RSS 2.0 item
+        * @param FeedItem item to be output
         */
        function outItem( $item ) {
        ?>
@@ -199,7 +210,7 @@ class RSSFeed extends ChannelFeed {
        }
 
        /**
-        * @todo document
+        * Ouput an RSS 2.0 footer
         */
        function outFooter() {
        ?>
@@ -211,6 +222,7 @@ class RSSFeed extends ChannelFeed {
 /**
  * Generate an Atom feed
  * @todo document
+ * @package MediaWiki
  */
 class AtomFeed extends ChannelFeed {
        /**
@@ -218,7 +230,7 @@ class AtomFeed extends ChannelFeed {
         */
        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 ) );
        }
 
        /**