Syntax highlighter wrapper class. More...

Collaboration diagram for ilSyntaxHighlighter:

Public Member Functions
	highlight ($a_code)
	Highlight code. More...

Static Public Member Functions
static	getInstance ($a_lang)
	Get instance. More...

static	getSupportedLanguages ()
	Get supported languages (keys are internal values, values are for representation) More...

static	isSupported ($a_lang)
	Is language supported? More...

static	getNewLanguageId ($a_old_lang_id)
	Get new language id (for an old one) More...

static	getSupportedLanguagesV51 ()
	Get supported languages (keys are ILIAS <= 5.1 internal values, values are for representation) More...

Data Fields
const	JAVA = "java"

const	PHP = "php"

const	C = "c"

const	CPP = "cpp"

const	HTML = "html4strict"

const	XML = "xml"

const	VISUAL_BASIC = "vb"

const	LATEX = "latex"

const	DELPHI = "delphi"

Protected Member Functions
	__construct ($a_lang)
	Constructor. More...

Protected Attributes
	$lang

Static Protected Attributes
static	$langs

static	$v51_map

Detailed Description

Syntax highlighter wrapper class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilSyntaxHighlighter.php.

Constructor & Destructor Documentation

◆ __construct()

ilSyntaxHighlighter::__construct ( $a_lang )

protected

Constructor.

Parameters

string $a_lang language constant

Returns: ilSyntaxHighlighter

Definition at line 58 of file class.ilSyntaxHighlighter.php.

        {
                $this->lang = $a_lang;
        }

Member Function Documentation

◆ getInstance()

static ilSyntaxHighlighter::getInstance ( $a_lang )

static

Get instance.

Parameters

string $a_lang language constant

Returns: ilSyntaxHighlighter

Definition at line 69 of file class.ilSyntaxHighlighter.php.

        {
                return new self($a_lang);
        }

Referenced by ilPCSourceCode\highlightText().

Here is the caller graph for this function:

◆ getNewLanguageId()

static ilSyntaxHighlighter::getNewLanguageId ( $a_old_lang_id )

static

Get new language id (for an old one)

Parameters

string $a_old_lang_id

Returns: string

Definition at line 102 of file class.ilSyntaxHighlighter.php.

        {
                if (isset(self::$v51_map[$a_old_lang_id]))
                {
                        return self::$v51_map[$a_old_lang_id];
                }
                return $a_old_lang_id;
        }

Referenced by ilPCSourceCode\highlightText().

Here is the caller graph for this function:

◆ getSupportedLanguages()

static ilSyntaxHighlighter::getSupportedLanguages ( )

static

Get supported languages (keys are internal values, values are for representation)

Parameters

return string[]

Definition at line 80 of file class.ilSyntaxHighlighter.php.

        {
                return self::$langs;
        }

References $langs.

◆ getSupportedLanguagesV51()

static ilSyntaxHighlighter::getSupportedLanguagesV51 ( )

static

Get supported languages (keys are ILIAS <= 5.1 internal values, values are for representation)

Parameters

return string[]

Definition at line 118 of file class.ilSyntaxHighlighter.php.

        {
                $langs = array();
                $map = array_flip(self::$v51_map);
                foreach (self::$langs as $k => $v)
                {
                        if (isset($map[$k]))
                        {
                                $k = $map[$k];
                        }
                        $langs[$k] = $v;
                }
                return $langs;
        }

References $langs.

Referenced by ilPCSourceCodeGUI\getProgLangOptions().

Here is the caller graph for this function:

◆ highlight()

ilSyntaxHighlighter::highlight ( $a_code )

Highlight code.

Parameters

string $a_code

Returns: string highlighted code

Definition at line 139 of file class.ilSyntaxHighlighter.php.

        {
                include_once("./libs/composer/vendor/geshi/geshi/src/geshi.php");
                $geshi = new Geshi(html_entity_decode($a_code), $this->lang);
 
                //var_dump($geshi->get_supported_languages()); exit;
 
                //$geshi->set_header_type(GESHI_HEADER_NONE); // does not work as expected, see below
                $a_code = $geshi->parse_code();
 
                // remove geshi pre tag (setting GESHI_HEADER_NONE gives us undesired br tags)
                $a_code = substr($a_code, strpos($a_code, ">") + 1);
                $a_code = substr($a_code, 0, strrpos($a_code, "<"));
 
                return $a_code;
        }

References $geshi.

◆ isSupported()

static ilSyntaxHighlighter::isSupported ( $a_lang )

static

Is language supported?

Parameters

string $a_lang

Returns: bool

Definition at line 91 of file class.ilSyntaxHighlighter.php.

        {
                return isset(self::$langs[$a_lang]);
        }

Referenced by ilPCSourceCode\highlightText().

Here is the caller graph for this function:

Field Documentation

◆ $lang

ilSyntaxHighlighter::$lang

protected

Definition at line 50 of file class.ilSyntaxHighlighter.php.

◆ $langs

ilSyntaxHighlighter::$langs

staticprotected

Initial value:

= array (
                self::JAVA => "Java",
                self::PHP => "PHP",
                self::C => "C",
                self::CPP => "C++",
                self::HTML => "HTML",
                self::XML => "XML",
                self::VISUAL_BASIC => "Visual Basic",
                self::DELPHI => "Delphi"
        )

Definition at line 27 of file class.ilSyntaxHighlighter.php.

Referenced by getSupportedLanguages(), and getSupportedLanguagesV51().

◆ $v51_map

ilSyntaxHighlighter::$v51_map

staticprotected

Initial value:

= array(
                "php3" => "php",
                "java122" => "java",
                "html" => "html4strict"
        )

Definition at line 41 of file class.ilSyntaxHighlighter.php.

◆ C

const ilSyntaxHighlighter::C = "c"

Definition at line 16 of file class.ilSyntaxHighlighter.php.

◆ CPP

const ilSyntaxHighlighter::CPP = "cpp"

Definition at line 17 of file class.ilSyntaxHighlighter.php.

◆ DELPHI

const ilSyntaxHighlighter::DELPHI = "delphi"

Definition at line 22 of file class.ilSyntaxHighlighter.php.

◆ HTML

const ilSyntaxHighlighter::HTML = "html4strict"

Definition at line 18 of file class.ilSyntaxHighlighter.php.

◆ JAVA

const ilSyntaxHighlighter::JAVA = "java"

Definition at line 14 of file class.ilSyntaxHighlighter.php.

◆ LATEX

const ilSyntaxHighlighter::LATEX = "latex"

Definition at line 21 of file class.ilSyntaxHighlighter.php.

◆ PHP

const ilSyntaxHighlighter::PHP = "php"

Definition at line 15 of file class.ilSyntaxHighlighter.php.

◆ VISUAL_BASIC

const ilSyntaxHighlighter::VISUAL_BASIC = "vb"

Definition at line 20 of file class.ilSyntaxHighlighter.php.

◆ XML

const ilSyntaxHighlighter::XML = "xml"

Definition at line 19 of file class.ilSyntaxHighlighter.php.

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

Services/UIComponent/SyntaxHighlighter/classes/class.ilSyntaxHighlighter.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getInstance()

◆ getNewLanguageId()

◆ getSupportedLanguages()

◆ getSupportedLanguagesV51()

◆ highlight()

◆ isSupported()

Field Documentation

◆ $lang

◆ $langs

◆ $v51_map

◆ C

◆ CPP

◆ DELPHI

◆ HTML

◆ JAVA

◆ LATEX

◆ PHP

◆ VISUAL_BASIC

◆ XML