apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
HTML_BBCodeParser


Classes:
HTML_BBCodeParser
   HTML_BBCodeParser
   HTML_BBCodeParser_Filter
   HTML_BBCodeParser_Filter_Basic
   HTML_BBCodeParser_Filter_Email
   HTML_BBCodeParser_Filter_Extended
   HTML_BBCodeParser_Filter_Images
   HTML_BBCodeParser_Filter_Links
   HTML_BBCodeParser_Filter_Lists

Class: HTML_BBCodeParser

Source Location: /HTML_BBCodeParser-1.2.4/HTML/BBCodeParser.php

Class Overview



















Methods















Child classes:






HTML_BBCodeParser_Filter

	
Dummy class that filters need to extend from.









Inherited Variables





Inherited Methods














Class Details



[line 83]






[ Top ]








Method Detail



	
	
HTML_BBCodeParser (Constructor)   [line 166]

	

    

    

		none HTML_BBCodeParser(
[array
$options = array()])
    

    


	
		Constructor, initialises the options and filters
Sets the private variable _options with base options defined with  &PEAR::getStaticProperty(), overwriting them with (if present)  the argument to this method.  Then it sets the extra options to properly escape the tag  characters in preg_replace() etc. The set options are  then stored back with &PEAR::getStaticProperty(), so that the filter  classes can use them.  All the filters in the options are initialised and their defined tags  are copied into the private variable _definedTags.








        
Parameters:

    

    

          

        array  
        $options  
        — 
        options to use, can be left out
      

        

    


        
[ Top ]

  

  
  
	
	
addFilter   [line 226]

	

    

    

		void addFilter(
string
$filter)
    

    


	
		Add a new filter








        
Parameters:

    

    

          

        string  
        $filter  
        — 
        filter
      

        

    


        
[ Top ]

  

  
  
	
	
addFilters   [line 273]

	

    

    

		boolean addFilters(
mixed
$filters)
    

    


	
		Add new filters








        
Parameters:

    

    

          

        mixed  
        $filters  
        — 
        (array or string)
      

        

    


        
[ Top ]

  

  
  
	
	
getParsed   [line 826]

	

    

    

		string getParsed(
)
    

    


	
		Gets the parsed text from the object


    

  • Return: the parsed text set in the object
    • 

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: $_parsed
    • 

  • See: parse()
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getPreparsed   [line 812]

	

    

    

		string getPreparsed(
)
    

    


	
		Gets the preparsed text from the object


    

  • Return: the text set in the object
    • 

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: $_preparsed
    • 

  • See: _preparse()
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getText   [line 798]

	

    

    

		string getText(
)
    

    


	
		Gets the unparsed text from the object


    

  • Return: the text set in the object
    • 

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: $_text
    • 

  • See: setText()
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
parse   [line 842]

	

    

    

		none parse(
)
    

    


	
		Parses the text set in the object


    

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: _buildParsedString()
    • 

  • See: _validateTagArray()
    • 

  • See: _buildTagArray()
    • 

  • See: _preparse()
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
qparse   [line 859]

	

    

    

		none qparse(

$str)
    

    


	
		Quick method to do setText(), parse() and getParsed at once


    

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: $_text
    • 

  • See: parse()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $str  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeFilter   [line 249]

	

    

    

		void removeFilter(
string
$filter)
    

    


	
		Remove an existing filter








        
Parameters:

    

    

          

        string  
        $filter  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setOption   [line 215]

	

    

    

		void setOption(
string
$name, mixed
$value)
    

    


	
		Option setter








        
Parameters:

    

    

          

        string  
        $name  
        — 
        option name
      

          

        mixed  
        $value  
        — 
        option value
      

        

    


        
[ Top ]

  

  
  
	
	
setText   [line 784]

	

    

    

		none setText(
string
$str)
    

    


	
		Sets text in the object to be parsed


    

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: $_text
    • 

  • See: getText()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $str  
        — 
        the text to set in the object
      

        

    


        
[ Top ]

  

  
  
	
	
staticQparse   [line 875]

	

    

    

		none staticQparse(

$str)
    

    


	
		Quick static method to do setText(), parse() and getParsed at once


    

  • Author: Stijn de Reede  <sjr@gmx.co.uk>
    • 

  • See: $_text
    • 

  • See: parse()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $str  
        — 
        
      

        

    


        
[ Top ]

  

  
  



        

		    

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