SearchHighlighter Class Reference

Highlight bits of wikitext. More...

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

Protected Attributes
	$mCleanWikitext = true

Detailed Description

Highlight bits of wikitext.

Definition at line 31 of file SearchHighlighter.php.

Constructor & Destructor Documentation

__construct()

SearchHighlighter::__construct

(

$cleanupWikitext = true

)

Warning

If you pass false to this constructor, then the caller is responsible for HTML escaping.

Parameters

bool

$cleanupWikitext

Definition at line 39 of file SearchHighlighter.php.

Member Function Documentation

caseCallback()

SearchHighlighter::caseCallback

(

$matches

)

Do manual case conversion for non-ascii chars.

Parameters

array

$matches

Returns

string

Definition at line 320 of file SearchHighlighter.php.

References $matches.

extract()

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

string	$text
int	$start
int	$end
int | null	&$posStart	(out) actual start position
int | null	&$posEnd	(out) actual end position

Returns

string

Definition at line 340 of file SearchHighlighter.php.

References position().

Referenced by highlightText(), and process().

highlightNone()

SearchHighlighter::highlightNone	(		$text,
			$contextlines,
			$contextchars
	)

Returns the first few lines of the text.

Parameters

string	$text
int	$contextlines	Max number of returned lines
int	$contextchars	Average number of characters per line

Returns

string

Definition at line 560 of file SearchHighlighter.php.

highlightSimple()

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

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

Used when $wgAdvancedSearchHighlighting is false.

Parameters

string	$text
array	$terms	Escaped for regex by SearchDatabase::regexTerm()
int	$contextlines
int	$contextchars

Returns

string

Definition at line 510 of file SearchHighlighter.php.

References $line, $lines, $pre, as, and captcha-old\count.

highlightText()

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

Wikitext highlighting when $wgAdvancedSearchHighlighting = true.

Parameters

string	$text
array	$terms	Terms to highlight (not html escaped but regex escaped via SearchDatabase::regexTerm())
int	$contextlines
int	$contextchars

Returns

string

Definition at line 53 of file SearchHighlighter.php.

References $last, $line, $matches, $term, $wgSearchHighlightBoundaries, as, captcha-old\count, extract(), NS_FILE, process(), and splitAndAdd().

linkReplace()

SearchHighlighter::linkReplace

(

$matches

)

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

Parameters

array

$matches

Returns

string

Definition at line 484 of file SearchHighlighter.php.

References $matches, NS_CATEGORY, and NS_FILE.

position()

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

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

Parameters

string	$text
int	$point
int	$offset	Offset to found index

Returns

int Nearest nonletter index, or beginning of utf8 char if none

Definition at line 372 of file SearchHighlighter.php.

References $s.

Referenced by extract().

process()

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

Search extracts for a pattern, and return snippets.

Parameters

string	$pattern	Regexp for matching lines
array	$extracts	Extracts to search
int	&$linesleft	Number of extracts to make
int	&$contextchars	Length of snippet
array	&$out	Map for highlighted snippets
array	&$offsets	Map of starting points of snippets

Access:\n protected

Definition at line 413 of file SearchHighlighter.php.

References $line, $out, as, and extract().

Referenced by highlightText().

removeWiki()

SearchHighlighter::removeWiki

(

$text

)

Basic wikitext removal.

Access:\n protected

Parameters

string

$text

Returns

mixed

Definition at line 456 of file SearchHighlighter.php.

Referenced by splitAndAdd().

splitAndAdd()

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

Split text into lines and add it to extracts array.

Parameters

array	&$extracts	Index -> $line
int	&$count
string	$text

Definition at line 304 of file SearchHighlighter.php.

References $line, as, and removeWiki().

Referenced by highlightText().

Member Data Documentation

$mCleanWikitext

SearchHighlighter::$mCleanWikitext = true

protected

Definition at line 32 of file SearchHighlighter.php.

---

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

• includes/search/SearchHighlighter.php