Docs For Class HTMLPurifier

Description

Validator for the components of a URI for a specific scheme

Direct descendents

Class	Description
HTMLPurifier_URIScheme_ftp	Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738.
HTMLPurifier_URIScheme_http	Validates http (HyperText Transfer Protocol) as defined by RFC 2616
HTMLPurifier_URIScheme_mailto	Validates mailto (for E-mail) according to RFC 2368
HTMLPurifier_URIScheme_news	Validates news (Usenet) as defined by generic RFC 1738
HTMLPurifier_URIScheme_nntp	Validates nntp (Network News Transfer Protocol) as defined by generic RFC 1738

Variable Summary

mixed $browsable

mixed $default_port

mixed $hierarchical

Method Summary

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

Variables

mixed $browsable = false (line 18)

Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.

Redefined in descendants as:

mixed $default_port = null (line 12)

Scheme's default port (integer)

Redefined in descendants as:

mixed $hierarchical = false (line 24)

Whether or not the URI always uses <hier_part>, resolves edge cases

Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute

Redefined in descendants as:

Methods

validate (line 35)

Validates the components of a URI

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

Redefined in descendants as:

Class HTMLPurifier_URIScheme