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.

Constructor & Destructor Documentation

__construct()

__construct

(

$preserve = false

)

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

Parameters

bool

$preserve

Member Function Documentation

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.

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

string

$string

String to be encoded

Returns

string Encoded string.

normalize()

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

string

$string

String to normalize

Returns

string

Field Documentation

$preserve

$preserve = array()

protected

Reserved characters to preserve when using encode(). @type array

---

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

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/PercentEncoder.php