MediaWiki\Search\SearchHighlighter Class Reference

Highlight bits of wikitext. More...

Public Member Functions
	__construct ( $cleanupWikitext=true)
	highlightNone ( $text, $contextlines=self::DEFAULT_CONTEXT_LINES, $contextchars=self::DEFAULT_CONTEXT_CHARS)
	Returns the first few lines of the text.
	highlightSimple ( $text, $terms, $contextlines=self::DEFAULT_CONTEXT_LINES, $contextchars=self::DEFAULT_CONTEXT_CHARS)
	Simple & fast snippet extraction, but gives completely irrelevant snippets.
	highlightText ( $text, $terms, $contextlines=self::DEFAULT_CONTEXT_LINES, $contextchars=self::DEFAULT_CONTEXT_CHARS)
	Wikitext highlighting when $wgAdvancedSearchHighlighting = true.

Public Attributes
const	DEFAULT_CONTEXT_CHARS = 75
const	DEFAULT_CONTEXT_LINES = 2

Protected Attributes
bool	$mCleanWikitext = true

Detailed Description

Highlight bits of wikitext.

Stability: newable

Note

marked as newable in 1.35 for lack of a better alternative, but should use a factory in the future.

Definition at line 25 of file SearchHighlighter.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Search\SearchHighlighter::__construct

(

$cleanupWikitext = true

)

Stability: stable

to call

Warning

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

Parameters

bool

$cleanupWikitext

Definition at line 38 of file SearchHighlighter.php.

Member Function Documentation

highlightNone()

MediaWiki\Search\SearchHighlighter::highlightNone	(		$text,
			$contextlines = self::DEFAULT_CONTEXT_LINES,
			$contextchars = self::DEFAULT_CONTEXT_CHARS )

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 574 of file SearchHighlighter.php.

highlightSimple()

MediaWiki\Search\SearchHighlighter::highlightSimple	(		$text,
			$terms,
			$contextlines = self::DEFAULT_CONTEXT_LINES,
			$contextchars = self::DEFAULT_CONTEXT_CHARS )

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

Used when $wgAdvancedSearchHighlighting is false.

Parameters

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

Returns

string

Definition at line 522 of file SearchHighlighter.php.

References MediaWiki\MediaWikiServices\getInstance().

highlightText()

MediaWiki\Search\SearchHighlighter::highlightText	(		$text,
			$terms,
			$contextlines = self::DEFAULT_CONTEXT_LINES,
			$contextchars = self::DEFAULT_CONTEXT_CHARS )

Wikitext highlighting when $wgAdvancedSearchHighlighting = true.

Parameters

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

Returns

string

Definition at line 52 of file SearchHighlighter.php.

References $matches, MediaWiki\MediaWikiServices\getInstance(), NS_FILE, and MediaWiki\MainConfigNames\SearchHighlightBoundaries.

Member Data Documentation

$mCleanWikitext

bool MediaWiki\Search\SearchHighlighter::$mCleanWikitext = true

protected

Definition at line 30 of file SearchHighlighter.php.

DEFAULT_CONTEXT_CHARS

const MediaWiki\Search\SearchHighlighter::DEFAULT_CONTEXT_CHARS = 75

Definition at line 27 of file SearchHighlighter.php.

Referenced by MediaWiki\Search\SearchEngine\userHighlightPrefs().

DEFAULT_CONTEXT_LINES

const MediaWiki\Search\SearchHighlighter::DEFAULT_CONTEXT_LINES = 2

Definition at line 26 of file SearchHighlighter.php.

Referenced by MediaWiki\Search\SearchEngine\userHighlightPrefs().

---

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

• includes/Search/SearchHighlighter.php