HTMLPurifier_URIScheme_file Class Reference

Validates file as defined by RFC 1630 and RFC 1738. More...

Inheritance diagram for HTMLPurifier_URIScheme_file:

Collaboration diagram for HTMLPurifier_URIScheme_file:

Public Member Functions
	doValidate (&$uri, $config, $context)
	Validates the components of a URI for a specific scheme.
Public Member Functions inherited from HTMLPurifier_URIScheme
	validate (&$uri, $config, $context)
	Public interface for validating components of a URI.

Data Fields
	$browsable = false
	$may_omit_host = true
Data Fields inherited from HTMLPurifier_URIScheme
	$default_port = null
	Scheme's default port (integer).
	$browsable = false
	Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.
	$secure = false
	Whether or not data transmitted over this scheme is encrypted.
	$hierarchical = false
	Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute.
	$may_omit_host = false
	Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

Detailed Description

Validates file as defined by RFC 1630 and RFC 1738.

Definition at line 6 of file file.php.

Member Function Documentation

HTMLPurifier_URIScheme_file::doValidate	(	&	$uri,
			$config,
			$context
	)

Validates the components of a URI for a specific scheme.

Parameters

$uri	Reference to a HTMLPurifier_URI object
$config	HTMLPurifier_Config object
$context	HTMLPurifier_Context object

Returns

Bool success or failure

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 19 of file file.php.

                                                         {
        // Authentication method is not supported
        $uri->userinfo = null;
        // file:// makes no provisions for accessing the resource
        $uri->port     = null;
        // While it seems to work on Firefox, the querystring has
        // no possible effect and is thus stripped.
        $uri->query    = null;
        return true;
    }

Field Documentation

HTMLPurifier_URIScheme_file::$browsable = false

Definition at line 10 of file file.php.

HTMLPurifier_URIScheme_file::$may_omit_host = true

Definition at line 17 of file file.php.

---

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

• Services/Html/HtmlPurifier/library/HTMLPurifier/URIScheme/file.php