Documentation
authorSam Reed <reedy@users.mediawiki.org>
Sun, 13 Mar 2011 21:17:37 +0000 (21:17 +0000)
committerSam Reed <reedy@users.mediawiki.org>
Sun, 13 Mar 2011 21:17:37 +0000 (21:17 +0000)
includes/LogEventsList.php

index 96900cb..112bc17 100644 (file)
@@ -27,10 +27,27 @@ class LogEventsList {
        const NO_ACTION_LINK = 1;
        const NO_EXTRA_USER_LINKS = 2;
 
+       /**
+        * @var Skin
+        */
        private $skin;
+
+       /**
+        * @var OutputPage
+        */
        private $out;
        public $flags;
 
+       /**
+        * @var Array
+        */
+       protected $message;
+
+       /**
+        * @var Array
+        */
+       protected $mDefaultQuery;
+
        public function __construct( $skin, $out, $flags = 0 ) {
                $this->skin = $skin;
                $this->out = $out;
@@ -82,8 +99,7 @@ class LogEventsList {
         * @param $tagFilter: array?
         */
        public function showOptions( $types=array(), $user='', $page='', $pattern='', $year='', 
-               $month = '', $filter = null, $tagFilter='' )
-       {
+               $month = '', $filter = null, $tagFilter='' ) {
                global $wgScript, $wgMiserMode;
 
                $action = $wgScript;
@@ -357,7 +373,15 @@ class LogEventsList {
                return $comment;
        }
 
-       // @TODO: split up!
+       /**
+        * @TODO: split up!
+        *
+        * @param  $row
+        * @param Title $title
+        * @param Array $paramArray
+        * @param  $comment
+        * @return String
+        */
        private function logActionLinks( $row, $title, $paramArray, &$comment ) {
                global $wgUser;
                if( ( $this->flags & self::NO_ACTION_LINK ) // we don't want to see the action
@@ -506,8 +530,7 @@ class LogEventsList {
        private function getShowHideLinks( $row ) {
                global $wgUser;
                if( ( $this->flags & self::NO_ACTION_LINK ) // we don't want to see the links
-                       || $row->log_type == 'suppress' ) // no one can hide items from the suppress log
-               {
+                       || $row->log_type == 'suppress' ) { // no one can hide items from the suppress log
                        return '';
                }
                $del = '';
@@ -758,8 +781,7 @@ class LogPager extends ReverseChronologicalPager {
         * @param $tagFilter String: tag
         */
        public function __construct( $list, $types = array(), $user = '', $title = '', $pattern = '',
-               $conds = array(), $year = false, $month = false, $tagFilter = '' ) 
-       {
+               $conds = array(), $year = false, $month = false, $tagFilter = '' ) {
                parent::__construct();
                $this->mConds = $conds;
 
@@ -878,8 +900,9 @@ class LogPager extends ReverseChronologicalPager {
                global $wgMiserMode, $wgUser;
 
                $title = Title::newFromText( $page );
-               if( strlen( $page ) == 0 || !$title instanceof Title )
+               if( strlen( $page ) == 0 || !$title instanceof Title ) {
                        return false;
+               }
 
                $this->title = $title->getPrefixedText();
                $ns = $title->getNamespace();