Class: Text_Highlighter

Source Location: /Text_Highlighter-0.5.1/Highlighter.php

Class Overview

Text highlighter base class

Author(s):

Andrey Demenev <mailto:demenev at on-line.jar.ru>

Child classes:

Text_Highlighter_CPP: Auto-generated class. CPP syntax highlighting

Text_Highlighter_CSS: Auto-generated class. CSS syntax highlighting

Text_Highlighter_DIFF: Auto-generated class. DIFF syntax highlighting

Text_Highlighter_DTD: Auto-generated class. DTD syntax highlighting

Text_Highlighter_JAVASCRIPT: Auto-generated class. JAVASCRIPT syntax highlighting

Text_Highlighter_MYSQL: Auto-generated class. MYSQL syntax highlighting

Text_Highlighter_PERL: Auto-generated class. PERL syntax highlighting

Text_Highlighter_PHP: Auto-generated class. PHP syntax highlighting

Text_Highlighter_PYTHON: Auto-generated class. PYTHON syntax highlighting

Text_Highlighter_RUBY: Auto-generated class. RUBY syntax highlighting

Text_Highlighter_SQL: Auto-generated class. SQL syntax highlighting

Text_Highlighter_XML: Auto-generated class. XML syntax highlighting

Inherited Variables

Inherited Methods

Class Details

[line 95]
Text highlighter base class

This class implements all functions necessary for highlighting, but it does not contain highlighting rules. Actual highlighting is done using a descendent of this class.

One is not supposed to manually create descendent classes. Instead, describe highlighting rules in XML format and use Text_Highlighter_Generator to create descendent class. Alternatively, an instance of a descendent class can be created directly.

Use Text_Highlighter::factory() to create an object for particular language highlighter

Usage example


1     require_once 'Text/Highlighter.php';
2     $hlSQL =& Text_Highlighter::factory('SQL',array('numbers'=>true));
3     echo $hlSQL->highlight('SELECT * FROM table a WHERE id = 12');

Access: public
Author: Andrey Demenev <mailto:demenev@on-line.jar.ru>

[ Top ]

Class Variables

$_options = array()

[line 123]

Options. Keeped for BC

Access: protected

Type:

array

[ Top ]

$_syntax =

[line 107]

Syntax highlighting rules.

Auto-generated classes set this var

See: _init
Access: protected

Type:

array

[ Top ]

Method Detail

factory [line 142]

mixed &factory(
string
$lang, [array
$options = array()])

Create a new Highlighter object for specified language

Return: a newly created Highlighter object, or a PEAR error object on error
Access: public
Static: This method can be called statically

Parameters:

string	`$lang`	—	language, for example "SQL"
array	`$options`	—	Rendering options. This parameter is only keeped for BC reasons, use Text_Highlighter::setRenderer() instead

[ Top ]

highlight [line 195]

string highlight(
string
$str)

Highlights code

Return: Highlighted text
Access: public

Parameters:

string $str — Code to highlight

[ Top ]

setRenderer [line 168]

void setRenderer(
object
&$renderer)

Set renderer object

Access: public

Parameters:

object $renderer — Text_Highlighter_Renderer

[ Top ]