SearchHighlighter Class Reference

Highlight bits of wikitext. More...

List of all members.

Public Member Functions
	__construct ($cleanupWikitext=true)
	caseCallback ($matches)
	Do manual case conversion for non-ascii chars.
	extract ($text, $start, $end, &$posStart=null, &$posEnd=null)
	Extract part of the text from start to end, but by not chopping up words.
	highlightSimple ($text, $terms, $contextlines, $contextchars)
	Simple & fast snippet extraction, but gives completely unrelevant snippets.
	highlightText ($text, $terms, $contextlines, $contextchars)
	Default implementation of wikitext highlighting.
	linkReplace ($matches)
	callback to replace [[target|caption]] kind of links, if the target is category or image, leave it
	position ($text, $point, $offset=0)
	Find a nonletter near a point (index) in the text.
	process ($pattern, $extracts, &$linesleft, &$contextchars, &$out, &$offsets)
	Search extracts for a pattern, and return snippets.
	removeWiki ($text)
	Basic wikitext removal.
	splitAndAdd (&$extracts, &$count, $text)
	Split text into lines and add it to extracts array.
Public Attributes
	$mCleanWikitext = true

---

Detailed Description

Highlight bits of wikitext.

Definition at line 922 of file SearchEngine.php.

---

Constructor & Destructor Documentation

SearchHighlighter::__construct

(

$

cleanupWikitext = true

)

Definition at line 925 of file SearchEngine.php.

---

Member Function Documentation

SearchHighlighter::caseCallback

(

$

matches

)

Do manual case conversion for non-ascii chars.

Parameters:

$matches

Array

Returns:

string

Definition at line 1195 of file SearchEngine.php.

SearchHighlighter::extract	(	$	text,
		$	start,
		$	end,
		&$	posStart = null,
		&$	posEnd = null
	)

Extract part of the text from start to end, but by not chopping up words.

Parameters:

$text	String
$start	Integer
$end	Integer
$posStart	Integer: (out) actual start position
$posEnd	Integer: (out) actual end position

Returns:

String

Definition at line 1214 of file SearchEngine.php.

SearchHighlighter::highlightSimple	(	$	text,
		$	terms,
		$	contextlines,
		$	contextchars
	)

Simple & fast snippet extraction, but gives completely unrelevant snippets.

Parameters:

$text	String
$terms	Array
$contextlines	Integer
$contextchars	Integer

Returns:

String

Definition at line 1370 of file SearchEngine.php.

SearchHighlighter::highlightText	(	$	text,
		$	terms,
		$	contextlines,
		$	contextchars
	)

Default implementation of wikitext highlighting.

Parameters:

$text	String
$terms	Array: terms to highlight (unescaped)
$contextlines	Integer
$contextchars	Integer

Returns:

String

Definition at line 938 of file SearchEngine.php.

SearchHighlighter::linkReplace

(

$

matches

)

callback to replace [[target|caption]] kind of links, if the target is category or image, leave it

Parameters:

$matches

Array

Definition at line 1346 of file SearchEngine.php.

SearchHighlighter::position	(	$	text,
		$	point,
		$	offset = 0
	)

Find a nonletter near a point (index) in the text.

Parameters:

$text	String
$point	Integer
$offset	Integer: offset to found index

Returns:

Integer: nearest nonletter index, or beginning of utf8 char if none

Definition at line 1246 of file SearchEngine.php.

SearchHighlighter::process	(	$	pattern,
		$	extracts,
		&$	linesleft,
		&$	contextchars,
		&$	out,
		&$	offsets
	)

Search extracts for a pattern, and return snippets.

Parameters:

$pattern	String: regexp for matching lines
$extracts	Array: extracts to search
$linesleft	Integer: number of extracts to make
$contextchars	Integer: length of snippet
$out	Array: map for highlighted snippets
$offsets	Array: map of starting points of snippets

Access:

protected

Definition at line 1279 of file SearchEngine.php.

SearchHighlighter::removeWiki

(

$

text

)

Basic wikitext removal.

Access:

protected

Returns:

mixed

Definition at line 1316 of file SearchEngine.php.

SearchHighlighter::splitAndAdd	(	&$	extracts,
		&$	count,
		$	text
	)

Split text into lines and add it to extracts array.

Parameters:

$extracts	Array: index -> $line
$count	Integer
$text	String

Definition at line 1180 of file SearchEngine.php.

---

Member Data Documentation

SearchHighlighter::$mCleanWikitext = true

Definition at line 923 of file SearchEngine.php.

---

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

• includes/search/SearchEngine.php