lib/htmlpurifier/HTMLPurifier/HTMLModule.php

   1 <?php
   2
   3 /**
   4  * Represents an XHTML 1.1 module, with information on elements, tags
   5  * and attributes.
   6  * @note Even though this is technically XHTML 1.1, it is also used for
   7  *       regular HTML parsing. We are using modulization as a convenient
   8  *       way to represent the internals of HTMLDefinition, and our
   9  *       implementation is by no means conforming and does not directly
  10  *       use the normative DTDs or XML schemas.
  11  * @note The public variables in a module should almost directly
  12  *       correspond to the variables in HTMLPurifier_HTMLDefinition.
  13  *       However, the prefix info carries no special meaning in these
  14  *       objects (include it anyway if that's the correspondence though).
  15  */
  16
  17 class HTMLPurifier_HTMLModule
  18 {
  19     /**
  20      * Short unique string identifier of the module
  21      */
  22     var $name;
  23
  24     /**
  25      * Dynamically set integer that specifies when the module was loaded in.
  26      */
  27     var $order;
  28
  29     /**
  30      * Informally, a list of elements this module changes. Not used in
  31      * any significant way.
  32      * @protected
  33      */
  34     var $elements = array();
  35
  36     /**
  37      * Associative array of element names to element definitions.
  38      * Some definitions may be incomplete, to be merged in later
  39      * with the full definition.
  40      * @public
  41      */
  42     var $info = array();
  43
  44     /**
  45      * Associative array of content set names to content set additions.
  46      * This is commonly used to, say, add an A element to the Inline
  47      * content set. This corresponds to an internal variable $content_sets
  48      * and NOT info_content_sets member variable of HTMLDefinition.
  49      * @public
  50      */
  51     var $content_sets = array();
  52
  53     /**
  54      * Associative array of attribute collection names to attribute
  55      * collection additions. More rarely used for adding attributes to
  56      * the global collections. Example is the StyleAttribute module adding
  57      * the style attribute to the Core. Corresponds to HTMLDefinition's
  58      * attr_collections->info, since the object's data is only info,
  59      * with extra behavior associated with it.
  60      * @public
  61      */
  62     var $attr_collections = array();
  63
  64     /**
  65      * Associative array of deprecated tag name to HTMLPurifier_TagTransform
  66      * @public
  67      */
  68     var $info_tag_transform = array();
  69
  70     /**
  71      * List of HTMLPurifier_AttrTransform to be performed before validation.
  72      * @public
  73      */
  74     var $info_attr_transform_pre = array();
  75
  76     /**
  77      * List of HTMLPurifier_AttrTransform to be performed after validation.
  78      * @public
  79      */
  80     var $info_attr_transform_post = array();
  81
  82     /**
  83      * Boolean flag that indicates whether or not getChildDef is implemented.
  84      * For optimization reasons: may save a call to a function. Be sure
  85      * to set it if you do implement getChildDef(), otherwise it will have
  86      * no effect!
  87      * @public
  88      */
  89     var $defines_child_def = false;
  90
  91     /**
  92      * Retrieves a proper HTMLPurifier_ChildDef subclass based on
  93      * content_model and content_model_type member variables of
  94      * the HTMLPurifier_ElementDef class. There is a similar function
  95      * in HTMLPurifier_HTMLDefinition.
  96      * @param $def HTMLPurifier_ElementDef instance
  97      * @return HTMLPurifier_ChildDef subclass
  98      * @public
  99      */
 100     function getChildDef($def) {return false;}
 101
 102     /**
 103      * Hook method that lets module perform arbitrary operations on
 104      * HTMLPurifier_HTMLDefinition before the module gets processed.
 105      * @param $definition Reference to HTMLDefinition being setup
 106      */
 107     function preProcess(&$definition) {}
 108
 109     /**
 110      * Hook method that lets module perform arbitrary operations
 111      * on HTMLPurifier_HTMLDefinition after the module gets processed.
 112      * @param $definition Reference to HTMLDefinition being setup
 113      */
 114     function postProcess(&$definition) {}
 115
 116     /**
 117      * Hook method that is called when a module gets registered to
 118      * the definition.
 119      * @param $definition Reference to HTMLDefinition being setup
 120      */
 121     function setup(&$definition) {}
 122
 123 }
 124
 125 ?>