Class E

Context specific methods for use in secure output escaping

The escape is derived from code of the Zend Framework 2.1.5 - 2.2.2

Wei\Base

Extended by

Wei\E

Namespace: Wei
Link: https://github.com/zendframework/zf2/blob/master/library/Zend/Escaper/Escaper.php
Located at E.php

Methods summary
`public`	# `__construct( array $options = array() )` 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. 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. Parameters `$options` Throws InvalidArgumentException Overrides `Wei\Base::__construct()`
`public string`	# `getEncoding( )` Return the encoding that all output/input is expected to be encoded in. Return the encoding that all output/input is expected to be encoded in. Returns string
`public string`	# `html( string $string )` Escape a string for the HTML Body context where there are very few characters of special meaning. Internally this will use htmlspecialchars(). Escape a string for the HTML Body context where there are very few characters of special meaning. Internally this will use htmlspecialchars(). Parameters `$string` Returns string
`public string`	# `attr( string $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). 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). Parameters `$string` Returns string
`public string`	# `js( string $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. Backslash escaping is not used as it still leaves the escaped character as-is and so is not useful in a HTML context. 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. Backslash escaping is not used as it still leaves the escaped character as-is and so is not useful in a HTML context. Parameters `$string` Returns string
`public string`	# `url( string $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. 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. Parameters `$string` Returns string
`public string`	# `css( string $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. Escape a string for the CSS context. CSS escaping can be applied to any string being inserted into CSS and escapes everything except alphanumerics. Parameters `$string` Returns string
`protected string`	# `htmlAttrMatcher( array $matches )` Callback function for preg_replace_callback that applies HTML Attribute escaping to all matches. Callback function for preg_replace_callback that applies HTML Attribute escaping to all matches. Parameters `$matches` Returns string
`protected string`	# `jsMatcher( array $matches )` Callback function for preg_replace_callback that applies Javascript escaping to all matches. Callback function for preg_replace_callback that applies Javascript escaping to all matches. Parameters `$matches` Returns string
`protected string`	# `cssMatcher( array $matches )` Callback function for preg_replace_callback that applies CSS escaping to all matches. Callback function for preg_replace_callback that applies CSS escaping to all matches. Parameters `$matches` Returns string
`protected string`	# `toUtf8( string $string )` Converts a string to UTF-8 from the base encoding. The base encoding is set via this class' constructor. Converts a string to UTF-8 from the base encoding. The base encoding is set via this class' constructor. Parameters `$string` Returns string Throws RuntimeException
`protected string`	# `fromUtf8( string $string )` Converts a string from UTF-8 to the base encoding. The base encoding is set via this class' constructor. Converts a string from UTF-8 to the base encoding. The base encoding is set via this class' constructor. Parameters `$string` Returns string
`protected boolean`	# `isUtf8( string $string )` Checks if a given string appears to be valid UTF-8 or not. Checks if a given string appears to be valid UTF-8 or not. Parameters `$string` Returns boolean
`protected string`	# `convertEncoding( string $string, string $to, array\|string $from )` Encoding conversion helper which wraps iconv and mbstring where they exist or throws and exception where neither is available. Encoding conversion helper which wraps iconv and mbstring where they exist or throws and exception where neither is available. Parameters `$string` `$to` `$from` Returns string Throws RuntimeException
`public string`	# `__invoke( string $string, string $type = 'html' )` Escapes a string by specified type for secure output Escapes a string by specified type for secure output Parameters `$string` `$type` Returns string Throws InvalidArgumentException

Methods inherited from Wei\Base
`__call(), __get(), getOption(), setOption()`

Properties summary
`protected static array`	`$htmlNamedEntityMap` Entity Map mapping Unicode codepoints to any available named HTML entities. Entity Map mapping Unicode codepoints to any available named HTML entities. While HTML supports far more named entities, the lowest common denominator has become HTML5's XML Serialisation which is restricted to the those named entities that XML supports. Using HTML entities would result in this error: XML Parsing Error: undefined entity	# `array( 34 => 'quot', // quotation mark 38 => 'amp', // ampersand 60 => 'lt', // less-than sign 62 => 'gt', // greater-than sign )`
`protected string`	`$encoding` Current encoding for escaping. If not UTF-8, we convert strings from this encoding pre-escaping and back to this encoding post-escaping. Current encoding for escaping. If not UTF-8, we convert strings from this encoding pre-escaping and back to this encoding post-escaping.	# `'utf-8'`
`protected string`	`$htmlSpecialCharsFlags` 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. 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.	# `ENT_QUOTES`
`protected callable`	`$htmlAttrMatcher` Static Matcher which escapes characters for HTML Attribute contexts Static Matcher which escapes characters for HTML Attribute contexts	#
`protected callable`	`$jsMatcher` Static Matcher which escapes characters for Javascript contexts Static Matcher which escapes characters for Javascript contexts	#
`protected callable`	`$cssMatcher` Static Matcher which escapes characters for CSS Attribute contexts Static Matcher which escapes characters for CSS Attribute contexts	#
`protected array`	`$supportedEncodings` List of all encoding supported by this class List of all encoding supported by this class	# `array( 'iso-8859-1', 'iso8859-1', 'iso-8859-5', 'iso8859-5', 'iso-8859-15', 'iso8859-15', 'utf-8', 'cp866', 'ibm866', '866', 'cp1251', 'windows-1251', 'win-1251', '1251', 'cp1252', 'windows-1252', '1252', 'koi8-r', 'koi8-ru', 'koi8r', 'big5', '950', 'gb2312', '936', 'big5-hkscs', 'shift_jis', 'sjis', 'sjis-win', 'cp932', '932', 'euc-jp', 'eucjp', 'eucjp-win', 'macroman' )`

Properties inherited from Wei\Base
`$providers, $wei`