RebuildTextIndex Class Reference

Rebuild search index table from scratch. More...

Inherits Maintenance.

List of all members.

Public Member Functions

 __construct ()
 Default constructor.
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 execute ()
 Do the actual work.

Public Attributes

const RTI_CHUNK_SIZE = 500

Protected Member Functions

 populateSearchIndex ()
 Populates the search index with content from all pages.

Private Member Functions

 dropMysqlTextIndex ()
 (MySQL only) Drops fulltext index before populating the table.
 createMysqlTextIndex ()
 (MySQL only) Adds back fulltext index after populating the table.
 clearSearchIndex ()
 Deletes everything from search index.

Private Attributes

 $db


Detailed Description

Rebuild search index table from scratch.

This may take several hours, depending on the database size and server configuration.

Postgres is trigger-based and should never need rebuilding.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Todo:
document

Definition at line 29 of file rebuildtextindex.php.


Constructor & Destructor Documentation

RebuildTextIndex::__construct (  ) 

Default constructor.

Children should call this if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 33 of file rebuildtextindex.php.


Member Function Documentation

RebuildTextIndex::clearSearchIndex (  )  [private]

Deletes everything from search index.

Definition at line 121 of file rebuildtextindex.php.

References Maintenance::output().

Referenced by execute().

RebuildTextIndex::createMysqlTextIndex (  )  [private]

(MySQL only) Adds back fulltext index after populating the table.

Definition at line 110 of file rebuildtextindex.php.

References Maintenance::output().

Referenced by execute().

RebuildTextIndex::dropMysqlTextIndex (  )  [private]

(MySQL only) Drops fulltext index before populating the table.

Definition at line 98 of file rebuildtextindex.php.

References Maintenance::output().

Referenced by execute().

RebuildTextIndex::execute (  ) 

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 42 of file rebuildtextindex.php.

References $wgDBtype, $wgTitle, clearSearchIndex(), createMysqlTextIndex(), dropMysqlTextIndex(), Maintenance::error(), Title::newFromText(), Maintenance::output(), populateSearchIndex(), and wfGetDB().

RebuildTextIndex::getDbType (  ) 

Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Returns:
int

Reimplemented from Maintenance.

Definition at line 38 of file rebuildtextindex.php.

References Maintenance::DB_ADMIN.

RebuildTextIndex::populateSearchIndex (  )  [protected]

Populates the search index with content from all pages.

Definition at line 68 of file rebuildtextindex.php.

References $n, $res, $s, Revision::getRevisionText(), and Maintenance::output().

Referenced by execute().


Member Data Documentation

RebuildTextIndex::$db [private]

Definition at line 31 of file rebuildtextindex.php.

Definition at line 30 of file rebuildtextindex.php.


The documentation for this class was generated from the following file:

Generated on Sat Apr 30 22:57:47 2011 for MediaWiki by  doxygen 1.5.9