MediaWiki REL1_32
|
Highlight bits of wikitext. More...
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. | |
highlightNone ( $text, $contextlines, $contextchars) | |
Returns the first few lines of the text. | |
highlightSimple ( $text, $terms, $contextlines, $contextchars) | |
Simple & fast snippet extraction, but gives completely unrelevant snippets. | |
highlightText ( $text, $terms, $contextlines, $contextchars) | |
Wikitext highlighting when $wgAdvancedSearchHighlighting = true. | |
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. | |
Protected Attributes | |
$mCleanWikitext = true | |
Highlight bits of wikitext.
Definition at line 31 of file SearchHighlighter.php.
SearchHighlighter::__construct | ( | $cleanupWikitext = true | ) |
bool | $cleanupWikitext |
Definition at line 39 of file SearchHighlighter.php.
SearchHighlighter::caseCallback | ( | $matches | ) |
Do manual case conversion for non-ascii chars.
array | $matches |
Definition at line 320 of file SearchHighlighter.php.
References $matches.
SearchHighlighter::extract | ( | $text, | |
$start, | |||
$end, | |||
& | $posStart = null, | ||
& | $posEnd = null ) |
Extract part of the text from start to end, but by not chopping up words.
string | $text | |
int | $start | |
int | $end | |
int | null | &$posStart | (out) actual start position |
int | null | &$posEnd | (out) actual end position |
Definition at line 340 of file SearchHighlighter.php.
References position().
Referenced by highlightText(), and process().
SearchHighlighter::highlightNone | ( | $text, | |
$contextlines, | |||
$contextchars ) |
Returns the first few lines of the text.
string | $text | |
int | $contextlines | Max number of returned lines |
int | $contextchars | Average number of characters per line |
Definition at line 560 of file SearchHighlighter.php.
SearchHighlighter::highlightSimple | ( | $text, | |
$terms, | |||
$contextlines, | |||
$contextchars ) |
Simple & fast snippet extraction, but gives completely unrelevant snippets.
Used when $wgAdvancedSearchHighlighting is false.
string | $text | |
array | $terms | Escaped for regex by SearchDatabase::regexTerm() |
int | $contextlines | |
int | $contextchars |
Definition at line 510 of file SearchHighlighter.php.
SearchHighlighter::highlightText | ( | $text, | |
$terms, | |||
$contextlines, | |||
$contextchars ) |
Wikitext highlighting when $wgAdvancedSearchHighlighting = true.
string | $text | |
array | $terms | Terms to highlight (not html escaped but regex escaped via SearchDatabase::regexTerm()) |
int | $contextlines | |
int | $contextchars |
Definition at line 53 of file SearchHighlighter.php.
References $last, $line, $matches, $term, $wgSearchHighlightBoundaries, extract(), NS_FILE, process(), and splitAndAdd().
SearchHighlighter::linkReplace | ( | $matches | ) |
callback to replace [[target|caption]] kind of links, if the target is category or image, leave it
array | $matches |
Definition at line 484 of file SearchHighlighter.php.
References $matches, NS_CATEGORY, and NS_FILE.
SearchHighlighter::position | ( | $text, | |
$point, | |||
$offset = 0 ) |
Find a nonletter near a point (index) in the text.
string | $text | |
int | $point | |
int | $offset | Offset to found index |
Definition at line 372 of file SearchHighlighter.php.
References $s.
Referenced by extract().
SearchHighlighter::process | ( | $pattern, | |
$extracts, | |||
& | $linesleft, | ||
& | $contextchars, | ||
& | $out, | ||
& | $offsets ) |
Search extracts for a pattern, and return snippets.
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 |
Definition at line 413 of file SearchHighlighter.php.
References $line, $out, and extract().
Referenced by highlightText().
SearchHighlighter::removeWiki | ( | $text | ) |
Basic wikitext removal.
string | $text |
Definition at line 456 of file SearchHighlighter.php.
Referenced by splitAndAdd().
SearchHighlighter::splitAndAdd | ( | & | $extracts, |
& | $count, | ||
$text ) |
Split text into lines and add it to extracts array.
array | &$extracts | Index -> $line |
int | &$count | |
string | $text |
Definition at line 304 of file SearchHighlighter.php.
References $line, and removeWiki().
Referenced by highlightText().
|
protected |
Definition at line 32 of file SearchHighlighter.php.