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


Classes:
Text_Highlighter
Text_Highlighter_ABAP
Text_Highlighter_AVRC
Text_Highlighter_CPP
Text_Highlighter_CSS
Text_Highlighter_DIFF
Text_Highlighter_DTD
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
Files:
ABAP.php
Array.php
AVRC.php
BB.php
Console.php
CPP.php
CSS.php
DIFF.php
DTD.php
Generator.php
Highlighter.php
Html.php
HTML.php
HtmlTags.php
JAVA.php
JAVASCRIPT.php
JSON.php
MYSQL.php
PERL.php
PHP.php
PYTHON.php
Renderer.php
RUBY.php
SH.php
SQL.php
VBSCRIPT.php
XML.php
XML.php

Class: Text_Highlighter_Renderer

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

Class Overview




Abstract base class for Highlighter renderers




Author(s):






        
          
              

Version:


    
  
  • Release: @package_version@
    • 




Copyright:


    
  
  • 2004-2006 Andrey Demenev
    • 







Variables






Methods















Child classes:






Text_Highlighter_Renderer_Console

	
Console renderer






Text_Highlighter_Renderer_Array

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









Inherited Variables





Inherited Methods














Class Details



[line 36]

Abstract base class for Highlighter renderers









[ Top ]







Class Variables



	
	

	
$_language =  ''

	
[line 52]

  Current language


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_options = array()

	
[line 44]

  Renderer options


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
Text_Highlighter_Renderer (Constructor)   [line 73]

	

    

    

		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 61]

	

    

    

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

    


	
		Constructor


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $options  
        — 
        Rendering options. Renderer-specific.
      

        

    


        
[ Top ]

  

  
  
	
	
acceptToken   [line 112]

	

    

    

		void acceptToken(
string
$class, string
$content)
    

    


	
		Accepts next token


    

  • Abstract: 
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Text_Highlighter_Renderer_Console::acceptToken()

		
Accepts next token

	

		

	
Text_Highlighter_Renderer_Array::acceptToken()

		
Accepts next token

	

	


        
Parameters:

    

    

          

        string  
        $class  
        — 
        Token class
      

          

        string  
        $content  
        — 
        Token content
      

        

    


        
[ Top ]

  

  
  
	
	
finalize   [line 123]

	

    

    

		void finalize(
)
    

    


	
		Signals that no more tokens are available


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Text_Highlighter_Renderer_Console::finalize()

		
Signals that no more tokens are available

	

		

	
Text_Highlighter_Renderer_XML::finalize()

		
Signals that no more tokens are available

	

		

	
Text_Highlighter_Renderer_JSON::finalize()

		
Signals that no more tokens are available

	

		

	
Text_Highlighter_Renderer_Html::finalize()

		
Signals that no more tokens are available

	

		

	
Text_Highlighter_Renderer_BB::finalize()

		
Signals that no more tokens are available

	

		

	
Text_Highlighter_Renderer_HtmlTags::finalize()

		
Signals that no more tokens are available

	

	


        
[ Top ]

  

  
  
	
	
getOutput   [line 136]

	

    

    

		mixed getOutput(
)
    

    


	
		Get generated output


    

  • Return: Renderer-specific
    • 

  • Abstract: 
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Text_Highlighter_Renderer_Console::getOutput()

		
Get generated output

	

		

	
Text_Highlighter_Renderer_Array::getOutput()

		
Get generated output

	

	


        
[ Top ]

  

  
  
	
	
preprocess   [line 98]

	

    

    

		string preprocess(
string
$str)
    

    


	
		Preprocesses code


    

  • Return: Preprocessed code
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Text_Highlighter_Renderer_Console::preprocess()

		

	

		

	
Text_Highlighter_Renderer_Array::preprocess()

		
Preprocesses code

	

	


        
Parameters:

    

    

          

        string  
        $str  
        — 
        Code to preprocess
      

        

    


        
[ Top ]

  

  
  
	
	
reset   [line 85]

	

    

    

		void reset(
array
$options)
    

    


	
		Resets renderer state


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Text_Highlighter_Renderer_Console::reset()

		
Resets renderer state

	

		

	
Text_Highlighter_Renderer_Array::reset()

		
Resets renderer state

	

		

	
Text_Highlighter_Renderer_XML::reset()

		
Resets renderer state

	

		

	
Text_Highlighter_Renderer_Html::reset()

		
Resets renderer state

	

		

	
Text_Highlighter_Renderer_BB::reset()

		
Resets renderer state

	

		

	
Text_Highlighter_Renderer_HtmlTags::reset()

		
Resets renderer state

	

	


        
Parameters:

    

    

          

        array  
        $options  
        — 
        Rendering options. Renderer-specific.
      

        

    


        
[ Top ]

  

  
  
	
	
setCurrentLanguage   [line 149]

	

    

    

		void setCurrentLanguage(

$lang)
    

    


	
		Set current language


    

  • Abstract: 
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $lang  
        — 
        
      

        

    


        
[ Top ]

  

  
  



        

		    

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