XHTML 1.1 Forms module, defines all form-related elements found in HTML 4. More...

Inheritance diagram for HTMLPurifier_HTMLModule_Forms:

Collaboration diagram for HTMLPurifier_HTMLModule_Forms:

Public Member Functions
	setup ($config)

Public Member Functions inherited from HTMLPurifier_HTMLModule
	getChildDef ($def)
	Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class. More...

	addElement ($element, $type, $contents, $attr_includes=array(), $attr=array())
	Convenience function that sets up a new element. More...

	addBlankElement ($element)
	Convenience function that creates a totally blank, non-standalone element. More...

	addElementToContentSet ($element, $type)
	Convenience function that registers an element to a content set. More...

	parseContents ($contents)
	Convenience function that transforms single-string contents into separate content model and content model type. More...

	mergeInAttrIncludes (&$attr, $attr_includes)
	Convenience function that merges a list of attribute includes into an attribute array. More...

	makeLookup ($list)
	Convenience function that generates a lookup table with boolean true as value. More...

	setup ($config)
	Lazy load construction of the module after determining whether or not it's needed, and also when a finalized configuration object is available. More...

Data Fields
	$name = 'Forms'
	string More...

	$safe = false
	bool More...

	$content_sets
	array More...

Data Fields inherited from HTMLPurifier_HTMLModule
	$name
	Short unique string identifier of the module. More...

	$elements = array()
	Informally, a list of elements this module changes. More...

	$info = array()
	Associative array of element names to element definitions. More...

	$content_sets = array()
	Associative array of content set names to content set additions. More...

	$attr_collections = array()
	Associative array of attribute collection names to attribute collection additions. More...

	$info_tag_transform = array()
	Associative array of deprecated tag name to HTMLPurifier_TagTransform. More...

	$info_attr_transform_pre = array()
	List of HTMLPurifier_AttrTransform to be performed before validation. More...

	$info_attr_transform_post = array()
	List of HTMLPurifier_AttrTransform to be performed after validation. More...

	$info_injector = array()
	List of HTMLPurifier_Injector to be performed during well-formedness fixing. More...

	$defines_child_def = false
	Boolean flag that indicates whether or not getChildDef is implemented. More...

	$safe = true
	Boolean flag whether or not this module is safe. More...

Detailed Description

XHTML 1.1 Forms module, defines all form-related elements found in HTML 4.

Definition at line 6 of file Forms.php.

Member Function Documentation

◆ setup()

HTMLPurifier_HTMLModule_Forms::setup ( $config )

Parameters

HTMLPurifier_Config $config

Definition at line 29 of file Forms.php.

