remove autoload section in composer.json

[github/wallabag/wallabag.git] / inc / 3rdparty / htmlpurifier / HTMLPurifier / HTMLModule.php

<?php\r
\r
/**\r
 * Represents an XHTML 1.1 module, with information on elements, tags\r
 * and attributes.\r
 * @note Even though this is technically XHTML 1.1, it is also used for\r
 *       regular HTML parsing. We are using modulization as a convenient\r
 *       way to represent the internals of HTMLDefinition, and our\r
 *       implementation is by no means conforming and does not directly\r
 *       use the normative DTDs or XML schemas.\r
 * @note The public variables in a module should almost directly\r
 *       correspond to the variables in HTMLPurifier_HTMLDefinition.\r
 *       However, the prefix info carries no special meaning in these\r
 *       objects (include it anyway if that's the correspondence though).\r
 * @todo Consider making some member functions protected\r
 */\r
\r
class HTMLPurifier_HTMLModule\r
{\r
\r
    // -- Overloadable ----------------------------------------------------\r
\r
    /**\r
     * Short unique string identifier of the module.\r
     * @type string\r
     */\r
    public $name;\r
\r
    /**\r
     * Informally, a list of elements this module changes.\r
     * Not used in any significant way.\r
     * @type array\r
     */\r
    public $elements = array();\r
\r
    /**\r
     * Associative array of element names to element definitions.\r
     * Some definitions may be incomplete, to be merged in later\r
     * with the full definition.\r
     * @type array\r
     */\r
    public $info = array();\r
\r
    /**\r
     * Associative array of content set names to content set additions.\r
     * This is commonly used to, say, add an A element to the Inline\r
     * content set. This corresponds to an internal variable $content_sets\r
     * and NOT info_content_sets member variable of HTMLDefinition.\r
     * @type array\r
     */\r
    public $content_sets = array();\r
\r
    /**\r
     * Associative array of attribute collection names to attribute\r
     * collection additions. More rarely used for adding attributes to\r
     * the global collections. Example is the StyleAttribute module adding\r
     * the style attribute to the Core. Corresponds to HTMLDefinition's\r
     * attr_collections->info, since the object's data is only info,\r
     * with extra behavior associated with it.\r
     * @type array\r
     */\r
    public $attr_collections = array();\r
\r
    /**\r
     * Associative array of deprecated tag name to HTMLPurifier_TagTransform.\r
     * @type array\r
     */\r
    public $info_tag_transform = array();\r
\r
    /**\r
     * List of HTMLPurifier_AttrTransform to be performed before validation.\r
     * @type array\r
     */\r
    public $info_attr_transform_pre = array();\r
\r
    /**\r
     * List of HTMLPurifier_AttrTransform to be performed after validation.\r
     * @type array\r
     */\r
    public $info_attr_transform_post = array();\r
\r
    /**\r
     * List of HTMLPurifier_Injector to be performed during well-formedness fixing.\r
     * An injector will only be invoked if all of it's pre-requisites are met;\r
     * if an injector fails setup, there will be no error; it will simply be\r
     * silently disabled.\r
     * @type array\r
     */\r
    public $info_injector = array();\r
\r
    /**\r
     * Boolean flag that indicates whether or not getChildDef is implemented.\r
     * For optimization reasons: may save a call to a function. Be sure\r
     * to set it if you do implement getChildDef(), otherwise it will have\r
     * no effect!\r
     * @type bool\r
     */\r
    public $defines_child_def = false;\r
\r
    /**\r
     * Boolean flag whether or not this module is safe. If it is not safe, all\r
     * of its members are unsafe. Modules are safe by default (this might be\r
     * slightly dangerous, but it doesn't make much sense to force HTML Purifier,\r
     * which is based off of safe HTML, to explicitly say, "This is safe," even\r
     * though there are modules which are "unsafe")\r
     *\r
     * @type bool\r
     * @note Previously, safety could be applied at an element level granularity.\r
     *       We've removed this ability, so in order to add "unsafe" elements\r
     *       or attributes, a dedicated module with this property set to false\r
     *       must be used.\r
     */\r
    public $safe = true;\r
\r
    /**\r
     * Retrieves a proper HTMLPurifier_ChildDef subclass based on\r
     * content_model and content_model_type member variables of\r
     * the HTMLPurifier_ElementDef class. There is a similar function\r
     * in HTMLPurifier_HTMLDefinition.\r
     * @param HTMLPurifier_ElementDef $def\r
     * @return HTMLPurifier_ChildDef subclass\r
     */\r
    public function getChildDef($def)\r
    {\r
        return false;\r
    }\r
\r
    // -- Convenience -----------------------------------------------------\r
\r
    /**\r
     * Convenience function that sets up a new element\r
     * @param string $element Name of element to add\r
     * @param string|bool $type What content set should element be registered to?\r
     *              Set as false to skip this step.\r
     * @param string $contents Allowed children in form of:\r
     *              "$content_model_type: $content_model"\r
     * @param array $attr_includes What attribute collections to register to\r
     *              element?\r
     * @param array $attr What unique attributes does the element define?\r
     * @see HTMLPurifier_ElementDef:: for in-depth descriptions of these parameters.\r
     * @return HTMLPurifier_ElementDef Created element definition object, so you\r
     *         can set advanced parameters\r
     */\r
    public function addElement($element, $type, $contents, $attr_includes = array(), $attr = array())\r
    {\r
        $this->elements[] = $element;\r
        // parse content_model\r
        list($content_model_type, $content_model) = $this->parseContents($contents);\r
        // merge in attribute inclusions\r
        $this->mergeInAttrIncludes($attr, $attr_includes);\r
        // add element to content sets\r
        if ($type) {\r
            $this->addElementToContentSet($element, $type);\r
        }\r
        // create element\r
        $this->info[$element] = HTMLPurifier_ElementDef::create(\r
            $content_model,\r
            $content_model_type,\r
            $attr\r
        );\r
        // literal object $contents means direct child manipulation\r
        if (!is_string($contents)) {\r
            $this->info[$element]->child = $contents;\r
        }\r
        return $this->info[$element];\r
    }\r
\r
    /**\r
     * Convenience function that creates a totally blank, non-standalone\r
     * element.\r
     * @param string $element Name of element to create\r
     * @return HTMLPurifier_ElementDef Created element\r
     */\r
    public function addBlankElement($element)\r
    {\r
        if (!isset($this->info[$element])) {\r
            $this->elements[] = $element;\r
            $this->info[$element] = new HTMLPurifier_ElementDef();\r
            $this->info[$element]->standalone = false;\r
        } else {\r
            trigger_error("Definition for $element already exists in module, cannot redefine");\r
        }\r
        return $this->info[$element];\r
    }\r
\r
    /**\r
     * Convenience function that registers an element to a content set\r
     * @param string $element Element to register\r
     * @param string $type Name content set (warning: case sensitive, usually upper-case\r
     *        first letter)\r
     */\r
    public function addElementToContentSet($element, $type)\r
    {\r
        if (!isset($this->content_sets[$type])) {\r
            $this->content_sets[$type] = '';\r
        } else {\r
            $this->content_sets[$type] .= ' | ';\r
        }\r
        $this->content_sets[$type] .= $element;\r
    }\r
\r
    /**\r
     * Convenience function that transforms single-string contents\r
     * into separate content model and content model type\r
     * @param string $contents Allowed children in form of:\r
     *                  "$content_model_type: $content_model"\r
     * @return array\r
     * @note If contents is an object, an array of two nulls will be\r
     *       returned, and the callee needs to take the original $contents\r
     *       and use it directly.\r
     */\r
    public function parseContents($contents)\r
    {\r
        if (!is_string($contents)) {\r
            return array(null, null);\r
        } // defer\r
        switch ($contents) {\r
            // check for shorthand content model forms\r
            case 'Empty':\r
                return array('empty', '');\r
            case 'Inline':\r
                return array('optional', 'Inline | #PCDATA');\r
            case 'Flow':\r
                return array('optional', 'Flow | #PCDATA');\r
        }\r
        list($content_model_type, $content_model) = explode(':', $contents);\r
        $content_model_type = strtolower(trim($content_model_type));\r
        $content_model = trim($content_model);\r
        return array($content_model_type, $content_model);\r
    }\r
\r
    /**\r
     * Convenience function that merges a list of attribute includes into\r
     * an attribute array.\r
     * @param array $attr Reference to attr array to modify\r
     * @param array $attr_includes Array of includes / string include to merge in\r
     */\r
    public function mergeInAttrIncludes(&$attr, $attr_includes)\r
    {\r
        if (!is_array($attr_includes)) {\r
            if (empty($attr_includes)) {\r
                $attr_includes = array();\r
            } else {\r
                $attr_includes = array($attr_includes);\r
            }\r
        }\r
        $attr[0] = $attr_includes;\r
    }\r
\r
    /**\r
     * Convenience function that generates a lookup table with boolean\r
     * true as value.\r
     * @param string $list List of values to turn into a lookup\r
     * @note You can also pass an arbitrary number of arguments in\r
     *       place of the regular argument\r
     * @return array array equivalent of list\r
     */\r
    public function makeLookup($list)\r
    {\r
        if (is_string($list)) {\r
            $list = func_get_args();\r
        }\r
        $ret = array();\r
        foreach ($list as $value) {\r
            if (is_null($value)) {\r
                continue;\r
            }\r
            $ret[$value] = true;\r
        }\r
        return $ret;\r
    }\r
\r
    /**\r
     * Lazy load construction of the module after determining whether\r
     * or not it's needed, and also when a finalized configuration object\r
     * is available.\r
     * @param HTMLPurifier_Config $config\r
     */\r
    public function setup($config)\r
    {\r
    }\r
}\r
\r
// vim: et sw=4 sts=4\r