Class: Text_Highlighter_Renderer_Html

Source Location: /Text_Highlighter-0.7.1/Highlighter/Renderer/Html.php

Class Overview

Text_Highlighter_Renderer
   |
   --Text_Highlighter_Renderer_Array
      |
      --Text_Highlighter_Renderer_Html

HTML renderer

Author(s):

Andrey Demenev <demenev at gmail.com>

Version:

Release: 0.7.1

Copyright:

2004-2006 Andrey Demenev

Inherited Variables

Class: Text_Highlighter_Renderer

Text_Highlighter_Renderer::$_language
Text_Highlighter_Renderer::$_options

Inherited Methods

Class: Text_Highlighter_Renderer_Array

Text_Highlighter_Renderer_Array::acceptToken(): Accepts next token
Text_Highlighter_Renderer_Array::getOutput(): Get generated output
Text_Highlighter_Renderer_Array::preprocess(): Preprocesses code
Text_Highlighter_Renderer_Array::reset(): Resets renderer state

Class: Text_Highlighter_Renderer

Text_Highlighter_Renderer::__construct(): Constructor
Text_Highlighter_Renderer::Text_Highlighter_Renderer(): PHP4 compatable constructor
Text_Highlighter_Renderer::acceptToken(): Accepts next token
Text_Highlighter_Renderer::finalize(): Signals that no more tokens are available
Text_Highlighter_Renderer::getOutput(): Get generated output
Text_Highlighter_Renderer::preprocess(): Preprocesses code
Text_Highlighter_Renderer::reset(): Resets renderer state
Text_Highlighter_Renderer::setCurrentLanguage(): Set current language

Class Details

[line 130]
HTML renderer

Elements of $options argument of constructor (each being optional):

'numbers' - Line numbering style 0 or HL_NUMBERS_TABLE or HL_NUMBERS_UL or HL_NUMBERS_OL
'numbers_start' - starting number for numbered lines
'tabsize' - Tab size
'style_map' - Mapping of keywords to formatting rules using inline styles
'class_map' - Mapping of keywords to formatting rules using class names
'doclinks' - array that has keys "url", "target" and "elements", used for generating links to online documentation
'use_language' - class names will be prefixed with language, like "php-reserved" or "css-code"

Example of setting documentation links: $options['doclinks'] = array( 'url' => 'http://php.net/%s', 'target' => '_blank', 'elements' => array('reserved', 'identifier') );

Example of setting class names map: $options['class_map'] = array( 'main' => 'my-main', 'table' => 'my-table', 'gutter' => 'my-gutter', 'brackets' => 'my-brackets', 'builtin' => 'my-builtin', 'code' => 'my-code', 'comment' => 'my-comment', 'default' => 'my-default', 'identifier' => 'my-identifier', 'inlinedoc' => 'my-inlinedoc', 'inlinetags' => 'my-inlinetags', 'mlcomment' => 'my-mlcomment', 'number' => 'my-number', 'quotes' => 'my-quotes', 'reserved' => 'my-reserved', 'special' => 'my-special', 'string' => 'my-string', 'url' => 'my-url', 'var' => 'my-var', );

Example of setting styles mapping: $options['style_map'] = array( 'main' => 'color: black', 'table' => 'border: 1px solid black', 'gutter' => 'background-color: yellow', 'brackets' => 'color: blue', 'builtin' => 'color: red', 'code' => 'color: green', 'comment' => 'color: orange', // .... );

Author: Andrey Demenev <demenev@gmail.com>
Version: Release: 0.7.1
Copyright: 2004-2006 Andrey Demenev
Link: http://pear.php.net/package/Text_Highlighter
License: PHP License

[ Top ]

Method Detail

finalize [line 287]

void finalize(
)

Signals that no more tokens are available

Access: public

Overrides Text_Highlighter_Renderer::finalize() (Signals that no more tokens are available)

[ Top ]

reset [line 223]

void reset(
)

Resets renderer state

Overrides Text_Highlighter_Renderer_Array::reset() (Resets renderer state)

[ Top ]

_decorate [line 396]

string _decorate(
string
$content, [
$key = false])

Provides additional formatting to a keyword

Return: Keyword with additional formatting
Access: public

Parameters:

string	`$content`	—	Keyword
	`$key`	—

[ Top ]