Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
HTMLPurifier_URIScheme_gopher Class Reference

Validates Gopher defined by RFC 4266. More...

Inheritance diagram for HTMLPurifier_URIScheme_gopher:
HTMLPurifier_URIScheme

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 = true
 
 $default_port = null
 Scheme's default port (integer).
 
 $hierarchical = true
 
 $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.
 

Detailed Description

Validates Gopher defined by RFC 4266.

Member Function Documentation

◆ doValidate()

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

Validates the components of a URI for a specific scheme.

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

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

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

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