MediaWiki  1.23.8
RebuildTextIndex Class Reference

Maintenance script that rebuilds search index table from scratch. More...

Inheritance diagram for RebuildTextIndex:
Collaboration diagram for RebuildTextIndex:

Public Member Functions

 __construct ()
 Default constructor. More...
 
 execute ()
 Do the actual work. More...
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 
- Public Member Functions inherited from Maintenance
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
 getName ()
 Get the script's name. More...
 
 globals ()
 Potentially debug globals. More...
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More...
 
 loadSettings ()
 Generic setup for most installs. More...
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 
 setDB (&$db)
 Sets database object to be returned by getDB(). More...
 
 setup ()
 Do some sanity checking and basic setup. More...
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...
 

Public Attributes

const RTI_CHUNK_SIZE = 500
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
const DB_STD = 1
 
const STDIN_ALL = 'all'
 

Protected Member Functions

 populateSearchIndex ()
 Populates the search index with content from all pages. More...
 
- Protected Member Functions inherited from Maintenance
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 
 addDescription ( $text)
 Set the description text. More...
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false)
 Add a parameter to the script. More...
 
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
getDB ( $db, $groups=array(), $wiki=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 
 getStdin ( $len=null)
 Return input from stdin. More...
 
 hasArg ( $argId=0)
 Does a given argument exist? More...
 
 hasOption ( $name)
 Checks to see if a particular param exists. More...
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 

Private Member Functions

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

Private Attributes

DatabaseBase $db
 

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...
 
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
 
static shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More...
 
- Protected Attributes inherited from Maintenance
 $mArgList = array()
 
 $mArgs = array()
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = array()
 
 $mParams = array()
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = array()
 

Detailed Description

Maintenance script that rebuilds search index table from scratch.

Definition at line 35 of file rebuildtextindex.php.

Constructor & Destructor Documentation

◆ __construct()

RebuildTextIndex::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 42 of file rebuildtextindex.php.

Member Function Documentation

◆ clearSearchIndex()

RebuildTextIndex::clearSearchIndex ( )
private

Deletes everything from search index.

Definition at line 151 of file rebuildtextindex.php.

References Maintenance\output().

Referenced by execute().

◆ createMysqlTextIndex()

RebuildTextIndex::createMysqlTextIndex ( )
private

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

Definition at line 140 of file rebuildtextindex.php.

References Maintenance\output().

Referenced by execute().

◆ dropMysqlTextIndex()

RebuildTextIndex::dropMysqlTextIndex ( )
private

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

Definition at line 128 of file rebuildtextindex.php.

References Maintenance\output().

Referenced by execute().

◆ execute()

RebuildTextIndex::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 51 of file rebuildtextindex.php.

References clearSearchIndex(), createMysqlTextIndex(), DB_MASTER, dropMysqlTextIndex(), Maintenance\error(), DatabaseSqlite\getFulltextSearchModule(), Maintenance\output(), populateSearchIndex(), and wfGetDB().

◆ getDbType()

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
Integer

Reimplemented from Maintenance.

Definition at line 47 of file rebuildtextindex.php.

References Maintenance\DB_ADMIN.

◆ populateSearchIndex()

RebuildTextIndex::populateSearchIndex ( )
protected

Populates the search index with content from all pages.

Definition at line 83 of file rebuildtextindex.php.

References $count, $n, $res, $rev, $s, $title, array(), as, Title\makeTitle(), Maintenance\output(), RTI_CHUNK_SIZE, Revision\selectFields(), Revision\selectPageFields(), and Revision\selectTextFields().

Referenced by execute().

Member Data Documentation

◆ $db

DatabaseBase RebuildTextIndex::$db
private

Definition at line 40 of file rebuildtextindex.php.

◆ RTI_CHUNK_SIZE

const RebuildTextIndex::RTI_CHUNK_SIZE = 500

Definition at line 36 of file rebuildtextindex.php.

Referenced by populateSearchIndex().


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