Docs for page HTMLPurifier.standalone.php

Classes

Class	Description
HTMLPurifier	Facade that coordinates HTML Purifier's subsystems in order to purify HTML.
HTMLPurifier_AttrCollections	Defines common attribute collections that modules reference
HTMLPurifier_AttrDef	Base class for all validating attribute definitions.
HTMLPurifier_AttrTransform	Processes an entire attribute array for corrections needing multiple values.
HTMLPurifier_AttrTypes	Provides lookup array of attribute types to HTMLPurifier_AttrDef objects
HTMLPurifier_AttrValidator	Validates the attributes of a token. Doesn't manage required attributes very well. The only reason we factored this out was because RemoveForeignElements also needed it besides ValidateAttributes.
HTMLPurifier_Bootstrap	Bootstrap class that contains meta-functionality for HTML Purifier such as the autoload function.
HTMLPurifier_Definition	Super-class for definition datatype objects, implements serialization functions for the class.
HTMLPurifier_CSSDefinition	Defines allowed CSS attributes and what their values are.
HTMLPurifier_ChildDef	Defines allowed child nodes and validates tokens against it.
HTMLPurifier_Config	Configuration object that triggers customizable behavior.
HTMLPurifier_ConfigSchema	Configuration definition, defines directives and their defaults.
HTMLPurifier_ContentSets
HTMLPurifier_Context	Registry object that contains information about the current context.
HTMLPurifier_DefinitionCache	Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCacheFactory	Responsible for creating definition caches.
HTMLPurifier_Doctype	Represents a document type, contains information on which modules need to be loaded.
HTMLPurifier_DoctypeRegistry
HTMLPurifier_ElementDef	Structure that stores an HTML element definition. Used by HTMLPurifier_HTMLDefinition and HTMLPurifier_HTMLModule.
HTMLPurifier_Encoder	A UTF-8 specific character encoder that handles cleaning and transforming.
HTMLPurifier_EntityLookup	Object that provides entity lookup table from entity name to character
HTMLPurifier_EntityParser	Handles referencing and derefencing character entities
HTMLPurifier_ErrorCollector	Error collection class that enables HTML Purifier to report HTML
HTMLPurifier_Exception	Global exception class for HTML Purifier; any exceptions we throw are from here.
HTMLPurifier_Filter	Represents a pre or post processing filter on HTML Purifier's output
HTMLPurifier_Generator	Generates HTML from tokens.
HTMLPurifier_HTMLDefinition	Definition of the purified HTML that describes allowed children, attributes, and many other things.
HTMLPurifier_HTMLModule	Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModuleManager
HTMLPurifier_IDAccumulator	Component of HTMLPurifier_AttrContext that accumulates IDs to prevent dupes
HTMLPurifier_Injector	Injects tokens into the document while parsing for well-formedness.
HTMLPurifier_Language	Represents a language and defines localizable string formatting and other functions, as well as the localized messages for HTML Purifier.
HTMLPurifier_LanguageFactory	Class responsible for generating HTMLPurifier_Language objects, managing caching and fallbacks.
HTMLPurifier_Length	Represents a measurable length, with a string numeric magnitude and a unit. This object is immutable.
HTMLPurifier_Lexer	Forgivingly lexes HTML (SGML-style) markup into tokens.
HTMLPurifier_PercentEncoder	Class that handles operations involving percent-encoding in URIs.
HTMLPurifier_Strategy	Supertype for classes that define a strategy for modifying/purifying tokens.
HTMLPurifier_StringHash	This is in almost every respect equivalent to an array except that it keeps track of which keys were accessed.
HTMLPurifier_StringHashParser	Parses string hash files. File format is as such:
HTMLPurifier_TagTransform	Defines a mutation of an obsolete tag into a valid tag.
HTMLPurifier_Token	Abstract base token class that all others inherit from.
HTMLPurifier_TokenFactory	Factory for token generation.
HTMLPurifier_URI	HTML Purifier's internal representation of a URI.
HTMLPurifier_URIDefinition	Super-class for definition datatype objects, implements serialization functions for the class.
HTMLPurifier_URIFilter	Chainable filters for custom URI processing.
HTMLPurifier_URIParser	Parses a URI into the components and fragment identifier as specified by RFC 3986.
HTMLPurifier_URIScheme	Validator for the components of a URI for a specific scheme
HTMLPurifier_URISchemeRegistry	Registry for retrieving specific URI scheme validator objects.
HTMLPurifier_UnitConverter	Class for converting between different unit-lengths as specified by CSS.
HTMLPurifier_VarParser	Parses string representations into their corresponding native PHP variable type. The base implementation does a simple type-check.
HTMLPurifier_VarParserException	Exception type for HTMLPurifier_VarParser
HTMLPurifier_AttrDef_CSS	Validates the HTML attribute style, otherwise known as CSS.
HTMLPurifier_AttrDef_Enum	Validates a keyword against a list of valid values.
HTMLPurifier_AttrDef_Integer	Validates an integer.
HTMLPurifier_AttrDef_Lang	Validates the HTML attribute lang, effectively a language code.
HTMLPurifier_AttrDef_Switch	Decorator that, depending on a token, switches between two definitions.
HTMLPurifier_AttrDef_Text	Validates arbitrary text according to the HTML spec.
HTMLPurifier_AttrDef_URI	Validates a URI as defined by RFC 3986.
HTMLPurifier_AttrDef_CSS_Number	Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_AlphaValue	Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Background	Validates shorthand CSS property background.
HTMLPurifier_AttrDef_CSS_BackgroundPosition	Validates the value of background-position.
HTMLPurifier_AttrDef_CSS_Border	Validates the border property as defined by CSS.
HTMLPurifier_AttrDef_CSS_Color	Validates Color as defined by CSS.
HTMLPurifier_AttrDef_CSS_Composite	Allows multiple validators to attempt to validate attribute.
HTMLPurifier_AttrDef_CSS_DenyElementDecorator	Decorator which enables CSS properties to be disabled for specific elements.
HTMLPurifier_AttrDef_CSS_Filter	Microsoft's proprietary filter: CSS property
HTMLPurifier_AttrDef_CSS_Font	Validates shorthand CSS property font.
HTMLPurifier_AttrDef_CSS_FontFamily	Validates a font family list according to CSS spec
HTMLPurifier_AttrDef_CSS_ImportantDecorator	Decorator which enables !important to be used in CSS values.
HTMLPurifier_AttrDef_CSS_Length	Represents a Length as defined by CSS.
HTMLPurifier_AttrDef_CSS_ListStyle	Validates shorthand CSS property list-style.
HTMLPurifier_AttrDef_CSS_Multiple	Framework class for strings that involve multiple values.
HTMLPurifier_AttrDef_CSS_Percentage	Validates a Percentage as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_TextDecoration	Validates the value for the CSS property text-decoration
HTMLPurifier_AttrDef_CSS_URI	Validates a URI in CSS syntax, which uses url('http://example.com')
HTMLPurifier_AttrDef_HTML_Bool	Validates a boolean attribute
HTMLPurifier_AttrDef_HTML_Color	Validates a color according to the HTML spec.
HTMLPurifier_AttrDef_HTML_FrameTarget	Special-case enum attribute definition that lazy loads allowed frame targets
HTMLPurifier_AttrDef_HTML_ID	Validates the HTML attribute ID.
HTMLPurifier_AttrDef_HTML_Pixels	Validates an integer representation of pixels according to the HTML spec.
HTMLPurifier_AttrDef_HTML_Length	Validates the HTML type length (not to be confused with CSS's length).
HTMLPurifier_AttrDef_HTML_LinkTypes	Validates a rel/rev link attribute against a directive of allowed values
HTMLPurifier_AttrDef_HTML_MultiLength	Validates a MultiLength as defined by the HTML spec.
HTMLPurifier_AttrDef_HTML_Nmtokens	Validates contents based on NMTOKENS attribute type.
HTMLPurifier_AttrDef_URI_Email	Base class for all validating attribute definitions.
HTMLPurifier_AttrDef_URI_Host	Validates a host according to the IPv4, IPv6 and DNS (future) specifications.
HTMLPurifier_AttrDef_URI_IPv4	Validates an IPv4 address
HTMLPurifier_AttrDef_URI_IPv6	Validates an IPv6 address.
HTMLPurifier_AttrDef_URI_Email_SimpleCheck	Primitive email validation class based on the regexp found at
HTMLPurifier_AttrTransform_BdoDir	Post-trasnform that ensures that bdo tags have the dir attribute set.
HTMLPurifier_AttrTransform_BgColor	Pre-transform that changes deprecated bgcolor attribute to CSS.
HTMLPurifier_AttrTransform_BoolToCSS	Pre-transform that changes converts a boolean attribute to fixed CSS
HTMLPurifier_AttrTransform_Border	Pre-transform that changes deprecated border attribute to CSS.
HTMLPurifier_AttrTransform_EnumToCSS	Generic pre-transform that converts an attribute with a fixed number of values (enumerated) to CSS.
HTMLPurifier_AttrTransform_ImgRequired	Transform that supplies default values for the src and alt attributes in img tags, as well as prevents the img tag from being removed because of a missing alt tag. This needs to be registered as both a pre and post attribute transform.
HTMLPurifier_AttrTransform_ImgSpace	Pre-transform that changes deprecated hspace and vspace attributes to CSS
HTMLPurifier_AttrTransform_Lang	Post-transform that copies lang's value to xml:lang (and vice-versa)
HTMLPurifier_AttrTransform_Length	Class for handling width/height length attribute transformations to CSS
HTMLPurifier_AttrTransform_Name	Pre-transform that changes deprecated name attribute to ID if necessary
HTMLPurifier_AttrTransform_SafeEmbed	Processes an entire attribute array for corrections needing multiple values.
HTMLPurifier_AttrTransform_SafeObject	Writes default type for all objects. Currently only supports flash.
HTMLPurifier_AttrTransform_SafeParam	Validates name/value pairs in param tags to be used in safe objects. This will only allow name values it recognizes, and pre-fill certain attributes with required values.
HTMLPurifier_AttrTransform_ScriptRequired	Implements required attribute stipulation for <script>
HTMLPurifier_ChildDef_Chameleon	Definition that uses different definitions depending on context.
HTMLPurifier_ChildDef_Custom	Custom validation class, accepts DTD child definitions
HTMLPurifier_ChildDef_Empty	Definition that disallows all elements.
HTMLPurifier_ChildDef_Required	Definition that allows a set of elements, but disallows empty children.
HTMLPurifier_ChildDef_Optional	Definition that allows a set of elements, and allows no children.
HTMLPurifier_ChildDef_StrictBlockquote	Takes the contents of blockquote when in strict and reformats for validation.
HTMLPurifier_ChildDef_Table	Definition for tables
HTMLPurifier_DefinitionCache_Decorator	Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCache_Null	Null cache object to use when no caching is on.
HTMLPurifier_DefinitionCache_Serializer	Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCache_Decorator_Cleanup	Definition cache decorator class that cleans up the cache whenever there is a cache miss.
HTMLPurifier_DefinitionCache_Decorator_Memory	Definition cache decorator class that saves all cache retrievals to PHP's memory; good for unit tests or circumstances where there are lots of configuration objects floating around.
HTMLPurifier_HTMLModule_Bdo	XHTML 1.1 Bi-directional Text Module, defines elements that declare directionality of content. Text Extension Module.
HTMLPurifier_HTMLModule_CommonAttributes	Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Edit	XHTML 1.1 Edit Module, defines editing-related elements. Text Extension Module.
HTMLPurifier_HTMLModule_Hypertext	XHTML 1.1 Hypertext Module, defines hypertext links. Core Module.
HTMLPurifier_HTMLModule_Image	XHTML 1.1 Image Module provides basic image embedding.
HTMLPurifier_HTMLModule_Legacy	XHTML 1.1 Legacy module defines elements that were previously deprecated.
HTMLPurifier_HTMLModule_List	XHTML 1.1 List Module, defines list-oriented elements. Core Module.
HTMLPurifier_HTMLModule_NonXMLCommonAttributes	Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Object	XHTML 1.1 Object Module, defines elements for generic object inclusion
HTMLPurifier_HTMLModule_Presentation	XHTML 1.1 Presentation Module, defines simple presentation-related markup. Text Extension Module.
HTMLPurifier_HTMLModule_Proprietary	Module defines proprietary tags and attributes in HTML.
HTMLPurifier_HTMLModule_Ruby	XHTML 1.1 Ruby Annotation Module, defines elements that indicate short runs of text alongside base text for annotation or pronounciation.
HTMLPurifier_HTMLModule_SafeEmbed	A "safe" embed module. See SafeObject. This is a proprietary element.
HTMLPurifier_HTMLModule_SafeObject	A "safe" object module. In theory, objects permitted by this module will be safe, and untrusted users can be allowed to embed arbitrary flash objects (maybe other types too, but only Flash is supported as of right now).
HTMLPurifier_HTMLModule_Scripting	XHTML 1.1 Scripting module, defines elements that are used to contain information pertaining to executable scripts or the lack of support for executable scripts.
HTMLPurifier_HTMLModule_StyleAttribute	XHTML 1.1 Edit Module, defines editing-related elements. Text Extension Module.
HTMLPurifier_HTMLModule_Tables	XHTML 1.1 Tables Module, fully defines accessible table elements.
HTMLPurifier_HTMLModule_Target	XHTML 1.1 Target Module, defines target attribute in link elements.
HTMLPurifier_HTMLModule_Text	XHTML 1.1 Text Module, defines basic text containers. Core Module.
HTMLPurifier_HTMLModule_Tidy	Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_XMLCommonAttributes	Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Tidy_Proprietary	Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4	Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Strict	Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Transitional	Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_XHTML	Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_Injector_AutoParagraph	Injector that auto paragraphs text in the root node based on double-spacing.
HTMLPurifier_Injector_Linkify	Injector that converts http, https and ftp text URLs to actual links.
HTMLPurifier_Injector_PurifierLinkify	Injector that converts configuration directive syntax %Namespace.Directive
HTMLPurifier_Injector_SafeObject	Adds important param elements to inside of object in order to make things safe.
HTMLPurifier_Lexer_DOMLex	Parser that uses PHP 5's DOM extension (part of the core).
HTMLPurifier_Lexer_DirectLex	Our in-house implementation of a parser.
HTMLPurifier_Strategy_Composite	Composite strategy that runs multiple strategies on tokens.
HTMLPurifier_Strategy_Core	Core strategy composed of the big four strategies.
HTMLPurifier_Strategy_FixNesting	Takes a well formed list of tokens and fixes their nesting.
HTMLPurifier_Strategy_MakeWellFormed	Takes tokens makes them well-formed (balance end tags, etc.)
HTMLPurifier_Strategy_RemoveForeignElements	Removes all unrecognized tags from the list of tokens.
HTMLPurifier_Strategy_ValidateAttributes	Validate all attributes in the tokens.
HTMLPurifier_TagTransform_Font	Transforms FONT tags to the proper form (SPAN with CSS styling)
HTMLPurifier_TagTransform_Simple	Simple transformation, just change tag name to something else, and possibly add some styling. This will cover most of the deprecated tag cases.
HTMLPurifier_Token_Comment	Concrete comment token class. Generally will be ignored.
HTMLPurifier_Token_Tag	Abstract class of a tag token (start, end or empty), and its behavior.
HTMLPurifier_Token_Empty	Concrete empty token class.
HTMLPurifier_Token_End	Concrete end token class.
HTMLPurifier_Token_Start	Concrete start token class.
HTMLPurifier_Token_Text	Concrete text token class.
HTMLPurifier_URIFilter_DisableExternal	Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_DisableExternalResources	Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_HostBlacklist	Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_MakeAbsolute	Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_Munge	Chainable filters for custom URI processing.
HTMLPurifier_URIScheme_ftp	Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738.
HTMLPurifier_URIScheme_http	Validates http (HyperText Transfer Protocol) as defined by RFC 2616
HTMLPurifier_URIScheme_https	Validates https (Secure HTTP) according to http scheme.
HTMLPurifier_URIScheme_mailto	Validates mailto (for E-mail) according to RFC 2368
HTMLPurifier_URIScheme_news	Validates news (Usenet) as defined by generic RFC 1738
HTMLPurifier_URIScheme_nntp	Validates nntp (Network News Transfer Protocol) as defined by generic RFC 1738
HTMLPurifier_VarParser_Flexible	Performs safe variable parsing based on types which can be used by users. This may not be able to represent all possible data inputs, however.
HTMLPurifier_VarParser_Native	This variable parser uses PHP's internal code engine. Because it does this, it can represent all inputs; however, it is dangerous and cannot be used by users.

Procedural File: HTMLPurifier.standalone.php