[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/lib/htmlpurifier/HTMLPurifier/ -> ConfigSchema.php (summary)

(no description)

File Size: 436 lines (17 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HTMLPurifier_ConfigSchema:: (10 methods):
  initialize()
  instance()
  define()
  defineNamespace()
  defineValueAliases()
  defineAllowedValues()
  defineAlias()
  validate()
  mungeFilename()
  isError()


Class: HTMLPurifier_ConfigSchema  - X-Ref

Configuration definition, defines directives and their defaults.

initialize()   X-Ref
Initializes the default namespaces.


instance($prototype = null)   X-Ref
Retrieves an instance of the application-wide configuration definition.


define($namespace, $name, $default, $type, $description)   X-Ref
Defines a directive for configuration

param: $namespace Namespace the directive is in
param: $name Key of directive
param: $default Default value of directive
param: $type Allowed type of the directive. See
param: $description Description of directive for documentation

defineNamespace($namespace, $description)   X-Ref
Defines a namespace for directives to be put into.

param: $namespace Namespace's name
param: $description Description of the namespace

defineValueAliases($namespace, $name, $aliases)   X-Ref
Defines a directive value alias.

Directive value aliases are convenient for developers because it lets
them set a directive to several values and get the same result.
param: $namespace Directive's namespace
param: $name Name of Directive
param: $alias Name of aliased value
param: $real Value aliased value will be converted into

defineAllowedValues($namespace, $name, $allowed_values)   X-Ref
Defines a set of allowed values for a directive.

param: $namespace Namespace of directive
param: $name Name of directive
param: $allowed_values Arraylist of allowed values

defineAlias($namespace, $name, $new_namespace, $new_name)   X-Ref
Defines a directive alias for backwards compatibility

param: $namespace
param: $name Directive that will be aliased
param: $new_namespace
param: $new_name Directive that the alias will be to

validate($var, $type, $allow_null = false)   X-Ref
Validate a variable according to type. Return null if invalid.


mungeFilename($filename)   X-Ref
Takes an absolute path and munges it into a more manageable relative path


isError($var)   X-Ref
Checks if var is an HTMLPurifier_Error object




Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7