Class: Text_Highlighter_Renderer_Array

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

Class Overview

Text_Highlighter_Renderer
   |
   --Text_Highlighter_Renderer_Array

Array renderer, based on Andrey Demenev's HTML renderer.

Author(s):

Stoyan Stefanov <ssttoo at gmail.com>

Version:

Release: 0.5.0

Copyright:

2006 Stoyan Stefanov

Methods

Child classes:

Text_Highlighter_Renderer_BB: BB code renderer, based on Andrey Demenev's HTML renderer.

Text_Highlighter_Renderer_Html: HTML renderer

Text_Highlighter_Renderer_HtmlTags: HTML basic tags renderer, based on Andrey Demenev's HTML renderer.

Text_Highlighter_Renderer_JSON: JSON renderer, based on Andrey Demenev's HTML renderer.

Text_Highlighter_Renderer_XML: XML renderer, based on Andrey Demenev's HTML renderer.

Inherited Variables

Class: Text_Highlighter_Renderer

Text_Highlighter_Renderer::$_language
Text_Highlighter_Renderer::$_options

Inherited Methods

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 53]
Array renderer, based on Andrey Demenev's HTML renderer.

In addition to the options supported by the HTML renderer, the following options were also introduced:

htmlspecialchars - whether or not htmlspecialchars() will be called on the content, default TRUE
enumerated - type of array produced, default FALSE, meaning associative array

Author: Stoyan Stefanov <ssttoo@gmail.com>
Version: Release: 0.5.0
Copyright: 2006 Stoyan Stefanov
Link: http://pear.php.net/package/Text_Highlighter
License: PHP License

[ Top ]

Method Detail

acceptToken [line 142]

void acceptToken(
string
$class, string
$content)

Accepts next token

Abstract:
Access: public

Overrides Text_Highlighter_Renderer::acceptToken() (Accepts next token)

Parameters:

string	`$class`	—	Token class
string	`$content`	—	Token content

[ Top ]

getOutput [line 185]

array getOutput(
)

Get generated output

Return: Highlighted code as an array
Abstract:
Access: public

Overrides Text_Highlighter_Renderer::getOutput() (Get generated output)

[ Top ]

preprocess [line 98]

string preprocess(
string
$str)

Preprocesses code

Return: Preprocessed code
Access: public

Overrides Text_Highlighter_Renderer::preprocess() (Preprocesses code)

Parameters:

string $str — Code to preprocess

[ Top ]

reset [line 117]

void reset(
)

Resets renderer state

Descendents of Text_Highlighter call this method from the constructor, passing $options they get as parameter.

Access: protected

Overridden in child classes as:

Text_Highlighter_Renderer_BB::reset(): Resets renderer state

Text_Highlighter_Renderer_Html::reset(): Resets renderer state

Text_Highlighter_Renderer_HtmlTags::reset(): Resets renderer state

Text_Highlighter_Renderer_XML::reset(): Resets renderer state

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

[ Top ]