SearchUpdate Class Reference

Database independant search index updater. More...

Inheritance diagram for SearchUpdate:

Collaboration diagram for SearchUpdate:

Public Member Functions
	__construct ($id, $title, $c=false)
	Constructor. More...
	doUpdate ()
	Perform actual update for the entry. More...
	updateText ($text, SearchEngine $se=null)
	Clean text for indexing. More...

Private Member Functions
	getLatestPage ()
	Get WikiPage for the SearchUpdate $id using WikiPage::READ_LATEST and ensure using the same WikiPage object if there are multiple SearchEngine types. More...
	getNormalizedTitle (SearchEngine $search)
	Get a normalized string representation of a title suitable for including in a search index. More...

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

Detailed Description

Database independant search index updater.

Definition at line 33 of file SearchUpdate.php.

Constructor & Destructor Documentation

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

Constructor.

Parameters

int	$id	Page id to update
Title | string	$title	Title of page to update
Content | string | bool	$c	Content 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 55 of file SearchUpdate.php.

References $id, $title, content, Title\newFromText(), title, and wfDebug().

Member Function Documentation

SearchUpdate::doUpdate

(

)

Perform actual update for the entry.

Implements DeferrableUpdate.

Definition at line 79 of file SearchUpdate.php.

References $id, $type, as, content, getLatestPage(), getNormalizedTitle(), title, and updateText().

Referenced by Maintenance\updateSearchIndexForPage().

SearchUpdate::getLatestPage ( )

private

Get WikiPage for the SearchUpdate $id using WikiPage::READ_LATEST and ensure using the same WikiPage object if there are multiple SearchEngine types.

Returns null if a page has been deleted or is not found.

Returns

WikiPage|null

Definition at line 190 of file SearchUpdate.php.

References $page, WikiPage\newFromID(), and page.

Referenced by doUpdate().

SearchUpdate::getNormalizedTitle ( SearchEngine  $search )

private

Get a normalized 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 205 of file SearchUpdate.php.

References $t, $wgContLang, global, SearchEngine\legalSearchChars(), SearchEngine\normalizeText(), NS_FILE, and title.

Referenced by doUpdate().

SearchUpdate::updateText	(		$text,
		SearchEngine	$se = null
	)

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
SearchEngine	$se	Search engine

Returns

string

Definition at line 122 of file SearchUpdate.php.

References $wgContLang, and global.

Referenced by doUpdate().

Member Data Documentation

Content bool SearchUpdate::$content

private

Content of the page (not text)

Definition at line 41 of file SearchUpdate.php.

int SearchUpdate::$id = 0

private

Page id being updated.

Definition at line 35 of file SearchUpdate.php.

Referenced by __construct(), and doUpdate().

WikiPage SearchUpdate::$page

private

Definition at line 44 of file SearchUpdate.php.

Referenced by getLatestPage().

Title SearchUpdate::$title

private

Title we're updating.

Definition at line 38 of file SearchUpdate.php.

Referenced by __construct().

---

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

• includes/deferred/SearchUpdate.php