Fix message cache expiry semantics
[lhc/web/wiklou.git] / includes / Feed.php
index f9dbf5b..caf2e57 100644 (file)
@@ -52,11 +52,11 @@ class FeedItem {
        /**
         * Constructor
         *
-        * @param $title String|Title Item's title
+        * @param string|Title $title Item's title
         * @param $description String
-        * @param $url String: URL uniquely designating the item.
-        * @param $date String: Item's date
-        * @param $author String: Author's user name
+        * @param string $url URL uniquely designating the item.
+        * @param string $date Item's date
+        * @param string $author Author's user name
         * @param $comments String
         */
        function __construct( $title, $description, $url, $date = '', $author = '', $comments = '' ) {
@@ -72,7 +72,7 @@ class FeedItem {
        /**
         * Encode $string so that it can be safely embedded in a XML document
         *
-        * @param $string String: string to encode
+        * @param string $string string to encode
         * @return String
         */
        public function xmlEncode( $string ) {
@@ -95,7 +95,7 @@ class FeedItem {
        /**
         * set the unique id of an item
         *
-        * @param $uniqueId String: unique id for the item
+        * @param string $uniqueId unique id for the item
         * @param $rssIsPermalink Boolean: set to true if the guid (unique id) is a permalink (RSS feeds only)
         */
        public function setUniqueId( $uniqueId, $rssIsPermalink = false ) {
@@ -170,7 +170,7 @@ class FeedItem {
        /**
         * Quickie hack... strip out wikilinks to more legible form from the comment.
         *
-        * @param $text String: wikitext
+        * @param string $text wikitext
         * @return String
         */
        public static function stripComment( $text ) {
@@ -243,9 +243,9 @@ abstract class ChannelFeed extends FeedItem {
         */
        function contentType() {
                global $wgRequest;
-               $ctype = $wgRequest->getVal('ctype','application/xml');
-               $allowedctypes = array('application/xml','text/xml','application/rss+xml','application/atom+xml');
-               return (in_array($ctype, $allowedctypes) ? $ctype : 'application/xml');
+               $ctype = $wgRequest->getVal( 'ctype', 'application/xml' );
+               $allowedctypes = array( 'application/xml', 'text/xml', 'application/rss+xml', 'application/atom+xml' );
+               return (in_array( $ctype, $allowedctypes ) ? $ctype : 'application/xml');
        }
 
        /**
@@ -282,7 +282,7 @@ class RSSFeed extends ChannelFeed {
        }
 
        /**
-        * Ouput an RSS 2.0 header
+        * Output an RSS 2.0 header
         */
        function outHeader() {
                global $wgVersion;
@@ -318,7 +318,7 @@ class RSSFeed extends ChannelFeed {
        }
 
        /**
-        * Ouput an RSS 2.0 footer
+        * Output an RSS 2.0 footer
         */
        function outFooter() {
        ?>
@@ -362,7 +362,7 @@ class AtomFeed extends ChannelFeed {
        }
 
        /**
-        * Atom 1.0 requires a unique, opaque IRI as a unique indentifier
+        * Atom 1.0 requires a unique, opaque IRI as a unique identifier
         * for every feed we create. For now just use the URL, but who
         * can tell if that's right? If we put options on the feed, do we
         * have to change the id? Maybe? Maybe not.
@@ -409,7 +409,7 @@ class AtomFeed extends ChannelFeed {
        }
 
        /**
-        * Outputs the footer for Atom 1.0 feed (basicly '\</feed\>').
+        * Outputs the footer for Atom 1.0 feed (basically '\</feed\>').
         */
        function outFooter() {?>
        </feed><?php