include/HTMLPurifier/standalone/HTMLPurifier/Printer/HTMLDefinition.php

Show:

inherited

Classes
- \HTMLPurifier_Printer_HTMLDefinition

Table of Contents

\HTMLPurifier_Printer_HTMLDefinition
jump to top

Package:

Parent(s): \HTMLPurifier_Printer

Properties


                 $config= ''

inherited

Instance of HTMLPurifier_Config, for easy access

Inherited from: \HTMLPurifier_Printer::$$config

Details

Type: n/a
Inherited_from: \HTMLPurifier_Printer::$$config


                 $def= ''

Instance of HTMLPurifier_HTMLDefinition, for easy access

Details

Type: n/a


                 $generator= ''

inherited

Instance of HTMLPurifier_Generator for HTML generation convenience funcs

Inherited from: \HTMLPurifier_Printer::$$generator

Details

Type: n/a
Inherited_from: \HTMLPurifier_Printer::$$generator

Methods

__construct(
          
          )
        
        :
          void

inherited

Initialize $generator.

Inherited from: \HTMLPurifier_Printer::__construct()

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

inherited

Prints a complete element with content inside

Inherited from: \HTMLPurifier_Printer::element()

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

inherited

Inherited from: \HTMLPurifier_Printer::elementEmpty()

Parameters

Name	Type	Description
$tag
$attr

end(
          \$tag $tag
          )
        
        :
          void

inherited

Returns an end teg

Inherited from: \HTMLPurifier_Printer::end()

Parameters

Name	Type	Description
$tag	\$tag	Tag name

escape(
          \$string $string
          )
        
        :
          void

inherited

Escapes a string for HTML output.

Inherited from: \HTMLPurifier_Printer::escape()

Parameters

Name	Type	Description
$string	\$string	String to escape

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

inherited

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

Inherited from: \HTMLPurifier_Printer::getClass()

Parameters

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

heavyHeader(
           $text,  $num
              =
              1
          )
        
        :
          void

Creates a heavy header row

Parameters

Name	Type	Description
$text
$num

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

inherited

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

Inherited from: \HTMLPurifier_Printer::listify()

Parameters

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

listifyAttr(
          \$array $array
          )
        
        :
          void

Listifies a hash of attributes to AttrDef classes

Parameters

Name	Type	Description
$array	\$array	Array hash in form of array('attrname' => HTMLPurifier_AttrDef)

listifyObjectList(
          \$array $array
          )
        
        :
          void

Listifies a list of objects by retrieving class names and internal state

Parameters

Name	Type	Description
$array	\$array	List of objects

Details

Todo: Also add information about internal state

listifyTagLookup(
          \$array $array
          )
        
        :
          void

Listifies a tag lookup table.

Parameters

Name	Type	Description
$array	\$array	Tag lookup array in form of array('tagname' => true)

prepareGenerator(
           $config
          )
        
        :
          void

inherited

Give generator necessary configuration if possible

Inherited from: \HTMLPurifier_Printer::prepareGenerator()

Parameters

Name	Type	Description
$config

render(
           $config
          )
        
        :
          void

Parameters

Name	Type	Description
$config

renderChildren(
          \$def $def
          )
        
        :
          void

Renders a row describing the allowed children of an element

Parameters

Name	Type	Description
$def	\$def	HTMLPurifier_ChildDef of pertinent element

renderContentSets(
          
          )
        
        :
          void

Renders the Content Sets table

renderDoctype(
          
          )
        
        :
          void

Renders the Doctype table

renderEnvironment(
          
          )
        
        :
          void

Renders environment table, which is miscellaneous info

renderInfo(
          
          )
        
        :
          void

Renders the Elements ($info) table

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

inherited

Prints a simple key/value row in a table.

Inherited from: \HTMLPurifier_Printer::row()

Parameters

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

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

inherited

Returns a start tag

Inherited from: \HTMLPurifier_Printer::start()

Parameters

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

text(
           $text
          )
        
        :
          void

inherited

Inherited from: \HTMLPurifier_Printer::text()

Parameters

Name	Type	Description
$text

include/HTMLPurifier/standalone/HTMLPurifier/Printer/HTMLDefinition.php

\HTMLPurifier_Printer_HTMLDefinitionjump to top

Properties

Methods

\HTMLPurifier_Printer_HTMLDefinition
jump to top