Documentation

Escaper

in package

• Application

Context specific methods for use in secure output escaping

Table of Contents

$cssMatcher  : callable

Static Matcher which escapes characters for CSS Attribute contexts

$encoding  : string

Current encoding for escaping. If not UTF-8, we convert strings from this encoding pre-escaping and back to this encoding post-escaping.

$htmlAttrMatcher  : callable

Static Matcher which escapes characters for HTML Attribute contexts

$htmlNamedEntityMap  : array<string|int, mixed>

Entity Map mapping Unicode codepoints to any available named HTML entities.

$htmlSpecialCharsFlags  : int

Holds the value of the special flags passed as second parameter to htmlspecialchars().

$jsMatcher  : callable

Static Matcher which escapes characters for Javascript contexts

$supportedEncodings  : array<string|int, mixed>

List of all encoding supported by this class

__construct()  : mixed

Constructor: Single parameter allows setting of global encoding for use by the current object.

escapeCss()  : string

Escape a string for the CSS context. CSS escaping can be applied to any string being inserted into CSS and escapes everything except alphanumerics.

escapeHtml()  : string

Escape a string for the HTML Body context where there are very few characters of special meaning. Internally this will use htmlspecialchars().

escapeHtmlAttr()  : string

Escape a string for the HTML Attribute context. We use an extended set of characters to escape that are not covered by htmlspecialchars() to cover cases where an attribute might be unquoted or quoted illegally (e.g. backticks are valid quotes for IE).

escapeJs()  : string

Escape a string for the Javascript context. This does not use json_encode(). An extended set of characters are escaped beyond ECMAScript's rules for Javascript literal string escaping in order to prevent misinterpretation of Javascript as HTML leading to the injection of special characters and entities. The escaping used should be tolerant of cases where HTML escaping was not applied on top of Javascript escaping correctly.

escapeUrl()  : string

Escape a string for the URI or Parameter contexts. This should not be used to escape an entire URI - only a subcomponent being inserted. The function is a simple proxy to rawurlencode() which now implements RFC 3986 since PHP 5.3 completely.

getEncoding()  : string

Return the encoding that all output/input is expected to be encoded in.

convertEncoding()  : string

Encoding conversion helper which wraps iconv and mbstring where they exist or throws and exception where neither is available.

cssMatcher()  : string

Callback function for preg_replace_callback that applies CSS escaping to all matches.

fromUtf8()  : string

Converts a string from UTF-8 to the base encoding. The base encoding is set via this

htmlAttrMatcher()  : string

Callback function for preg_replace_callback that applies HTML Attribute escaping to all matches.

isUtf8()  : bool

Checks if a given string appears to be valid UTF-8 or not.

jsMatcher()  : string

Callback function for preg_replace_callback that applies Javascript escaping to all matches.

toUtf8()  : string

Converts a string to UTF-8 from the base encoding. The base encoding is set via this