Moodle  2.2.1
http://www.collinsharper.com
HTMLPurifier_URI Class Reference

Public Member Functions

 __construct ($scheme, $userinfo, $host, $port, $path, $query, $fragment)
 getSchemeObj ($config, $context)
 validate ($config, $context)
 toString ()

Data Fields

 $scheme
 $userinfo
 $host
 $port
 $path
 $query
 $fragment

Detailed Description

HTML Purifier's internal representation of a URI.

Note:
Internal data-structures are completely escaped. If the data needs to be used in a non-URI context (which is very unlikely), be sure to decode it first. The URI may not necessarily be well-formed until validate() is called.

Definition at line 11 of file URI.php.


Constructor & Destructor Documentation

__construct ( scheme,
userinfo,
host,
port,
path,
query,
fragment 
)
Note:
Automatically normalizes scheme and port

Definition at line 19 of file URI.php.


Member Function Documentation

getSchemeObj ( config,
context 
)

Retrieves a scheme object corresponding to the URI's scheme/default

Parameters:
$configInstance of HTMLPurifier_Config
$contextInstance of HTMLPurifier_Context
Returns:
Scheme object appropriate for validating this URI

Definition at line 35 of file URI.php.

toString ( )

Convert URI back to string

Returns:
String URI appropriate for output

Definition at line 173 of file URI.php.

validate ( config,
context 
)

Generic validation method applicable for all schemes. May modify this URI in order to get it into a compliant form.

Parameters:
$configInstance of HTMLPurifier_Config
$contextInstance of HTMLPurifier_Context
Returns:
True if validation/filtering succeeds, false if failure

Definition at line 63 of file URI.php.


Field Documentation

$fragment

Definition at line 14 of file URI.php.

$host

Definition at line 14 of file URI.php.

$path

Definition at line 14 of file URI.php.

$port

Definition at line 14 of file URI.php.

$query

Definition at line 14 of file URI.php.

$scheme

Definition at line 14 of file URI.php.

$userinfo

Definition at line 14 of file URI.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations