HTMLPurifier 4.4.0
Public Member Functions | Protected Attributes
HTMLPurifier_PercentEncoder Class Reference

Class that handles operations involving percent-encoding in URIs. More...

List of all members.

Public Member Functions

 __construct ($preserve=false)
 String of characters that should be preserved while using encode().
 encode ($string)
 Our replacement for urlencode, it encodes all non-reserved characters, as well as any extra characters that were instructed to be preserved.
 normalize ($string)
 Fix up percent-encoding by decoding unreserved characters and normalizing.
 __construct ($preserve=false)
 String of characters that should be preserved while using encode().
 encode ($string)
 Our replacement for urlencode, it encodes all non-reserved characters, as well as any extra characters that were instructed to be preserved.
 normalize ($string)
 Fix up percent-encoding by decoding unreserved characters and normalizing.

Protected Attributes

 $preserve = array()
 Reserved characters to preserve when using encode().

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

HTMLPurifier_PercentEncoder::__construct ( $  preserve = false)

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

Definition at line 22 of file PercentEncoder.php.

References $preserve.

HTMLPurifier_PercentEncoder::__construct ( $  preserve = false)

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

Definition at line 6542 of file HTMLPurifier.standalone.php.

References $preserve.

Member Function Documentation

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

HTMLPurifier_PercentEncoder::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 6570 of file HTMLPurifier.standalone.php.

HTMLPurifier_PercentEncoder::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 6589 of file HTMLPurifier.standalone.php.

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

Member Data Documentation

HTMLPurifier_PercentEncoder::$preserve = array() [protected]

Reserved characters to preserve when using encode().

Definition at line 17 of file PercentEncoder.php.

Referenced by __construct().

The documentation for this class was generated from the following files: