MediaWiki  REL1_24
SearchUpdate Class Reference

Database independant search index updater. More...

Inheritance diagram for SearchUpdate:
Collaboration diagram for SearchUpdate:

List of all members.

Public Member Functions

 __construct ($id, $title, $c=false)
 Constructor.
 doUpdate ()
 Perform actual update for the entry.

Static Public Member Functions

static updateText ($text)
 Clean text for indexing.

Private Member Functions

 indexTitle (SearchEngine $search)
 Get a string representation of a title suitable for including in a search index.

Private Attributes

Content bool $content
 Content of the page (not text) *.
int $id = 0
 Page id being updated *.
Title $title
 Title we're updating *.

Detailed Description

Database independant search index updater.

Definition at line 31 of file SearchUpdate.php.


Constructor & Destructor Documentation

SearchUpdate::__construct ( id,
title,
c = false 
)

Constructor.

Parameters:
int$idPage id to update
Title | string$titleTitle of page to update
Content | string | bool$cContent of the page to update. Default: false. If a Content object, text will be gotten from it. String is for back-compat. Passing false tells the backend to just update the title, not the content

Definition at line 47 of file SearchUpdate.php.


Member Function Documentation

Perform actual update for the entry.

Implements DeferrableUpdate.

Definition at line 71 of file SearchUpdate.php.

SearchUpdate::indexTitle ( SearchEngine search) [private]

Get a string representation of a title suitable for including in a search index.

Parameters:
SearchEngine$search
Returns:
string A stripped-down title string ready for the search index

Definition at line 184 of file SearchUpdate.php.

static SearchUpdate::updateText ( text) [static]

Clean text for indexing.

Only really suitable for indexing in databases. If you're using a real search engine, you'll probably want to override this behavior and do something nicer with the original wikitext.

Parameters:
string$text
Returns:
string

Definition at line 118 of file SearchUpdate.php.

Referenced by SearchUpdateTest\updateText().


Member Data Documentation

Content bool SearchUpdate::$content [private]

Content of the page (not text) *.

Definition at line 36 of file SearchUpdate.php.

int SearchUpdate::$id = 0 [private]

Page id being updated *.

Definition at line 32 of file SearchUpdate.php.

Title SearchUpdate::$title [private]

Title we're updating *.

Definition at line 34 of file SearchUpdate.php.


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