coding style & doxygen tweaks
authorJack Phoenix <ashley@users.mediawiki.org>
Sat, 29 May 2010 23:45:02 +0000 (23:45 +0000)
committerJack Phoenix <ashley@users.mediawiki.org>
Sat, 29 May 2010 23:45:02 +0000 (23:45 +0000)
includes/SiteStats.php

index 2c6528e..b07bdbb 100644 (file)
@@ -104,23 +104,27 @@ class SiteStats {
         */
        static function admins() {
                wfDeprecated(__METHOD__);
-               return self::numberingroup('sysop');
+               return self::numberingroup( 'sysop' );
        }
 
        /**
         * Find the number of users in a given user group.
-        * @param string $group Name of group
-        * @return int
+        * @param $group String: name of group
+        * @return Integer
         */
-       static function numberingroup($group) {
+       static function numberingroup( $group ) {
                if ( !isset( self::$groupMemberCounts[$group] ) ) {
                        global $wgMemc;
                        $key = wfMemcKey( 'SiteStats', 'groupcounts', $group );
                        $hit = $wgMemc->get( $key );
                        if ( !$hit ) {
                                $dbr = wfGetDB( DB_SLAVE );
-                               $hit = $dbr->selectField( 'user_groups', 'COUNT(*)',
-                                       array( 'ug_group' => $group ), __METHOD__ );
+                               $hit = $dbr->selectField(
+                                       'user_groups',
+                                       'COUNT(*)',
+                                       array( 'ug_group' => $group ),
+                                       __METHOD__
+                               );
                                $wgMemc->set( $key, $hit, 3600 );
                        }
                        self::$groupMemberCounts[$group] = $hit;
@@ -131,9 +135,9 @@ class SiteStats {
        static function jobs() {
                if ( !isset( self::$jobs ) ) {
                        $dbr = wfGetDB( DB_SLAVE );
-                       self::$jobs = $dbr->estimateRowCount('job');
+                       self::$jobs = $dbr->estimateRowCount( 'job' );
                        /* Zero rows still do single row read for row that doesn't exist, but people are annoyed by that */
-                       if (self::$jobs == 1) {
+                       if ( self::$jobs == 1 ) {
                                self::$jobs = 0;
                        }
                }
@@ -144,7 +148,12 @@ class SiteStats {
                wfProfileIn( __METHOD__ );
                if( !isset( self::$pageCount[$ns] ) ) {
                        $dbr = wfGetDB( DB_SLAVE );
-                       $pageCount[$ns] = (int)$dbr->selectField( 'page', 'COUNT(*)', array( 'page_namespace' => $ns ), __METHOD__ );
+                       $pageCount[$ns] = (int)$dbr->selectField(
+                               'page',
+                               'COUNT(*)',
+                               array( 'page_namespace' => $ns ),
+                               __METHOD__
+                       );
                }
                wfProfileOut( __METHOD__ );
                return $pageCount[$ns];
@@ -163,7 +172,7 @@ class SiteStats {
                foreach( array( 'total_views', 'total_edits', 'good_articles',
                'total_pages', 'users', 'admins', 'images' ) as $member ) {
                        if(
-                                  $row->{"ss_$member"} > 2000000000
+                               $row->{"ss_$member"} > 2000000000
                                or $row->{"ss_$member"} < 0
                        ) {
                                return false;
@@ -225,15 +234,24 @@ class SiteStatsUpdate {
        }
 
        public static function cacheUpdate( $dbw ) {
-               $dbr = wfGetDB( DB_SLAVE, array( 'SpecialStatistics', 'vslow') );
+               $dbr = wfGetDB( DB_SLAVE, array( 'SpecialStatistics', 'vslow' ) );
                # Get non-bot users than did some recent action other than making accounts.
                # If account creation is included, the number gets inflated ~20+ fold on enwiki.
-               $activeUsers = $dbr->selectField( 'recentchanges', 'COUNT( DISTINCT rc_user_text )',
-                       array( 'rc_user != 0', 'rc_bot' => 0, "rc_log_type != 'newusers' OR rc_log_type IS NULL" ),
-                       __METHOD__ );
-               $dbw->update( 'site_stats',
-                       array( 'ss_active_users' => intval($activeUsers) ),
-                       array( 'ss_row_id' => 1 ), __METHOD__
+               $activeUsers = $dbr->selectField(
+                       'recentchanges',
+                       'COUNT( DISTINCT rc_user_text )',
+                       array(
+                               'rc_user != 0',
+                               'rc_bot' => 0,
+                               "rc_log_type != 'newusers' OR rc_log_type IS NULL"
+                       ),
+                       __METHOD__
+               );
+               $dbw->update(
+                       'site_stats',
+                       array( 'ss_active_users' => intval( $activeUsers ) ),
+                       array( 'ss_row_id' => 1 ),
+                       __METHOD__
                );
                return $activeUsers;
        }
@@ -244,7 +262,7 @@ class SiteStatsUpdate {
  */
 class SiteStatsInit {
 
-       // Db connection
+       // Database connection
        private $db;
 
        // Various stats
@@ -252,7 +270,7 @@ class SiteStatsInit {
 
        /**
         * Constructor
-        * @param $useMaster bool Whether to use the master db
+        * @param $useMaster Boolean: whether to use the master DB
         */
        public function __construct( $useMaster = false ) {
                $this->db = wfGetDB( $useMaster ? DB_MASTER : DB_SLAVE );
@@ -260,7 +278,7 @@ class SiteStatsInit {
 
        /**
         * Count the total number of edits
-        * @return int
+        * @return Integer
         */
        public function edits() {
                $this->mEdits = $this->db->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
@@ -269,18 +287,27 @@ class SiteStatsInit {
        }
 
        /**
-        * Count pages in article space
-        * @return int
+        * Count pages in article space(s)
+        * @return Integer
         */
        public function articles() {
                global $wgContentNamespaces;
-               $this->mArticles = $this->db->selectField( 'page', 'COUNT(*)', array( 'page_namespace' => $wgContentNamespaces, 'page_is_redirect' => 0, 'page_len > 0' ), __METHOD__ );
+               $this->mArticles = $this->db->selectField(
+                       'page',
+                       'COUNT(*)',
+                       array(
+                               'page_namespace' => $wgContentNamespaces,
+                               'page_is_redirect' => 0,
+                               'page_len > 0'
+                       ),
+                       __METHOD__
+               );
                return $this->mArticles;
        }
 
        /**
         * Count total pages
-        * @return int
+        * @return Integer
         */
        public function pages() {
                $this->mPages = $this->db->selectField( 'page', 'COUNT(*)', '', __METHOD__ );
@@ -289,7 +316,7 @@ class SiteStatsInit {
        
        /**
         * Count total users
-        * @return int
+        * @return Integer
         */
        public function users() {
                $this->mUsers = $this->db->selectField( 'user', 'COUNT(*)', '', __METHOD__ );
@@ -298,7 +325,7 @@ class SiteStatsInit {
        
        /**
         * Count views
-        * @return int
+        * @return Integer
         */
        public function views() {
                $this->mViews = $this->db->selectField( 'page', 'SUM(page_counter)', '', __METHOD__ );
@@ -307,7 +334,7 @@ class SiteStatsInit {
 
        /**
         * Count total files
-        * @return int
+        * @return Integer
         */
        public function files() {
                $this->mFiles = $this->db->selectField( 'image', 'COUNT(*)', '', __METHOD__ );
@@ -317,9 +344,9 @@ class SiteStatsInit {
        /**
         * Do all updates and commit them. More or less a replacement
         * for the original initStats, but without the calls to wfOut()
-        * @param $update bool Whether to update the current stats or write fresh
-        * @param $noViews bool When true, do not update the number of page views
-        * @param $activeUsers Whether to update the number of active users
+        * @param $update Boolean: whether to update the current stats or write fresh
+        * @param $noViews Boolean: when true, do not update the number of page views
+        * @param $activeUsers Boolean: whether to update the number of active users
         */
        public static function doAllAndCommit( $update, $noViews = false, $activeUsers = false ) {
                // Grab the object and count everything
@@ -331,18 +358,21 @@ class SiteStatsInit {
                $counter->files();
 
                // Only do views if we don't want to not count them
-               if( !$noViews )
+               if( !$noViews ) {
                        $counter->views();
+               }
 
                // Update/refresh
-               if( $update )
+               if( $update ) {
                        $counter->update();
-               else
+               } else {
                        $counter->refresh();
+               }
 
                // Count active users if need be
-               if( $activeUsers )
+               if( $activeUsers ) {
                        SiteStatsUpdate::cacheUpdate( wfGetDB( DB_MASTER ) );
+               }
        }
 
        /**
@@ -367,14 +397,16 @@ class SiteStatsInit {
 
        /**
         * Return three arrays of params for the db queries
-        * @return array
+        * @return Array
         */
        private function getDbParams() {
-               $values = array( 'ss_total_edits' => $this->mEdits,
-                                               'ss_good_articles' => $this->mArticles,
-                                               'ss_total_pages' => $this->mPages,
-                                               'ss_users' => $this->mUsers,
-                                               'ss_images' => $this->mFiles );
+               $values = array(
+                       'ss_total_edits' => $this->mEdits,
+                       'ss_good_articles' => $this->mArticles,
+                       'ss_total_pages' => $this->mPages,
+                       'ss_users' => $this->mUsers,
+                       'ss_images' => $this->mFiles
+               );
                $conds = array( 'ss_row_id' => 1 );
                $views = array( 'ss_total_views' => $this->mViews );
                return array( $values, $conds, $views );