Fix issues identified by SpaceBeforeSingleLineComment sniff
[lhc/web/wiklou.git] / maintenance / storage / compressOld.php
index cfffbbc..16c676d 100644 (file)
@@ -50,9 +50,15 @@ require_once __DIR__ . '/../Maintenance.php';
  */
 class CompressOld extends Maintenance {
        /**
-        * @todo document
+        * Option to load each revision individually.
+        *
         */
        const LS_INDIVIDUAL = 0;
+
+       /**
+        * Option to load revisions in chunks.
+        *
+        */
        const LS_CHUNKED = 1;
 
        public function __construct() {
@@ -137,7 +143,8 @@ class CompressOld extends Maintenance {
        }
 
        /**
-        * @todo document
+        * Fetch the text row-by-row to 'compressPage' function for compression.
+        *
         * @param int $start
         * @param string $extdb
         */
@@ -172,7 +179,8 @@ class CompressOld extends Maintenance {
        }
 
        /**
-        * @todo document
+        * Compress the text in gzip format.
+        *
         * @param stdClass $row
         * @param string $extdb
         * @return bool
@@ -181,7 +189,7 @@ class CompressOld extends Maintenance {
                if ( false !== strpos( $row->old_flags, 'gzip' )
                        || false !== strpos( $row->old_flags, 'object' )
                ) {
-                       #print "Already compressed row {$row->old_id}\n";
+                       # print "Already compressed row {$row->old_id}\n";
                        return false;
                }
                $dbw = wfGetDB( DB_MASTER );
@@ -214,6 +222,8 @@ class CompressOld extends Maintenance {
        }
 
        /**
+        * Compress the text in chunks after concatenating the revisions.
+        *
         * @param int $startId
         * @param int $maxChunkSize
         * @param string $beginDate
@@ -293,8 +303,8 @@ class CompressOld extends Maintenance {
 
                # Don't work with current revisions
                # Don't lock the page table for update either -- TS 2006-04-04
-               #$tables[] = 'page';
-               #$conds[] = 'page_id=rev_page AND rev_id != page_latest';
+               # $tables[] = 'page';
+               # $conds[] = 'page_id=rev_page AND rev_id != page_latest';
 
                for ( $pageId = $startId; $pageId <= $maxPageId; $pageId++ ) {
                        wfWaitForSlaves();
@@ -374,7 +384,7 @@ class CompressOld extends Maintenance {
 
                                        if ( $text === false ) {
                                                $this->error( "\nError, unable to get text in old_id $oldid" );
-                                               #$dbw->delete( 'old', array( 'old_id' => $oldid ) );
+                                               # $dbw->delete( 'old', array( 'old_id' => $oldid ) );
                                        }
 
                                        if ( $extdb == "" && $j == 0 ) {