Text_Highlighter
[ class tree: Text_Highlighter ] [ index: Text_Highlighter ] [ all elements ]

Class: Text_Highlighter_Renderer

Source Location: /Text_Highlighter-0.5.1/Highlighter/Renderer.php

Class Overview


Abstract base class for Highlighter renderers


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2004 Andrey Demenev

Variables

Methods


Child classes:

Inherited Variables

Inherited Methods


Class Details

[line 36]
Abstract base class for Highlighter renderers


[ Top ]


Class Variables

$_options = array()

[line 44]

Renderer options
  • Access: protected

Type:   array


[ Top ]



Method Detail

Text_Highlighter_Renderer (Constructor)   [line 65]

Text_Highlighter_Renderer Text_Highlighter_Renderer( [array $options = array()])

PHP4 compatable constructor
  • Access: public

Parameters:

array   $options   —  Rendering options. Renderer-specific.

[ Top ]

__construct (Constructor)   [line 53]

Text_Highlighter_Renderer __construct( [array $options = array()])

Constructor
  • Access: public

Parameters:

array   $options   —  Rendering options. Renderer-specific.

[ Top ]

acceptToken   [line 104]

void acceptToken( string $class, string $content)

Accepts next token
  • Abstract:
  • Access: public

Overridden in child classes as:

Text_Highlighter_Renderer_Html::acceptToken()
Accepts next token
Text_Highlighter_Renderer_Console::acceptToken()
Accepts next token

Parameters:

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

[ Top ]

finalize   [line 115]

void finalize( )

Signals that no more tokens are available
  • Access: public

Overridden in child classes as:

Text_Highlighter_Renderer_Html::finalize()
Signals that no more tokens are available
Text_Highlighter_Renderer_Console::finalize()
Signals that no more tokens are available

[ Top ]

getOutput   [line 128]

mixed getOutput( )

Get generated output
  • Return: Renderer-specific
  • Abstract:
  • Access: public

Overridden in child classes as:

Text_Highlighter_Renderer_Html::getOutput()
Get generated output
Text_Highlighter_Renderer_Console::getOutput()
Get generated output

[ Top ]

preprocess   [line 90]

string preprocess( string $str)

Preprocesses code
  • Return: Preprocessed code
  • Access: public

Overridden in child classes as:

Text_Highlighter_Renderer_Html::preprocess()
Text_Highlighter_Renderer_Console::preprocess()

Parameters:

string   $str   —  Code to preprocess

[ Top ]

reset   [line 77]

void reset( array $options)

Resets renderer state
  • Access: public

Overridden in child classes as:

Text_Highlighter_Renderer_Html::reset()
Resets renderer state
Text_Highlighter_Renderer_Console::reset()
Resets renderer state

Parameters:

array   $options   —  Rendering options. Renderer-specific.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:56:50 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.