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

Public Member Functions

 __construct ($preserve=false)
 encode ($string)
 normalize ($string)

Protected Attributes

 $preserve = array()

Detailed Description

Class that handles operations involving percent-encoding in URIs.

Warning:
Be careful when reusing instances of PercentEncoder. The object you use for normalize() SHOULD NOT be used for encode(), or vice-versa.

Definition at line 11 of file PercentEncoder.php.


Constructor & Destructor Documentation

__construct ( preserve = false)

String of characters that should be preserved while using encode().

Definition at line 22 of file PercentEncoder.php.


Member Function Documentation

encode ( string)

Our replacement for urlencode, it encodes all non-reserved characters, as well as any extra characters that were instructed to be preserved.

Note:
Assumes that the string has already been normalized, making any and all percent escape sequences valid. Percents will not be re-escaped, regardless of their status in $preserve
Parameters:
$stringString to be encoded
Returns:
Encoded string.

Definition at line 50 of file PercentEncoder.php.

normalize ( string)

Fix up percent-encoding by decoding unreserved characters and normalizing.

Warning:
This function is affected by $preserve, even though the usual desired behavior is for this not to preserve those characters. Be careful when reusing instances of PercentEncoder!
Parameters:
$stringString to normalize

Definition at line 69 of file PercentEncoder.php.


Field Documentation

$preserve = array() [protected]

Reserved characters to preserve when using encode().

Definition at line 17 of file PercentEncoder.php.


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