Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
HTMLPurifier_URIScheme Class Reference
Inheritance diagram for HTMLPurifier_URIScheme:
HTMLPurifier_URIScheme_data HTMLPurifier_URIScheme_file HTMLPurifier_URIScheme_ftp HTMLPurifier_URIScheme_gopher HTMLPurifier_URIScheme_http HTMLPurifier_URIScheme_irc HTMLPurifier_URIScheme_mailto HTMLPurifier_URIScheme_mms HTMLPurifier_URIScheme_news HTMLPurifier_URIScheme_nntp HTMLPurifier_URIScheme_rtmp HTMLPurifier_URIScheme_rtsp HTMLPurifier_URIScheme_teamspeak HTMLPurifier_URIScheme_tel

Public Member Functions

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

Public Attributes

 $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.
 
 $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 = false
 Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.
 
 $secure = false
 Whether or not data transmitted over this scheme is encrypted.
 

Member Function Documentation

◆ doValidate()

◆ validate()

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

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::$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.

@type bool

◆ $default_port

HTMLPurifier_URIScheme::$default_port = null

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::$may_omit_host = false

Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

As of writing, 'file' is the only scheme that browsers support his properly. @type bool

◆ $secure

HTMLPurifier_URIScheme::$secure = false

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: