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

Class: Text_Highlighter_Renderer_BB

Source Location: /Text_Highlighter-0.7.3/Text/Highlighter/Renderer/BB.php

Class Overview

Text_Highlighter_Renderer
   |
   --Text_Highlighter_Renderer_Array
      |
      --Text_Highlighter_Renderer_BB

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


Author(s):

Version:

  • Release: 0.5.0

Copyright:

  • 20045 Stoyan Stefanov

Methods


Inherited Variables

Inherited Methods


Class Details

[line 74]
BB code renderer, based on Andrey Demenev's HTML renderer.

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

  • 'numbers' - Line numbering TRUE or FALSE
  • 'tabsize' - Tab size, default is 4
  • 'bb_tags' - An array containing three BB tags, see below
  • 'tag_brackets' - An array that conains opening and closing tags, [ and ]
  • 'colors' - An array with all the colors to be used for highlighting
The default BB tags are:
  • 'color' => 'color'
  • 'list' => 'list'
  • 'list_item' => '*'
The default colors for the highlighter are:
  • 'default' => 'Black',
  • 'code' => 'Gray',
  • 'brackets' => 'Olive',
  • 'comment' => 'Orange',
  • 'mlcomment' => 'Orange',
  • 'quotes' => 'Darkred',
  • 'string' => 'Red',
  • 'identifier' => 'Blue',
  • 'builtin' => 'Teal',
  • 'reserved' => 'Green',
  • 'inlinedoc' => 'Blue',
  • 'var' => 'Darkblue',
  • 'url' => 'Blue',
  • 'special' => 'Navy',
  • 'number' => 'Maroon',
  • 'inlinetags' => 'Blue',



[ Top ]


Method Detail

finalize   [line 167]

void finalize( )

Signals that no more tokens are available
  • Abstract:
  • Access: public

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

reset   [line 142]

void reset( )

Resets renderer state

Overrides Text_Highlighter_Renderer_Array::reset() (Resets renderer state)
[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:46:53 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.