include/HTMLPurifier/standalone/HTMLPurifier/Printer.php

Show:

inherited

Classes
- \HTMLPurifier_Printer

Table of Contents

\HTMLPurifier_Printer
jump to top

Package:

Children: \HTMLPurifier_Printer_ConfigForm; \HTMLPurifier_Printer_ConfigForm_NullDecorator; \HTMLPurifier_Printer_ConfigForm_default; \HTMLPurifier_Printer_ConfigForm_bool; \HTMLPurifier_Printer_HTMLDefinition; \HTMLPurifier_Printer_CSSDefinition

Properties


                 $config= ''

Instance of HTMLPurifier_Config, for easy access

Details

Type: n/a


                 $generator= ''

Instance of HTMLPurifier_Generator for HTML generation convenience funcs

Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

Initialize $generator.

element(
          \$tag $tag, \$contents $contents, \$attr $attr
              =
              array(), \$escape $escape
              =
              true
          )
        
        :
          void

Prints a complete element with content inside

Parameters

Name	Type	Description
$tag	\$tag	Tag name
$contents	\$contents	Element contents
$attr	\$attr	Tag attributes
$escape	\$escape	Bool whether or not to escape contents

elementEmpty(
           $tag,  $attr
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$tag
$attr

end(
          \$tag $tag
          )
        
        :
          void

Returns an end teg

Parameters

Name	Type	Description
$tag	\$tag	Tag name

escape(
          \$string $string
          )
        
        :
          void

Escapes a string for HTML output.

Parameters

Name	Type	Description
$string	\$string	String to escape

getClass(
          \$obj $obj, \$prefix $sec_prefix
              =
              ''
          )
        
        :
          void

Retrieves the class of an object without prefixes, as well as metadata

Parameters

Name	Type	Description
$obj	\$obj	Object to determine class of
$sec_prefix	\$prefix	Further prefix to remove

listify(
          \$array $array, \$polite $polite
              =
              false
          )
        
        :
          void

Takes a list of strings and turns them into a single list

Parameters

Name	Type	Description
$array	\$array	List of strings
$polite	\$polite	Bool whether or not to add an end before the last

prepareGenerator(
           $config
          )
        
        :
          void

Give generator necessary configuration if possible

Parameters

Name	Type	Description
$config

row(
          \$name $name, \$value $value
          )
        
        :
          void

Prints a simple key/value row in a table.

Parameters

Name	Type	Description
$name	\$name	Key
$value	\$value	Value

start(
          \$tag $tag, \$attr $attr
              =
              array()
          )
        
        :
          void

Returns a start tag

Parameters

Name	Type	Description
$tag	\$tag	Tag name
$attr	\$attr	Attribute array

text(
           $text
          )
        
        :
          void

Parameters

Name	Type	Description
$text

include/HTMLPurifier/standalone/HTMLPurifier/Printer.php

\HTMLPurifier_Printerjump to top

Properties

Methods

\HTMLPurifier_Printer
jump to top