[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/libraries/htmlpurifier/library/HTMLPurifier/ -> Config.php (summary)

(no description)

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

Defines 1 class

HTMLPurifier_Config:: (22 methods):
  __construct()
  create()
  createDefault()
  get()
  getBatch()
  getBatchSerial()
  getSerial()
  getAll()
  set()
  _listify()
  getHTMLDefinition()
  getCSSDefinition()
  getDefinition()
  loadArray()
  getAllowedDirectivesForForm()
  loadArrayFromForm()
  mergeArrayFromForm()
  prepareArrayFromForm()
  loadIni()
  isFinalized()
  autoFinalize()
  finalize()


Class: HTMLPurifier_Config  - X-Ref

Configuration object that triggers customizable behavior.

__construct($definition)   X-Ref

param: $definition HTMLPurifier_ConfigSchema that defines what directives

create($config, $schema = null)   X-Ref
Convenience constructor that creates a config object based on a mixed var

param: mixed $config Variable that defines the state of the config
param: HTMLPurifier_ConfigSchema Schema object
return: Configured HTMLPurifier_Config object

createDefault()   X-Ref
Convenience constructor that creates a default configuration object.

return: Default HTMLPurifier_Config object.

get($namespace, $key)   X-Ref
Retreives a value from the configuration.

param: $namespace String namespace
param: $key String key

getBatch($namespace)   X-Ref
Retreives an array of directives to values from a given namespace

param: $namespace String namespace

getBatchSerial($namespace)   X-Ref
Returns a md5 signature of a segment of the configuration object
that uniquely identifies that particular configuration

param: $namespace Namespace to get serial for

getSerial()   X-Ref
Returns a md5 signature for the entire configuration object
that uniquely identifies that particular configuration


getAll()   X-Ref
Retrieves all directives, organized by namespace


set($namespace, $key, $value, $from_alias = false)   X-Ref
Sets a value to configuration.

param: $namespace String namespace
param: $key String key
param: $value Mixed value

_listify($lookup)   X-Ref
Convenience function for error reporting


getHTMLDefinition($raw = false)   X-Ref
Retrieves object reference to the HTML definition.

param: $raw Return a copy that has not been setup yet. Must be

getCSSDefinition($raw = false)   X-Ref
Retrieves object reference to the CSS definition

param: $raw Return a copy that has not been setup yet. Must be

getDefinition($type, $raw = false)   X-Ref
Retrieves a definition

param: $type Type of definition: HTML, CSS, etc
param: $raw  Whether or not definition should be returned raw

loadArray($config_array)   X-Ref
Loads configuration values from an array with the following structure:
Namespace.Directive => Value

param: $config_array Configuration associative array

getAllowedDirectivesForForm($allowed, $schema = null)   X-Ref
Returns a list of array(namespace, directive) for all directives
that are allowed in a web-form context as per an allowed
namespaces/directives list.

param: $allowed List of allowed namespaces/directives

loadArrayFromForm($array, $index = false, $allowed = true, $mq_fix = true, $schema = null)   X-Ref
Loads configuration values from $_GET/$_POST that were posted
via ConfigForm

param: $array $_GET or $_POST array to import
param: $index Index/name that the config variables are in
param: $allowed List of allowed namespaces/directives
param: $mq_fix Boolean whether or not to enable magic quotes fix
param: $schema Instance of HTMLPurifier_ConfigSchema to use, if not global copy

mergeArrayFromForm($array, $index = false, $allowed = true, $mq_fix = true)   X-Ref
Merges in configuration values from $_GET/$_POST to object. NOT STATIC.


prepareArrayFromForm($array, $index = false, $allowed = true, $mq_fix = true, $schema = null)   X-Ref
Prepares an array from a form into something usable for the more
strict parts of HTMLPurifier_Config


loadIni($filename)   X-Ref
Loads configuration values from an ini file

param: $filename Name of ini file

isFinalized($error = false)   X-Ref
Checks whether or not the configuration object is finalized.

param: $error String error message, or false for no error

autoFinalize()   X-Ref
Finalizes configuration only if auto finalize is on and not
already finalized


finalize()   X-Ref
Finalizes a configuration object, prohibiting further change




Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1