Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • Text_Highlighter
  • Text_Highlighter_ABAP
  • Text_Highlighter_CPP
  • Text_Highlighter_CSS
  • Text_Highlighter_DIFF
  • Text_Highlighter_DTD
  • Text_Highlighter_Generator
  • Text_Highlighter_HTML
  • Text_Highlighter_JAVA
  • Text_Highlighter_JAVASCRIPT
  • Text_Highlighter_MYSQL
  • Text_Highlighter_PERL
  • Text_Highlighter_PHP
  • Text_Highlighter_PYTHON
  • Text_Highlighter_Renderer
  • Text_Highlighter_Renderer_Array
  • Text_Highlighter_Renderer_BB
  • Text_Highlighter_Renderer_Console
  • Text_Highlighter_Renderer_Html
  • Text_Highlighter_Renderer_HtmlTags
  • Text_Highlighter_Renderer_JSON
  • Text_Highlighter_Renderer_XML
  • Text_Highlighter_RUBY
  • Text_Highlighter_SH
  • Text_Highlighter_SQL
  • Text_Highlighter_VBSCRIPT
  • Text_Highlighter_XML
  • Overview
  • Package
  • Class
  • Tree

Class Text_Highlighter_Renderer_BB

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',
Text_Highlighter_Renderer
Extended by Text_Highlighter_Renderer_Array
Extended by Text_Highlighter_Renderer_BB
Package: Text\Highlighter
Category: Text
Copyright: 20045 Stoyan Stefanov
License: PHP License
Author: Stoyan Stefanov <ssttoo@gmail.com>
Version: Release: 0.5.0
Link: http://pear.php.net/package/Text_Highlighter
Located at x2engine/framework/vendors/TextHighlighter/Text/Highlighter/Renderer/BB.php
Methods summary
public
# reset( )

Resets renderer state

Resets renderer state

Overrides

Text_Highlighter_Renderer_Array::reset()
public
# finalize( )

Signals that no more tokens are available

Signals that no more tokens are available

Overrides

Text_Highlighter_Renderer::finalize()
Methods inherited from Text_Highlighter_Renderer_Array
_getFullClassName(), acceptToken(), getOutput(), preprocess()
Methods inherited from Text_Highlighter_Renderer
__construct(), setCurrentLanguage()
Properties summary
public boolean $_numbers false
#

Line numbering - will use the specified BB tag for listings

Line numbering - will use the specified BB tag for listings

public array $_bb_tags array ( 'color' => 'color', 'list' => 'list', 'list_item' => '*', 'code' => 'code', )
#

BB tags to be used

BB tags to be used

public array $_tag_brackets array ('start' => '[', 'end' => ']')
#

BB brackets - [ and ]

BB brackets - [ and ]

public boolean $_colors array( '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', )
#

Colors map

Colors map

Properties inherited from Text_Highlighter_Renderer_Array
$_enumerated, $_htmlspecialchars, $_output, $_tabsize
Properties inherited from Text_Highlighter_Renderer
$_language, $_options
API documentation generated by ApiGen 2.8.0