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)
Public Member Functions inherited from HTMLPurifier_URIScheme
	validate (&$uri, $config, $context)
	Public interface for validating components of a URI.

Data Fields
	$browsable = false
	Generally file:// URLs are not accessible from most machines, so placing them as an img src is incorrect.
	$may_omit_host = true
	Basically the only URI scheme for which this is true, since accessing files on the local machine is very common.
Data Fields inherited from HTMLPurifier_URIScheme
	$default_port = null
	Scheme's default port (integer).
	$browsable = false
	Whether or not URIs of this scheme 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 bool.
	$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
	)

Parameters

HTMLPurifier_URI	$uri
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool

Reimplemented from HTMLPurifier_URIScheme.

Definition at line 31 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

Generally file:// URLs are not accessible from most machines, so placing them as an img src is incorrect.

bool

Definition at line 13 of file file.php.

HTMLPurifier_URIScheme_file::$may_omit_host = true

Basically the only URI scheme for which this is true, since accessing files on the local machine is very common.

In fact, browsers on some operating systems don't understand the authority, though I hear it is used on Windows to refer to network shares. bool

Definition at line 23 of file file.php.

---

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

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