HTMLPurifier_URIScheme_file
extends HTMLPurifier_URIScheme
in package
Validates file as defined by RFC 1630 and RFC 1738.
Table of Contents
Properties
- $browsable : mixed
- Generally file:// URLs are not accessible from most machines, so placing them as an img src is incorrect.
- $default_port : mixed
- Scheme's default port (integer). If an explicit port number is specified that coincides with the default port, it will be elided.
- $hierarchical : mixed
- Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute
- $may_omit_host : mixed
- 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.
- $secure : mixed
- Whether or not data transmitted over this scheme is encrypted.
Methods
- doValidate() : bool
- Validates the components of a URI for a specific scheme.
- validate() : bool
- Public interface for validating components of a URI. Performs a bunch of default actions. Don't overload this method.
Properties
$browsable
Generally file:// URLs are not accessible from most machines, so placing them as an img src is incorrect.
public
mixed
$browsable
= \false
Tags
$default_port
Scheme's default port (integer). If an explicit port number is specified that coincides with the default port, it will be elided.
public
mixed
$default_port
= \null
Tags
$hierarchical
Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute
public
mixed
$hierarchical
= \false
Tags
$may_omit_host
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.
public
mixed
$may_omit_host
= \true
Tags
$secure
Whether or not data transmitted over this scheme is encrypted.
public
mixed
$secure
= \false
https is secure, http is not.
Tags
Methods
doValidate()
Validates the components of a URI for a specific scheme.
public
doValidate(HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
Parameters
- $uri : HTMLPurifier_URI
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
boolvalidate()
Public interface for validating components of a URI. Performs a bunch of default actions. Don't overload this method.
public
validate(HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
Parameters
- $uri : HTMLPurifier_URI
-
Reference to a HTMLPurifier_URI object
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
bool —success or failure