MediaWiki  1.30.0
SyntaxHighlight.class.php File Reference

Go to the source code of this file.

Functions

static buildHeadItem ( $geshi)
 Backward-compatibility shim for extensions. More...
 
static getLexer ( $lang)
 Get the Pygments lexer name for a particular language. More...
 
static makeCacheKey ( $code, $lexer, $options)
 Construct a cache key for the results of a Pygments invocation. More...
 
static onApiFormatHighlight (IContextSource $context, $text, $mime, $format)
 Hook to provide syntax highlighting for API pretty-printed output. More...
 
static onContentGetParserOutput (Content $content, Title $title, $revId, ParserOptions $options, $generateHtml, ParserOutput &$output)
 Hook into Content::getParserOutput to provide syntax highlighting for script content. More...
 
static onParserFirstCallInit (Parser &$parser)
 Register parser hook. More...
 
static onResourceLoaderRegisterModules (&$resourceLoader)
 Conditionally register resource loader modules that depends on the VisualEditor MediaWiki extension. More...
 
static parseHighlightLines ( $lineSpec)
 Take an input specifying a list of lines to highlight, returning a raw list of matching line numbers. More...
 
static parserHook ( $text, $args=[], $parser)
 Parser hook. More...
 
static prepare ( $text, $lang)
 Backward-compatibility shim for extensions. More...
 
static validHighlightRange ( $start, $end)
 Validate a provided input range. More...
 

Variables

static array $mimeLexers
 Mapping of MIME-types to lexer names. More...
 
return $status
 
class SyntaxHighlight startinline highlight highlight hl_lines start start linenostart start nowrap l f html O
 
class SyntaxHighlight startinline highlight highlight hl_lines start start linenostart start nowrap l f html syntaxhighlight error pygments invocation failure Failed to invoke Pygments
 
$status value = self::highlight( $code, null, $args )->getValue()
 

Function Documentation

◆ buildHeadItem()

static buildHeadItem (   $geshi)
static

Backward-compatibility shim for extensions.

Deprecated:
since MW 1.25
Parameters
GeSHi$geshi
Returns
string

Definition at line 547 of file SyntaxHighlight.class.php.

References wfDeprecated().

◆ getLexer()

static getLexer (   $lang)
staticprivate

Get the Pygments lexer name for a particular language.

Parameters
string$langLanguage name.
Returns
string|null Lexer name, or null if no matching lexer.

Definition at line 326 of file SyntaxHighlight.class.php.

◆ makeCacheKey()

static makeCacheKey (   $code,
  $lexer,
  $options 
)
staticprivate

Construct a cache key for the results of a Pygments invocation.

Parameters
string$codeCode to be highlighted.
string$lexerLexer name.
array$optionsOptions array.
Returns
string Cache key.

Definition at line 338 of file SyntaxHighlight.class.php.

References $options, FormatJson::ALL_OK, FormatJson::encode(), and wfGlobalCacheKey().

◆ onApiFormatHighlight()

static onApiFormatHighlight ( IContextSource  $context,
  $text,
  $mime,
  $format 
)
static

Hook to provide syntax highlighting for API pretty-printed output.

Parameters
IContextSource$context
string$text
string$mime
string$format
Since
MW 1.24
Returns
bool

Definition at line 462 of file SyntaxHighlight.class.php.

References $context, $mime, $mimeLexers, $out, and $output.

◆ onContentGetParserOutput()

static onContentGetParserOutput ( Content  $content,
Title  $title,
  $revId,
ParserOptions  $options,
  $generateHtml,
ParserOutput $output 
)
static

Hook into Content::getParserOutput to provide syntax highlighting for script content.

Returns
bool
Since
MW 1.21

Definition at line 406 of file SyntaxHighlight.class.php.

References $options, $out, $output, $title, $wgParser, $wgTextModelsToParse, ContentHandler::getContentText(), ExtensionRegistry::getInstance(), Content::getModel(), and global.

◆ onParserFirstCallInit()

static onParserFirstCallInit ( Parser &  $parser)
static

Register parser hook.

Parameters
$parserParser

Definition at line 362 of file SyntaxHighlight.class.php.

◆ onResourceLoaderRegisterModules()

static onResourceLoaderRegisterModules ( $resourceLoader)
static

Conditionally register resource loader modules that depends on the VisualEditor MediaWiki extension.

Parameters
ResourceLoader$resourceLoader

Definition at line 494 of file SyntaxHighlight.class.php.

References $resourceLoader, and ExtensionRegistry::getInstance().

◆ parseHighlightLines()

static parseHighlightLines (   $lineSpec)
staticprotected

Take an input specifying a list of lines to highlight, returning a raw list of matching line numbers.

Input is comma-separated list of lines or line ranges.

Parameters
string$lineSpec
Returns
int[] Line numbers.

Definition at line 357 of file SyntaxHighlight.class.php.

References $lines, $value, and as.

◆ parserHook()

static parserHook (   $text,
  $args = [],
  $parser 
)
static

Parser hook.

Parameters
string$text
array$args
Parser$parser
Returns
string
Exceptions
MWException

Definition at line 377 of file SyntaxHighlight.class.php.

◆ prepare()

static prepare (   $text,
  $lang 
)
static

Backward-compatibility shim for extensions.

Deprecated:
since MW 1.25

Definition at line 536 of file SyntaxHighlight.class.php.

References $lang, and wfDeprecated().

◆ validHighlightRange()

static validHighlightRange (   $start,
  $end 
)
staticprotected

Validate a provided input range.

Parameters
$start
$end
Returns
bool

Definition at line 385 of file SyntaxHighlight.class.php.

Variable Documentation

◆ $mimeLexers

static array $mimeLexers
staticprivate
Initial value:
= [
'text/javascript' => 'javascript',
'application/json' => 'javascript',
'text/xml' => 'xml',
]

Mapping of MIME-types to lexer names.

Definition at line 314 of file SyntaxHighlight.class.php.

Referenced by onApiFormatHighlight().

◆ $status

return $status

Definition at line 316 of file SyntaxHighlight.class.php.

◆ O

class SyntaxHighlight startinline highlight highlight hl_lines start start linenostart start nowrap l f html O

Definition at line 23 of file SyntaxHighlight.class.php.

◆ Pygments

class SyntaxHighlight startinline highlight highlight hl_lines start start linenostart start nowrap l f html syntaxhighlight error pygments invocation failure Failed to invoke Pygments

Definition at line 23 of file SyntaxHighlight.class.php.

◆ value