Full index

Package indexes


a b c d e f g h i k l m n o p q r s t u v w x y z _
a
top
$accessed
$addParam
$aliases
List of aliases for this doctype
$aliases
Lookup table of aliases to real doctype names
$allow
$allowedParam
$allowedUnits
Lookup array of units recognized by CSS 2.
$allow_empty
$allow_empty
$allow_empty
$allow_empty
$allow_empty
Bool that indicates whether or not an empty array of children is okay This is necessary for redundant checking when changes affecting a child node may cause a parent node to now be disallowed.
$allow_empty
$allow_empty
$armor
Lookup array of processing that this token is exempt from.
$attr
Name of attribute to transform from
$attr
Name of boolean attribute that is trigger
$attr
Associative array of attribute name to HTMLPurifier_AttrDef
$attr
Associative array of the tag's attributes.
$attr
$attrCollections
< Instance of HTMLPurifier_ContentSets
$attrTypes
Instance of HTMLPurifier_AttrTypes
$attr_collections
$attr_collections
Associative array of attribute collection names to attribute collection additions. the global collections. the style attribute to the Core. attr_collections->info, since the object's data is only info, with extra behavior associated with it.
$attr_collections
$attr_collections
$attr_collections
$attr_collections
$attr_transform_post
Indexed list of tag's HTMLPurifier_AttrTransform to be done after validation
$attr_transform_pre
Indexed list of tag's HTMLPurifier_AttrTransform to be done before validation
add
add
Add an ID to the lookup table.
add
add
add
add
Adds a definition object to the cache
add
addAttribute
Adds a custom attribute to a pre-existing element
addBlankElement
Adds a blank element to your HTML definition, for overriding
addBlankElement
Convenience function that creates a totally blank, non-standalone element.
addDecorator
Registers a decorator to add to all new cache objects
addElement
Convenience function that sets up a new element
addElement
Adds a custom element to your HTML definition
addElementToContentSet
Convenience function that registers an element to a content set
addFilter
addFilter
HTMLPurifier::addFilter() in HTMLPurifier.php
Adds a filter to process the output.
addModule
Adds a module to the current doctype by first registering it,
addPrefix
Adds a class prefix that registerModule() will use to resolve a
AFTER_BODY
AFTER_HEAD
AFTR_FRAME
ALIST
allowsElement
Tests if the context node allows a certain element
autoload
Autoload function for HTML Purifier
autoload
HTMLPurifierExtras::autoload() in HTMLPurifierExtras.php
AttrCollections.php
AttrCollections.php in AttrCollections.php
AlphaValue.php
AlphaValue.php in AlphaValue.php
AttrDef.php
AttrDef.php in AttrDef.php
AttrTransform.php
AttrTransform.php in AttrTransform.php
AttrTypes.php
AttrTypes.php in AttrTypes.php
AttrValidator.php
AttrValidator.php in AttrValidator.php
AutoParagraph.php
AutoParagraph.php in AutoParagraph.php
b
top
$base
$base
HTMLPurifier_URI object of the base specified at %URI.
$basePathStack
$blacklist
$block
Instance of the definition object to use when block.
$browsable
$browsable
$browsable
$browsable
Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.
$browsable
$browsable
BEFOR_HEAD
BOOL
build
Builds an IDAccumulator, also initializing the default blacklist
Background.php
Background.php in Background.php
BackgroundPosition.php
BackgroundPosition.php in BackgroundPosition.php
Border.php
Border.php in Border.php
Bool.php
Bool.php in Bool.php
BdoDir.php
BdoDir.php in BdoDir.php
BgColor.php
BgColor.php in BgColor.php
BoolToCSS.php
BoolToCSS.php in BoolToCSS.php
Border.php
Border.php in Border.php
Bootstrap.php
Bootstrap.php in Bootstrap.php
Bdo.php
Bdo.php in Bdo.php
c
top
$cache
Cache object we are decorating
$cache
Cache of language code information used to load HTMLPurifier_Language objects
$caches
HTMLPurifier_DefinitionCacheFactory::$caches in DefinitionCacheFactory.php
$caseSensitive
Case sensitivity of the matching
$case_sensitive
Bool indicating whether or not enumeration is case sensitive.
$case_sensitive
$child
HTMLPurifier_ChildDef of this tag.
$code
ISO 639 language code of language.
$config
Configuration for the generator
$config
HTMLPurifier::$config in HTMLPurifier.php
Global configuration object
$config
Instance of HTMLPurifier_Config, for easy access
$config
Instances of HTMLPurifier_Config and HTMLPurifier_Context
$contentSets
$content_model
Abstract string representation of internal ChildDef rules. HTMLPurifier_ContentSets for how this is parsed and then transformed into an HTMLPurifier_ChildDef.
$content_model_type
Value of $child->type, used to determine which ChildDef to use, used in combination with $content_model.
$content_sets
$content_sets
Associative array of content set names to content set additions.
$content_sets
$content_sets
$context
$context
HTMLPurifier::$context in HTMLPurifier.php
Resultant HTMLPurifier_Context of last run purification. of contexts if the last called method was purifyArray().
$context
$css
$css
CSS declarations to add to style, needs trailing semicolon
$cssName
$currentInjector
$currentNesting
Reference to CurrentNesting variable in Context.
$currentNesting
callbackArmorCommentEntities
Callback function that entity-izes ampersands in comments so that
callbackUndoCommentSubst
Callback function for undoing escaping of stray angled brackets
CDATA
HTML5::CDATA in PH5P.php
CDATACallback
Callback function for escapeCDATA() that does the work.
CHARACTR
HTML5::CHARACTR in PH5P.php
checkDefType
Checks if a definition's type jives with the cache's type
checkNeeded
This function checks if the HTML environment will work with the Injector: if p tags are not allowed, the Auto-Paragraphing injector should not be enabled.
chmod
Chmod a file
cleanCSS
Takes CSS (the stuff found in <style>) and cleans it.
cleanup
Clears all expired (older version or revision) objects from cache
cleanup
cleanup
cleanup
cleanUTF8
Cleans a UTF-8 string for well-formedness and SGML validity It will parse according to UTF-8 and return a valid UTF8 string, with non-SGML codepoints excluded.
close
Closes file's handle
closeHandler
Close tag event handler, interface is defined by PEAR package.
COMMENT
HTML5::COMMENT in PH5P.php
compareTo
Compares two lengths, and returns 1 if greater, -1 if less and 0 if equal.
confiscateAttr
Retrieves and removes an attribute
convert
Converts a length object of one unit into another unit.
convertFromUTF8
Converts a string from UTF-8 based on configuration.
convertToASCIIDumbLossless
Lossless (character-wise) conversion of HTML to ASCII
convertToLookup
Converts a string list of elements separated by pipes into a lookup array.
convertToUTF8
Converts a string to UTF-8 based on configuration.
copy
copy
copy
Cross-compatible clone substitute
copyable
FSTools::copyable() in FSTools.php
Overloadable function that tests a filename for copyability. default, everything should be copied; you can restrict things to ignore hidden files, unreadable files, etc. applies to copyr().
copyr
FSTools::copyr() in FSTools.php
Copy a file, or recursively copy a folder and its contents; modified
create
Retrieves or sets the default Lexer as a Prototype Factory.
create
HTMLPurifier_DefinitionCacheFactory::create() in DefinitionCacheFactory.php
Factory method that creates a cache object based on configuration
create
Creates a language object, handles class fallbacks
create
Low-level factory constructor for creating new standalone element defs
createComment
Creates a HTMLPurifier_Token_Comment.
createEmpty
Creates a HTMLPurifier_Token_Empty.
createEnd
Creates a HTMLPurifier_Token_End.
createStart
Creates a HTMLPurifier_Token_Start.
createText
Creates a HTMLPurifier_Token_Text.
Color.php
Color.php in Color.php
Composite.php
Composite.php in Composite.php
CSS.php
CSS.php in CSS.php
Color.php
Color.php in Color.php
Chameleon.php
Chameleon.php in Chameleon.php
Custom.php
Custom.php in Custom.php
ChildDef.php
ChildDef.php in ChildDef.php
ContentSets.php
ContentSets.php in ContentSets.php
Context.php
Context.php in Context.php
CSSDefinition.php
CSSDefinition.php in CSSDefinition.php
Cleanup.php
Cleanup.php in Cleanup.php
CommonAttributes.php
CommonAttributes.php in CommonAttributes.php
CSSDefinition.php
CSSDefinition.php in CSSDefinition.php
Composite.php
Composite.php in Composite.php
Core.php
Core.php in Core.php
Comment.php
Comment.php in Comment.php
d
top
$data
< PCDATA tag name compatible with DTD.
$data
$decorators
$def
$def
$def
$def
Instance of HTMLPurifier_HTMLDefinition, for easy access
$default
$defaultLevel
$defaultLevel
$defaultLevel
$defaultLevel
$defaultLevel
Default level to place all fixes in.
$defaultScheme
Name of default scheme based on %URI.
$default_port
$default_port
Scheme's default port (integer)
$default_port
$default_port
$default_port
$defines_child_def
Boolean flag that indicates whether or not getChildDef is implemented.
$defines_child_def
$defines_child_def
$definitions
$defs
List of HTMLPurifier_AttrDef objects that may process strings
$descendants_are_inline
Does the element have a content model (#PCDATA | Inline)*? This is important for chameleon ins and del processing in HTMLPurifier_ChildDef_Chameleon. have to worry about this one.
$dir
HTMLPurifier_LanguageFactory::$dir in LanguageFactory.php
Cached copy of dirname(__FILE__), directory of current file without
$doctype
Doctype object
$doctype
Instance of current doctype
$doctypes
Instance of HTMLPurifier_DoctypeRegistry
$doctypes
Hash of doctype names to doctype objects
$docURL
$dtdPublic
Public DTD identifier
$dtdSystem
System DTD identifier
$dtd_regex
Allowed child pattern as defined by the DTD
dataHandler
Data event handler, interface is defined by PEAR package.
decorate
Lazy decorator function
delete
Deletes the file
destroy
Destorys a variable in the context.
DIGITAL
DOCTYPE
HTML5::DOCTYPE in PH5P.php
doSetup
doSetup
Sets up the definition object into the final form, something
doSetup
Constructs the info array.
doSetup
doSetupProprietary
doSetupTricky
DenyElementDecorator.php
DenyElementDecorator.php in DenyElementDecorator.php
Definition.php
Definition.php in Definition.php
Decorator.php
Decorator.php in Decorator.php
DefinitionCache.php
DefinitionCache.php in DefinitionCache.php
DefinitionCacheFactory.php
DefinitionCacheFactory.php in DefinitionCacheFactory.php
Doctype.php
Doctype.php in Doctype.php
DoctypeRegistry.php
DoctypeRegistry.php in DoctypeRegistry.php
DirectLex.php
DirectLex.php in DirectLex.php
DOMLex.php
DOMLex.php in DOMLex.php
DisableExternal.php
DisableExternal.php in DisableExternal.php
DisableExternalResources.php
DisableExternalResources.php in DisableExternalResources.php
e
top
$element
$elementLookup
Associative array of element name to list of modules that have definitions for the element; this array is dynamically filled.
$elements
Lookup table of allowed elements.
$elements
$elements
Lookup array of all elements that this definition could possibly allow
$elements
Informally, a list of elements this module changes. any significant way.
$elements
$embedsResource
$enumToCSS
Lookup array of attribute values to CSS
$error
True if no message file was found for this language, so English is being used instead. user that they've used a non-supported language.
$errorNames
Array of localizable error codes
$errors
$excludes
Lookup table of tags excluded from all descendants of this tag.
element
Prints a complete element with content inside
elementEmpty
emitToken
encode
Our replacement for urlencode, it encodes all non-reserved characters, as well as any extra characters that were instructed to be preserved.
end
Returns an end teg
ENDTAG
HTML5::ENDTAG in PH5P.php
END_PHASE
ENGLISH
EOF
HTML5::EOF in PH5P.php
eof
Returns TRUE if the end of the file has been reached
error
Throws an exception.
errorGeneric
Generic error for if a type didn't work.
errorInconsistent
Throws an inconsistency exception.
escape
Escapes a string for HTML output.
escape
Escapes raw text data.
escapeCDATA
Translates CDATA sections into regular sections (through escaping).
escapeCommentedCDATA
Special CDATA case that is especially convoluted for <script>
escapeHandler
Escaped text handler, interface is defined by PEAR package.
evalExpression
execute
Executes the strategy on the tokens.
execute
execute
execute
execute
execute
exists
Checks whether or not the variable exists.
exists
Returns true if file exists and is a file.
expandIdentifiers
Expands all string identifiers in an attribute array by replacing
extractBody
Takes a string of HTML (fragment or document) and returns the content
Enum.php
Enum.php in Enum.php
Email.php
Email.php in Email.php
EnumToCSS.php
EnumToCSS.php in EnumToCSS.php
Empty.php
Empty.php in Empty.php
ElementDef.php
ElementDef.php in ElementDef.php
Encoder.php
Encoder.php in Encoder.php
EntityLookup.php
EntityLookup.php in EntityLookup.php
EntityParser.php
EntityParser.php in EntityParser.php
ErrorCollector.php
ErrorCollector.php in ErrorCollector.php
Exception.php
Exception.php in Exception.php
ExtractStyleBlocks.php
ExtractStyleBlocks.php in ExtractStyleBlocks.php
Edit.php
Edit.php in Edit.php
en-x-test.php
en-x-test.php in en-x-test.php
en-x-test.php
en-x-test.php in en-x-test.php
en-x-testmini.php
en-x-testmini.php in en-x-testmini.php
en.php
en.php in en.php
Empty.php
Empty.php in Empty.php
End.php
End.php in End.php
f
top
$fake_elements
$fallback
Fallback language code
$filters
$fixesForLevel
Lists of fixes used by getFixesForLevel().
$fragment
$fs
FSTools_File::$fs in File.php
Instance of FSTools for interfacing with filesystem
File.php
File.php in File.php
FSTools.php
FSTools.php in FSTools.php
filter
filter
filter
filter
filter
filter
filter
Filter a URI object
FLOAT
flush
Clears all objects from cache
flush
flush
flush
formatMessage
Formats a localised message with passed parameters
FORMATTING
FSTools
FSTools in FSTools.php
Filesystem tools not provided by default; can recursively create, copy and delete folders.
FSTools_File
FSTools_File in File.php
Represents a file in the filesystem
Filter.php
Filter.php in Filter.php
Font.php
Font.php in Font.php
FontFamily.php
FontFamily.php in FontFamily.php
FrameTarget.php
FrameTarget.php in FrameTarget.php
Filter.php
Filter.php in Filter.php
FixNesting.php
FixNesting.php in FixNesting.php
Font.php
Font.php in Font.php
ftp.php
ftp.php in ftp.php
Flexible.php
Flexible.php in Flexible.php
form.php
form.php in form.php
g
top
$generator
$generator
Instance of HTMLPurifier_Generator for HTML generation convenience funcs
$generator
HTMLPurifier::$generator in HTMLPurifier.php
generateAttributes
Generates attribute declarations from attribute array.
generateBaseDirectoryPath
Generates path to base directory that contains all definition type
generateChildDef
Accepts a definition; generates and assigns a ChildDef for it
generateDirectoryPath
Generates the path to the directory contain this cache's serial files
generateFilePath
Generates the file path to the serial file corresponding to
generateFromToken
Generates HTML from a single token.
generateFromTokens
Generates HTML from an array of tokens.
generateKey
Generates a unique identifier for a particular configuration
generateScriptFromToken
Special case processor for the contents of script tags
get
get
get
Retrieves a type
get
get
Retrieves reference to a doctype of a certain name
get
Retrieves a definition object from the cache
get
get
Retrieves a variable reference from the context.
get
Retrieves the contents of a file
get
getAccessed
Returns a lookup array of all array indexes that have been accessed.
getAnonymousModule
Retrieves a reference to the anonymous module, so you can bust out advanced features without having to make your own module.
getChar
Retrieves a character from an open file
getChildDef
Retrieves a proper HTMLPurifier_ChildDef subclass based on content_model and content_model_type member variables of the HTMLPurifier_ElementDef class. in HTMLPurifier_HTMLDefinition.
getChildDef
getChildDef
Instantiates a ChildDef based on content_model and content_model_type
getChildDef
getClass
Retrieves the class of an object without prefixes, as well as metadata
getDirectory
Returns directory of the file without trailing slash
getDoctypeFromConfig
Retrieves the doctype from the configuration object
getElement
Retrieves a single merged element definition
getElements
Retrieves merged element definitions.
getErrorName
Retrieves a localised error name.
getFallbackFor
Returns the fallback language for language
getFixesForLevel
Retrieves all fixes per a level, returning fixes for that specific level as well as all levels below it.
getFixType
Parses a fix name and determines what kind of fix it is, as well
getHTMLFormatted
Default HTML formatting implementation for error messages
getInstance
HTMLPurifier::getInstance() in HTMLPurifier.php
getLine
Retrieves a line from an open file, with optional max length $length
getMessage
Retrieves a localised message.
getMTime
Returns last file modification time
getN
Retrieves string numeric magnitude.
getName
Returns the filename of the file.
getPath
HTMLPurifierExtras::getPath() in HTMLPurifierExtras.php
getPath
Returns the path for a specific class.
getRaw
Retrieves raw error data for custom formatter to use
getScheme
Retrieves a scheme validator object
getSchemeObj
Retrieves a scheme object corresponding to the URI's scheme/default
getSigFigs
Returns the number of significant figures in a string number.
getTypeName