PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of SyntaxHighlight

(no description)

File Size:	504 lines (15 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

SyntaxHighlight_GeSHi:: (16 methods):
  parserHook()
  addAttribute()
  parseHighlightLines()
  validHighlightRange()
  getEncloseType()
  renderHook()
  prepare()
  buildHeadItem()
  getCSS()
  formatLanguageError()
  formatError()
  formatLanguages()
  getSupportedLanguages()
  initialise()
  extensionTypes()
  resourceLoaderRegisterModules()

Class: SyntaxHighlight_GeSHi - X-Ref

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
http://www.gnu.org/copyleft/gpl.html

parserHook( $text, $args = array() X-Ref

Parser hook

param: string $text
param: array $args
param: Parser $parser
return: string

addAttribute( $attribs, $name, $value ) X-Ref

param: $attribs array
param: $name string
param: $value string
return: array

parseHighlightLines( $arg ) X-Ref

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.

param: $arg string
return: array of ints

validHighlightRange( $start, $end ) X-Ref

Validate a provided input range

param: $start
param: $end
return: bool

getEncloseType( $args ) X-Ref

param: $args array
return: int

renderHook( Content $content, Title $title,$revId, ParserOptions $options, $generateHtml, ParserOutput &$output) X-Ref

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

return: bool

prepare( $text, $lang ) X-Ref

Initialise a GeSHi object to format some code, performing
common setup for all our uses of it

param: string $text
param: string $lang
return: GeSHi

buildHeadItem( $geshi ) X-Ref

Prepare a CSS snippet suitable for use as a ParserOutput/OutputPage
head item.

Not used anymore, kept for backwards-compatibility with other extensions.

param: GeSHi $geshi
return: string

getCSS( $geshi ) X-Ref

Get the complete CSS code necessary to display styles for given GeSHi instance.

param: GeSHi $geshi
return: string

formatLanguageError( $text ) X-Ref

Format an 'unknown language' error message and append formatted
plain text to it.

param: string $text
return: string HTML fragment

formatError( $error = '' ) X-Ref

Format an error message

param: string $error
return: string

formatLanguages() X-Ref

Format the list of supported languages

return: string

getSupportedLanguages() X-Ref

Get the list of supported languages

return: array

initialise() X-Ref

Initialise messages and ensure the GeSHi class is loaded

return: bool

extensionTypes( &$extensionTypes ) X-Ref

Get the GeSHI's version information while Special:Version is read.

param: $extensionTypes
return: bool

resourceLoaderRegisterModules( &$resourceLoader ) X-Ref

Register a ResourceLoader module providing styles for each supported language.

param: ResourceLoader $resourceLoader
return: bool true

PHP Cross Reference of MediaWiki-1.24.0

/extensions/SyntaxHighlight_GeSHi/ -> SyntaxHighlight_GeSHi.class.php (summary)

Defines 1 class