HTMLPurifier_URISchemeRegistry Class Reference

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

Collaboration diagram for HTMLPurifier_URISchemeRegistry:

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

Static Public Member Functions
static	instance ($prototype=null)
	Retrieve sole instance of the registry. More...

Protected Attributes
	$schemes = array()
	Cache of retrieved schemes. More...

Detailed Description

Registry for retrieving specific URI scheme validator objects.

Definition at line 6 of file URISchemeRegistry.php.

Member Function Documentation

getScheme()

HTMLPurifier_URISchemeRegistry::getScheme	(		$scheme,
			$config,
			$context
	)

Retrieves a scheme validator object.

Parameters

string	$scheme	String scheme name like http or mailto
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

HTMLPurifier_URIScheme

Definition at line 41 of file URISchemeRegistry.php.

    {
        if (!$config) {
            $config = HTMLPurifier_Config::createDefault();
        }
 
        // important, otherwise attacker could include arbitrary file
        $allowed_schemes = $config->get('URI.AllowedSchemes');
        if (!$config->get('URI.OverrideAllowedSchemes') &&
            !isset($allowed_schemes[$scheme])
        ) {
            return;
        }
 
        if (isset($this->schemes[$scheme])) {
            return $this->schemes[$scheme];
        }
        if (!isset($allowed_schemes[$scheme])) {
            return;
        }
 
        $class = 'HTMLPurifier_URIScheme_' . $scheme;
        if (!class_exists($class)) {
            return;
        }
        $this->schemes[$scheme] = new $class();
        return $this->schemes[$scheme];
    }

References HTMLPurifier_Config\createDefault().

Here is the call graph for this function:

instance()

static HTMLPurifier_URISchemeRegistry::instance (   $prototype = null )

static

Retrieve sole instance of the registry.

Parameters

HTMLPurifier_URISchemeRegistry

$prototype

Optional 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.

Definition at line 17 of file URISchemeRegistry.php.

    {
        static $instance = null;
        if ($prototype !== null) {
            $instance = $prototype;
        } elseif ($instance === null || $prototype == true) {
            $instance = new HTMLPurifier_URISchemeRegistry();
        }
        return $instance;
    }

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

Here is the caller graph for this function:

register()

HTMLPurifier_URISchemeRegistry::register	(		$scheme,
			$scheme_obj
	)

Registers a custom scheme to the cache, bypassing reflection.

Parameters

string	$scheme	Scheme name
HTMLPurifier_URIScheme	$scheme_obj

Definition at line 75 of file URISchemeRegistry.php.

    {
        $this->schemes[$scheme] = $scheme_obj;
    }

Field Documentation

$schemes

HTMLPurifier_URISchemeRegistry::$schemes = array()

protected

Cache of retrieved schemes.

@type HTMLPurifier_URIScheme[]

Definition at line 32 of file URISchemeRegistry.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/URISchemeRegistry.php