diff options
Diffstat (limited to 'library/HTMLPurifier/HTMLModule.php')
| -rw-r--r-- | library/HTMLPurifier/HTMLModule.php | 122 |
1 files changed, 81 insertions, 41 deletions
diff --git a/library/HTMLPurifier/HTMLModule.php b/library/HTMLPurifier/HTMLModule.php index 072cf6808..bb3a9230b 100644 --- a/library/HTMLPurifier/HTMLModule.php +++ b/library/HTMLPurifier/HTMLModule.php @@ -21,13 +21,15 @@ class HTMLPurifier_HTMLModule // -- Overloadable ---------------------------------------------------- /** - * Short unique string identifier of the module + * Short unique string identifier of the module. + * @type string */ public $name; /** - * Informally, a list of elements this module changes. Not used in - * any significant way. + * Informally, a list of elements this module changes. + * Not used in any significant way. + * @type array */ public $elements = array(); @@ -35,6 +37,7 @@ class HTMLPurifier_HTMLModule * Associative array of element names to element definitions. * Some definitions may be incomplete, to be merged in later * with the full definition. + * @type array */ public $info = array(); @@ -43,6 +46,7 @@ class HTMLPurifier_HTMLModule * This is commonly used to, say, add an A element to the Inline * content set. This corresponds to an internal variable $content_sets * and NOT info_content_sets member variable of HTMLDefinition. + * @type array */ public $content_sets = array(); @@ -53,21 +57,25 @@ class HTMLPurifier_HTMLModule * the style attribute to the Core. Corresponds to HTMLDefinition's * attr_collections->info, since the object's data is only info, * with extra behavior associated with it. + * @type array */ public $attr_collections = array(); /** - * Associative array of deprecated tag name to HTMLPurifier_TagTransform + * Associative array of deprecated tag name to HTMLPurifier_TagTransform. + * @type array */ public $info_tag_transform = array(); /** * List of HTMLPurifier_AttrTransform to be performed before validation. + * @type array */ public $info_attr_transform_pre = array(); /** * List of HTMLPurifier_AttrTransform to be performed after validation. + * @type array */ public $info_attr_transform_post = array(); @@ -76,6 +84,7 @@ class HTMLPurifier_HTMLModule * An injector will only be invoked if all of it's pre-requisites are met; * if an injector fails setup, there will be no error; it will simply be * silently disabled. + * @type array */ public $info_injector = array(); @@ -84,6 +93,7 @@ class HTMLPurifier_HTMLModule * For optimization reasons: may save a call to a function. Be sure * to set it if you do implement getChildDef(), otherwise it will have * no effect! + * @type bool */ public $defines_child_def = false; @@ -94,6 +104,7 @@ class HTMLPurifier_HTMLModule * which is based off of safe HTML, to explicitly say, "This is safe," even * though there are modules which are "unsafe") * + * @type bool * @note Previously, safety could be applied at an element level granularity. * We've removed this ability, so in order to add "unsafe" elements * or attributes, a dedicated module with this property set to false @@ -106,51 +117,62 @@ class HTMLPurifier_HTMLModule * content_model and content_model_type member variables of * the HTMLPurifier_ElementDef class. There is a similar function * in HTMLPurifier_HTMLDefinition. - * @param $def HTMLPurifier_ElementDef instance + * @param HTMLPurifier_ElementDef $def * @return HTMLPurifier_ChildDef subclass */ - public function getChildDef($def) {return false;} + public function getChildDef($def) + { + return false; + } // -- Convenience ----------------------------------------------------- /** * Convenience function that sets up a new element - * @param $element Name of element to add - * @param $type What content set should element be registered to? + * @param string $element Name of element to add + * @param string|bool $type What content set should element be registered to? * Set as false to skip this step. - * @param $contents Allowed children in form of: + * @param string $contents Allowed children in form of: * "$content_model_type: $content_model" - * @param $attr_includes What attribute collections to register to + * @param array $attr_includes What attribute collections to register to * element? - * @param $attr What unique attributes does the element define? - * @note See ElementDef for in-depth descriptions of these parameters. - * @return Created element definition object, so you + * @param array $attr What unique attributes does the element define? + * @see HTMLPurifier_ElementDef:: for in-depth descriptions of these parameters. + * @return HTMLPurifier_ElementDef Created element definition object, so you * can set advanced parameters */ - public function addElement($element, $type, $contents, $attr_includes = array(), $attr = array()) { + public function addElement($element, $type, $contents, $attr_includes = array(), $attr = array()) + { $this->elements[] = $element; // parse content_model list($content_model_type, $content_model) = $this->parseContents($contents); // merge in attribute inclusions $this->mergeInAttrIncludes($attr, $attr_includes); // add element to content sets - if ($type) $this->addElementToContentSet($element, $type); + if ($type) { + $this->addElementToContentSet($element, $type); + } // create element $this->info[$element] = HTMLPurifier_ElementDef::create( - $content_model, $content_model_type, $attr + $content_model, + $content_model_type, + $attr ); // literal object $contents means direct child manipulation - if (!is_string($contents)) $this->info[$element]->child = $contents; + if (!is_string($contents)) { + $this->info[$element]->child = $contents; + } return $this->info[$element]; } /** * Convenience function that creates a totally blank, non-standalone * element. - * @param $element Name of element to create - * @return Created element + * @param string $element Name of element to create + * @return HTMLPurifier_ElementDef Created element */ - public function addBlankElement($element) { + public function addBlankElement($element) + { if (!isset($this->info[$element])) { $this->elements[] = $element; $this->info[$element] = new HTMLPurifier_ElementDef(); @@ -163,27 +185,35 @@ class HTMLPurifier_HTMLModule /** * Convenience function that registers an element to a content set - * @param Element to register - * @param Name content set (warning: case sensitive, usually upper-case + * @param string $element Element to register + * @param string $type Name content set (warning: case sensitive, usually upper-case * first letter) */ - public function addElementToContentSet($element, $type) { - if (!isset($this->content_sets[$type])) $this->content_sets[$type] = ''; - else $this->content_sets[$type] .= ' | '; + public function addElementToContentSet($element, $type) + { + if (!isset($this->content_sets[$type])) { + $this->content_sets[$type] = ''; + } else { + $this->content_sets[$type] .= ' | '; + } $this->content_sets[$type] .= $element; } /** * Convenience function that transforms single-string contents * into separate content model and content model type - * @param $contents Allowed children in form of: + * @param string $contents Allowed children in form of: * "$content_model_type: $content_model" + * @return array * @note If contents is an object, an array of two nulls will be * returned, and the callee needs to take the original $contents * and use it directly. */ - public function parseContents($contents) { - if (!is_string($contents)) return array(null, null); // defer + public function parseContents($contents) + { + if (!is_string($contents)) { + return array(null, null); + } // defer switch ($contents) { // check for shorthand content model forms case 'Empty': @@ -202,13 +232,17 @@ class HTMLPurifier_HTMLModule /** * Convenience function that merges a list of attribute includes into * an attribute array. - * @param $attr Reference to attr array to modify - * @param $attr_includes Array of includes / string include to merge in + * @param array $attr Reference to attr array to modify + * @param array $attr_includes Array of includes / string include to merge in */ - public function mergeInAttrIncludes(&$attr, $attr_includes) { + public function mergeInAttrIncludes(&$attr, $attr_includes) + { if (!is_array($attr_includes)) { - if (empty($attr_includes)) $attr_includes = array(); - else $attr_includes = array($attr_includes); + if (empty($attr_includes)) { + $attr_includes = array(); + } else { + $attr_includes = array($attr_includes); + } } $attr[0] = $attr_includes; } @@ -216,16 +250,21 @@ class HTMLPurifier_HTMLModule /** * Convenience function that generates a lookup table with boolean * true as value. - * @param $list List of values to turn into a lookup + * @param string $list List of values to turn into a lookup * @note You can also pass an arbitrary number of arguments in * place of the regular argument - * @return Lookup array equivalent of list + * @return array array equivalent of list */ - public function makeLookup($list) { - if (is_string($list)) $list = func_get_args(); + public function makeLookup($list) + { + if (is_string($list)) { + $list = func_get_args(); + } $ret = array(); foreach ($list as $value) { - if (is_null($value)) continue; + if (is_null($value)) { + continue; + } $ret[$value] = true; } return $ret; @@ -235,10 +274,11 @@ class HTMLPurifier_HTMLModule * Lazy load construction of the module after determining whether * or not it's needed, and also when a finalized configuration object * is available. - * @param $config Instance of HTMLPurifier_Config + * @param HTMLPurifier_Config $config */ - public function setup($config) {} - + public function setup($config) + { + } } // vim: et sw=4 sts=4 |