References $form, HTMLPurifier_HTMLModule\addElement(), array, and HTMLPurifier_HTMLModule\makeLookup().

     {
         $form = $this->addElement(
             'form',
             'Form',
             'Required: Heading | List | Block | fieldset',
             'Common',
             array(
                 'accept' => 'ContentTypes',
                 'accept-charset' => 'Charsets',
                 'action*' => 'URI',
                 'method' => 'Enum#get,post',
                 // really ContentType, but these two are the only ones used today
                 'enctype' => 'Enum#application/x-www-form-urlencoded,multipart/form-data',
             )
         );
         $form->excludes = array('form' => true);
 
         $input = $this->addElement(
             'input',
             'Formctrl',
             'Empty',
             'Common',
             array(
                 'accept' => 'ContentTypes',
                 'accesskey' => 'Character',
                 'alt' => 'Text',
                 'checked' => 'Bool#checked',
                 'disabled' => 'Bool#disabled',
                 'maxlength' => 'Number',
                 'name' => 'CDATA',
                 'readonly' => 'Bool#readonly',
                 'size' => 'Number',
                 'src' => 'URI#embedded',
                 'tabindex' => 'Number',
                 'type' => 'Enum#text,password,checkbox,button,radio,submit,reset,file,hidden,image',
                 'value' => 'CDATA',
             )
         );
         $input->attr_transform_post[] = new HTMLPurifier_AttrTransform_Input();
 
         $this->addElement(
             'select',
             'Formctrl',
             'Required: optgroup | option',
             'Common',
             array(
                 'disabled' => 'Bool#disabled',
                 'multiple' => 'Bool#multiple',
                 'name' => 'CDATA',
                 'size' => 'Number',
                 'tabindex' => 'Number',
             )
         );
 
         $this->addElement(
             'option',
             false,
             'Optional: #PCDATA',
             'Common',
             array(
                 'disabled' => 'Bool#disabled',
                 'label' => 'Text',
                 'selected' => 'Bool#selected',
                 'value' => 'CDATA',
             )
         );
         // It's illegal for there to be more than one selected, but not
         // be multiple. Also, no selected means undefined behavior. This might
         // be difficult to implement; perhaps an injector, or a context variable.
 
         $textarea = $this->addElement(
             'textarea',
             'Formctrl',
             'Optional: #PCDATA',
             'Common',
             array(
                 'accesskey' => 'Character',
                 'cols*' => 'Number',
                 'disabled' => 'Bool#disabled',
                 'name' => 'CDATA',
                 'readonly' => 'Bool#readonly',
                 'rows*' => 'Number',
                 'tabindex' => 'Number',
             )
         );
         $textarea->attr_transform_pre[] = new HTMLPurifier_AttrTransform_Textarea();
 
         $button = $this->addElement(
             'button',
             'Formctrl',
             'Optional: #PCDATA | Heading | List | Block | Inline',
             'Common',
             array(
                 'accesskey' => 'Character',
                 'disabled' => 'Bool#disabled',
                 'name' => 'CDATA',
                 'tabindex' => 'Number',
                 'type' => 'Enum#button,submit,reset',
                 'value' => 'CDATA',
             )
         );
 
         // For exclusions, ideally we'd specify content sets, not literal elements
         $button->excludes = $this->makeLookup(
             'form',
             'fieldset', // Form
             'input',
             'select',
             'textarea',
             'label',
             'button', // Formctrl
             'a', // as per HTML 4.01 spec, this is omitted by modularization
             'isindex',
             'iframe' // legacy items
         );
 
         // Extra exclusion: img usemap="" is not permitted within this element.
         // We'll omit this for now, since we don't have any good way of
         // indicating it yet.
 
         // This is HIGHLY user-unfriendly; we need a custom child-def for this
         $this->addElement('fieldset', 'Form', 'Custom: (#WS?,legend,(Flow|#PCDATA)*)', 'Common');
 
         $label = $this->addElement(
             'label',
             'Formctrl',
             'Optional: #PCDATA | Inline',
             'Common',
             array(
                 'accesskey' => 'Character',
                 // 'for' => 'IDREF', // IDREF not implemented, cannot allow
             )
         );
         $label->excludes = array('label' => true);
 
         $this->addElement(
             'legend',
             false,
             'Optional: #PCDATA | Inline',
             'Common',
             array(
                 'accesskey' => 'Character',
             )
         );
 
         $this->addElement(
             'optgroup',
             false,
             'Required: option',
             'Common',
             array(
                 'disabled' => 'Bool#disabled',
                 'label*' => 'Text',
             )
         );
         // Don't forget an injector for <isindex>. This one's a little complex
         // because it maps to multiple elements.
     }

Here is the call graph for this function:

Field Documentation

◆ $content_sets

HTMLPurifier_HTMLModule_Forms::$content_sets

Initial value:

= array(
        'Block' => 'Form',
        'Inline' => 'Formctrl',
    )

array

Definition at line 21 of file Forms.php.

◆ $name

HTMLPurifier_HTMLModule_Forms::$name = 'Forms'

string

Definition at line 11 of file Forms.php.

◆ $safe

HTMLPurifier_HTMLModule_Forms::$safe = false

bool

Definition at line 16 of file Forms.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/ezyang/htmlpurifier/library/HTMLPurifier/HTMLModule/Forms.php

Public Member Functions