Zend\Escaper\Escaper
Context specific methods for use in secure output escaping
Synopsis
class Escaper
{
- // members
- protected array $htmlNamedEntityMap;
- protected string $encoding;
- protected string $htmlSpecialCharsFlags;
- protected callable $htmlAttrMatcher;
- protected callable $jsMatcher;
- protected callable $cssMatcher;
- protected array $supportedEncodings;
- // methods
- public void __construct()
- public string getEncoding()
- public string escapeHtml()
- public string escapeHtmlAttr()
- public string escapeJs()
- public string escapeUrl()
- public string escapeCss()
- protected string htmlAttrMatcher()
- protected string jsMatcher()
- protected string cssMatcher()
- protected string toUtf8()
- protected string fromUtf8()
- protected bool isUtf8()
- protected string convertEncoding()
Members
protected
- $cssMatcher
—
Zend\Escaper\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
—
Zend\Escaper\callable
Static Matcher which escapes characters for HTML Attribute contexts - $htmlNamedEntityMap
—
array
Entity Map mapping Unicode codepoints to any available named HTML entities. - $htmlSpecialCharsFlags
—
string
Holds the value of the special flags passed as second parameter to htmlspecialchars(). We modify these for PHP 5.4 to take advantage of the new ENT_SUBSTITUTE flag for correctly dealing with invalid UTF-8 sequences. - $jsMatcher
—
Zend\Escaper\callable
Static Matcher which escapes characters for Javascript contexts - $supportedEncodings
—
array
List of all encoding supported by this class
Methods
protected
- convertEncoding() — Encoding conversion helper which wraps iconv and mbstring where they exist or throws and exception where neither is available.
- cssMatcher() — Callback function for preg_replace_callback that applies CSS escaping to all matches.
- fromUtf8() — Converts a string from UTF-8 to the base encoding. The base encoding is set via this class' constructor.
- htmlAttrMatcher() — Callback function for preg_replace_callback that applies HTML Attribute escaping to all matches.
- isUtf8() — Checks if a given string appears to be valid UTF-8 or not.
- jsMatcher() — Callback function for preg_replace_callback that applies Javascript escaping to all matches.
- toUtf8() — Converts a string to UTF-8 from the base encoding. The base encoding is set via this class' constructor.
public
- __construct() — Constructor: Single parameter allows setting of global encoding for use by the current object. If PHP 5.4 is detected, additional ENT_SUBSTITUTE flag is set for htmlspecialchars() calls.
- escapeCss() — 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() — Escape a string for the HTML Body context where there are very few characters of special meaning. Internally this will use htmlspecialchars().
- escapeHtmlAttr() — 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() — 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() — 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() — Return the encoding that all output/input is expected to be encoded in.