Now it is straightforward to fix bug 89, subst: template parameters.

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

diff --git a/includes/RecentChange.php b/includes/RecentChange.php
index 11931c5..1dba1ea 100644 (file)
--- a/includes/RecentChange.php
+++ b/includes/RecentChange.php
@@ -1,6 +1,12 @@
 <?php
-# Utility class for creating new RC entries
-
+/**
+ *
+ * @package MediaWiki
+ */
+
+/**
+ * Various globals
+ */
 define( 'RC_EDIT', 0);
 define( 'RC_NEW', 1);
 define( 'RC_MOVE', 2);
@@ -8,32 +14,35 @@ define( 'RC_LOG', 3);
 define( 'RC_MOVE_OVER_REDIRECT', 4);
 
 
-/*
-mAttributes:
-       rc_id           id of the row in the recentchanges table
-       rc_timestamp    time the entry was made
-       rc_cur_time     timestamp on the cur row
-       rc_namespace    namespace #
-       rc_title        non-prefixed db key
-       rc_type         is new entry, used to determine whether updating is necessary
-       rc_minor        is minor
-       rc_cur_id       id of associated cur entry
-       rc_user         user id who made the entry
-       rc_user_text    user name who made the entry
-       rc_comment      edit summary
-       rc_this_oldid   old_id associated with this entry (or zero)
-       rc_last_oldid   old_id associated with the entry before this one (or zero)
-       rc_bot          is bot, hidden
-       rc_ip           IP address of the user in dotted quad notation
-       rc_new          obsolete, use rc_type==RC_NEW
-       rc_patrolled    boolean whether or not someone has marked this edit as patrolled
-
-mExtra:
-       prefixedDBkey   prefixed db key, used by external app via msg queue
-       lastTimestamp   timestamp of previous entry, used in WHERE clause during update
-       lang            the interwiki prefix, automatically set in save()
-*/
-
+/**
+ * Utility class for creating new RC entries
+ * mAttributes:
+ *     rc_id           id of the row in the recentchanges table
+ *     rc_timestamp    time the entry was made
+ *     rc_cur_time     timestamp on the cur row
+ *     rc_namespace    namespace #
+ *     rc_title        non-prefixed db key
+ *     rc_type         is new entry, used to determine whether updating is necessary
+ *     rc_minor        is minor
+ *     rc_cur_id       id of associated cur entry
+ *     rc_user         user id who made the entry
+ *     rc_user_text    user name who made the entry
+ *     rc_comment      edit summary
+ *     rc_this_oldid   old_id associated with this entry (or zero)
+ *     rc_last_oldid   old_id associated with the entry before this one (or zero)
+ *     rc_bot          is bot, hidden
+ *     rc_ip           IP address of the user in dotted quad notation
+ *     rc_new          obsolete, use rc_type==RC_NEW
+ *     rc_patrolled    boolean whether or not someone has marked this edit as patrolled
+ * 
+ * mExtra:
+ *     prefixedDBkey   prefixed db key, used by external app via msg queue
+ *     lastTimestamp   timestamp of previous entry, used in WHERE clause during update
+ *     lang            the interwiki prefix, automatically set in save()
+ * 
+ * @todo document functions and variables
+ * @package MediaWiki
+ */
 class RecentChange
 {
        var $mAttribs = array(), $mExtra = array();
@@ -190,6 +199,7 @@ class RecentChange
                        'rc_moved_to_ns'        => 0,
                        'rc_moved_to_title'     => '',
                        'rc_ip' => $ip,
+                       'rc_patrolled' => 0,
                        'rc_new'        => 0 # obsolete
                );
 
@@ -230,6 +240,7 @@ class RecentChange
                        'rc_moved_to_ns'    => 0,
                        'rc_moved_to_title' => '',
                        'rc_ip'             => $ip,
+                       'rc_patrolled'      => 0,
                        'rc_new'        => 1 # obsolete
                );
 
@@ -357,8 +368,10 @@ class RecentChange
        }
 
 
-       # Gets the end part of the diff URL assoicated with this object
-       # Blank if no diff link should be displayed
+       /**
+        * Gets the end part of the diff URL assoicated with this object
+        * Blank if no diff link should be displayed
+        */
        function diffLinkTrail( $forceCur )
        {
                if ( $this->mAttribs['rc_type'] == RC_EDIT ) {