API - XOOPS 2.5.11 Beta 2
By monxoops.fr
HTMLPurifier_URISchemeRegistry Class Reference

Public Member Functions

 getScheme ($scheme, $config, $context)
 
 register ($scheme, $scheme_obj)
 

Static Public Member Functions

static instance ($prototype=null)
 

Protected Attributes

 $schemes = array()
 

Detailed Description

Registry for retrieving specific URI scheme validator objects.

Member Function Documentation

◆ getScheme()

getScheme (   $scheme,
  $config,
  $context 
)

Retrieves a scheme validator object

Parameters
string$schemeString scheme name like http or mailto
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Returns
HTMLPurifier_URIScheme
Here is the call graph for this function:

◆ instance()

static instance (   $prototype = null)
static

Retrieve sole instance of the registry.

Parameters
HTMLPurifier_URISchemeRegistry$prototypeOptional prototype to overload sole instance with, or bool true to reset to default registry.
Returns
HTMLPurifier_URISchemeRegistry
Note
Pass a registry object $prototype with a compatible interface and the function will copy it and return it all further times.
Here is the caller graph for this function:

◆ register()

register (   $scheme,
  $scheme_obj 
)

Registers a custom scheme to the cache, bypassing reflection.

Parameters
string$schemeScheme name
HTMLPurifier_URIScheme$scheme_obj

Field Documentation

◆ $schemes

$schemes = array()
protected

Cache of retrieved schemes. @type HTMLPurifier_URIScheme[]


The documentation for this class was generated from the following file: