Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
HTMLPurifier_PercentEncoder Class Reference

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.
 

Protected Attributes

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

Constructor & Destructor Documentation

◆ __construct()

HTMLPurifier_PercentEncoder::__construct ( $preserve = false)

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

Parameters
bool$preserve

Member Function Documentation

◆ encode()

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
string$stringString to be encoded
Return values
stringEncoded string.

◆ normalize()

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
string$stringString to normalize
Return values
string

Member Data Documentation

◆ $preserve

HTMLPurifier_PercentEncoder::$preserve = array()
protected

Reserved characters to preserve when using encode().

@type array


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