MediaWiki  REL1_20
UpdateSearchIndex Class Reference

Maintenance script for periodic off-peak updating of the search index. More...

Inheritance diagram for UpdateSearchIndex:
Collaboration diagram for UpdateSearchIndex:

List of all members.

Public Member Functions

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

Private Member Functions

 doUpdateSearchIndex ($start, $end, $maxLockTime)

Detailed Description

Maintenance script for periodic off-peak updating of the search index.

Definition at line 38 of file updateSearchIndex.php.


Constructor & Destructor Documentation

Default constructor.

Children should call this *first* if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 40 of file updateSearchIndex.php.

References Maintenance\addOption().


Member Function Documentation

UpdateSearchIndex::doUpdateSearchIndex ( start,
end,
maxLockTime 
) [private]

Definition at line 84 of file updateSearchIndex.php.

References $page, $res, Maintenance\output(), Maintenance\updateSearchIndex(), and wfGetDB().

Referenced by execute().

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 53 of file updateSearchIndex.php.

References $file, doUpdateSearchIndex(), Maintenance\error(), Maintenance\getOption(), Maintenance\hasOption(), wfTimestamp(), and wfTimestampNow().

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 49 of file updateSearchIndex.php.

References Maintenance\DB_ADMIN.


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