include/HTMLPurifier/standalone/HTMLPurifier/Printer/ConfigForm.php

Show:

inherited

Classes

Table of Contents

\HTMLPurifier_Printer_ConfigForm
jump to top

Package: SugarCRM

Parent(s): \HTMLPurifier_Printer
Todo: Rewrite to use Interchange objects

Properties


                 $compress= 'false'

Whether or not to compress directive names, clipping them off after a certain amount of letters. False to disable or integer letters before clipping.

Default valuefalseDetails

Type: n/a


                 $config= ''

inherited

Instance of HTMLPurifier_Config, for easy access

Inherited from: \HTMLPurifier_Printer::$$config

Details

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


                 $docURL= ''

Documentation URL, can have fragment tagged on end

Details

Type: n/a


                 $fields= 'array()'

Printers for specific fields

Default valuearray()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


                 $name= ''

Name of form element to stuff config in

Details

Type: n/a

Methods

__construct(
          \$name $name, \$doc_url $doc_url
              =
              null, \$compress $compress
              =
              false
          )
        
        :
          void

Initialize $generator.

Parameters

Name	Type	Description
$name	\$name	Form element name for directives to be stuffed into
$doc_url	\$doc_url	String documentation URL, will have fragment tagged on
$compress	\$compress	Integer max length before compressing a directive name, set to false to turn off

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

getCSS(
          
          )
        
        :
          void

static

Retrieves styling, in case it is not accessible by webserver

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

getJavaScript(
          
          )
        
        :
          void

static

Retrieves JavaScript, in case it is not accessible by webserver

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

prepareGenerator(
           $config
          )
        
        :
          void

inherited

Give generator necessary configuration if possible

Inherited from: \HTMLPurifier_Printer::prepareGenerator()

Parameters

Name	Type	Description
$config

render(
          \$config $config, \$allowed $allowed
              =
              true,  $render_controls
              =
              true
          )
        
        :
          void

Returns HTML output for a configuration form

Parameters

Name	Type	Description
$config	\$config	Configuration object of current form state, or an array where [0] has an HTML namespace and [1] is being rendered.
$allowed	\$allowed	Optional namespace(s) and directives to restrict form to.
$render_controls

renderNamespace(
          \$ns $ns, \$directive $directives
          )
        
        :
          void

Renders a single namespace

Parameters

Name	Type	Description
$ns	\$ns	String namespace name
$directives	\$directive	Associative array of directives to values

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

setTextareaDimensions(
          \$cols $cols
              =
              null, \$rows $rows
              =
              null
          )
        
        :
          void

Sets default column and row size for textareas in sub-printers

Parameters

Name	Type	Description
$cols	\$cols	Integer columns of textarea, null to use default
$rows	\$rows	Integer rows of textarea, null to use default

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

\HTMLPurifier_Printer_ConfigForm_NullDecorator
jump to top

Package: SugarCRM

Printer decorator for directives that accept null

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


                 $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


                 $obj= ''

Printer being decorated

Details

Type: n/a

Methods

__construct(
          \$obj $obj
          )
        
        :
          void

Initialize $generator.

Parameters

Name	Type	Description
$obj	\$obj	Printer to decorate

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

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

prepareGenerator(
           $config
          )
        
        :
          void

inherited

Give generator necessary configuration if possible

Inherited from: \HTMLPurifier_Printer::prepareGenerator()

Parameters

Name	Type	Description
$config

render(
           $ns,  $directive,  $value,  $name,  $config
          )
        
        :
          void

Parameters

Name	Type	Description
$ns
$directive
$value
$name
$config

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

\HTMLPurifier_Printer_ConfigForm_bool
jump to top

Package: SugarCRM

Bool form field printer

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


                 $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

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

prepareGenerator(
           $config
          )
        
        :
          void

inherited

Give generator necessary configuration if possible

Inherited from: \HTMLPurifier_Printer::prepareGenerator()

Parameters

Name	Type	Description
$config

render(
           $ns,  $directive,  $value,  $name,  $config
          )
        
        :
          void

Parameters

Name	Type	Description
$ns
$directive
$value
$name
$config

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

\HTMLPurifier_Printer_ConfigForm_default
jump to top

Package: SugarCRM

Swiss-army knife configuration form field printer

Parent(s): \HTMLPurifier_Printer

Properties


                 $cols= '18'

Default value18Details

Type: n/a


                 $config= ''

inherited

Instance of HTMLPurifier_Config, for easy access

Inherited from: \HTMLPurifier_Printer::$$config

Details

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


                 $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


                 $rows= '5'

Default value5Details

Type: n/a

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

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

prepareGenerator(
           $config
          )
        
        :
          void

inherited

Give generator necessary configuration if possible

Inherited from: \HTMLPurifier_Printer::prepareGenerator()

Parameters

Name	Type	Description
$config

render(
           $ns,  $directive,  $value,  $name,  $config
          )
        
        :
          void

Parameters

Name	Type	Description
$ns
$directive
$value
$name
$config

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/ConfigForm.php

\HTMLPurifier_Printer_ConfigFormjump to top

Properties

Methods

\HTMLPurifier_Printer_ConfigForm_NullDecoratorjump to top

Properties

Methods

\HTMLPurifier_Printer_ConfigForm_booljump to top

Properties

Methods

\HTMLPurifier_Printer_ConfigForm_defaultjump to top

Properties

Methods

\HTMLPurifier_Printer_ConfigForm
jump to top

\HTMLPurifier_Printer_ConfigForm_NullDecorator
jump to top

\HTMLPurifier_Printer_ConfigForm_bool
jump to top

\HTMLPurifier_Printer_ConfigForm_default
jump to top