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
	doValidate (&$uri, $config, $context)

	validate (&$uri, $config, $context)

Data Fields
	$browsable = false

	$may_omit_host = true

Data Fields inherited from HTMLPurifier_URIScheme
	$default_port = null

	$browsable = false

	$secure = false

	$hierarchical = false

	$may_omit_host = false

Detailed Description

Validates file as defined by RFC 1630 and RFC 1738.

Member Function Documentation

◆ doValidate()

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

Parameters

HTMLPurifier_URI	$uri
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool

Reimplemented from HTMLPurifier_URIScheme.

Field Documentation

◆ $browsable

$browsable = false

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

◆ $may_omit_host

$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. @type bool

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

C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/URIScheme/file.php