Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
HTMLPurifier_URIScheme_file Class Reference
Inheritance diagram for HTMLPurifier_URIScheme_file:
HTMLPurifier_URIScheme

Public Member Functions

 doValidate (&$uri, $config, $context)
 
 validate (&$uri, $config, $context)
 Public interface for validating components of a URI.
 

Public Attributes

 $browsable = false
 Generally file:// URLs are not accessible from most machines, so placing them as an img src is incorrect.
 
 $default_port = null
 Scheme's default port (integer).
 
 $hierarchical = false
 Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute @type bool.
 
 $may_omit_host = true
 Basically the only URI scheme for which this is true, since accessing files on the local machine is very common.
 
 $secure = false
 Whether or not data transmitted over this scheme is encrypted.
 

Member Function Documentation

◆ doValidate()

HTMLPurifier_URIScheme_file::doValidate ( & $uri,
$config,
$context )
Parameters
HTMLPurifier_URI$uri
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Return values
bool

Reimplemented from HTMLPurifier_URIScheme.

◆ validate()

HTMLPurifier_URIScheme::validate ( & $uri,
$config,
$context )
inherited

Public interface for validating components of a URI.

Performs a bunch of default actions. Don't overload this method.

Parameters
HTMLPurifier_URI$uriReference to a HTMLPurifier_URI object
HTMLPurifier_Config$config
HTMLPurifier_Context$context
Return values
boolsuccess or failure

Member Data Documentation

◆ $browsable

HTMLPurifier_URIScheme_file::$browsable = false

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

@type bool

◆ $default_port

HTMLPurifier_URIScheme::$default_port = null
inherited

Scheme's default port (integer).

If an explicit port number is specified that coincides with the default port, it will be elided. @type int

◆ $may_omit_host

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

◆ $secure

HTMLPurifier_URIScheme::$secure = false
inherited

Whether or not data transmitted over this scheme is encrypted.

https is secure, http is not. @type bool


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