phpDocumentor plugins
CodeHighlight
[ class tree: plugins ] [ index: plugins ] [ all elements ]

Class: am_code_highlighter

Source Location: /qp_plugins/code_highlight_plugin/highlighters/code.highlighter.php

Class am_code_highlighter

Property Summary
mixed   $language_title   Text name of language for display
mixed   $requested_language   Name of language that was desired by user
mixed   $strict_mode   Boolean are we in strict mode ?

[ Top ]
Method Summary
object am_code_highlighter   am_code_highlighter()   Called automatically on class innit
string   highlight_code()   Highlights code ready for displaying

[ Top ]
Properties
mixed   $language_title = 'Code' [line 48]

Text name of language for display

This is unused whilst "Experimental" as it requires a modification of the plugin it would be used to replace the text output above the codeblock instead of ucfirst( language )


[ Top ]
mixed   $requested_language [line 56]

Name of language that was desired by user

This can be used to make geshi simpler to implement


[ Top ]
mixed   $strict_mode = false [line 63]

Boolean are we in strict mode ?


[ Top ]
Methods
Constructor am_code_highlighter  [line 72]

  object am_code_highlighter am_code_highlighter( &$parent, object $parent  )

Called automatically on class innit

Parameters:
object   $parent: 
   &$parent: 


[ Top ]
highlight_code  [line 86]

  string highlight_code( string $block  )

Highlights code ready for displaying

Parameters:
string   $block:  - the code

API Tags:
Return:  highlighted code


[ Top ]