HTMLPurifier 4.4.0
HTMLPurifier_URISchemeRegistry Class Reference

Registry for retrieving specific URI scheme validator objects. More...

List of all members.

Public Member Functions

 getScheme ($scheme, $config, $context)
 Retrieves a scheme validator object.
 register ($scheme, $scheme_obj)
 Registers a custom scheme to the cache, bypassing reflection.
 getScheme ($scheme, $config, $context)
 Retrieves a scheme validator object.
 register ($scheme, $scheme_obj)
 Registers a custom scheme to the cache, bypassing reflection.

Static Public Member Functions

static instance ($prototype=null)
 Retrieve sole instance of the registry.
static instance ($prototype=null)
 Retrieve sole instance of the registry.

Protected Attributes

 $schemes = array()
 Cache of retrieved schemes.

Detailed Description

Registry for retrieving specific URI scheme validator objects.

Definition at line 6 of file URISchemeRegistry.php.


Member Function Documentation

HTMLPurifier_URISchemeRegistry::getScheme ( scheme,
config,
context 
)

Retrieves a scheme validator object.

Parameters:
$schemeString scheme name like http or mailto
$configHTMLPurifier_Config object
$configHTMLPurifier_Context object

Definition at line 37 of file URISchemeRegistry.php.

References $config, and HTMLPurifier_Config::createDefault().

HTMLPurifier_URISchemeRegistry::getScheme ( scheme,
config,
context 
)

Retrieves a scheme validator object.

Parameters:
$schemeString scheme name like http or mailto
$configHTMLPurifier_Config object
$configHTMLPurifier_Context object

Definition at line 7725 of file HTMLPurifier.standalone.php.

References $config, and HTMLPurifier_Config::createDefault().

static HTMLPurifier_URISchemeRegistry::instance ( prototype = null) [static]

Retrieve sole instance of the registry.

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

Definition at line 16 of file URISchemeRegistry.php.

Referenced by HTMLPurifier_URIDefinition::getDefaultScheme(), and HTMLPurifier_URI::getSchemeObj().

static HTMLPurifier_URISchemeRegistry::instance ( prototype = null) [static]

Retrieve sole instance of the registry.

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

Definition at line 7704 of file HTMLPurifier.standalone.php.

HTMLPurifier_URISchemeRegistry::register ( scheme,
scheme_obj 
)

Registers a custom scheme to the cache, bypassing reflection.

Parameters:
$schemeScheme name
$scheme_objHTMLPurifier_URIScheme object

Definition at line 62 of file URISchemeRegistry.php.

HTMLPurifier_URISchemeRegistry::register ( scheme,
scheme_obj 
)

Registers a custom scheme to the cache, bypassing reflection.

Parameters:
$schemeScheme name
$scheme_objHTMLPurifier_URIScheme object

Definition at line 7750 of file HTMLPurifier.standalone.php.


Member Data Documentation

HTMLPurifier_URISchemeRegistry::$schemes = array() [protected]

Cache of retrieved schemes.

Definition at line 29 of file URISchemeRegistry.php.


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