Class HTMLPurifier_VarParser

Parses string representations into their corresponding native PHP variable type. The base implementation does a simple type-check.

Direct known subclasses

HTMLPurifier_VarParser_Flexible, HTMLPurifier_VarParser_Native

Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`final public string`	# `parse( mixed $var, integer $type, boolean $allow_null = false )` Validate a variable according to type. It may return NULL as a valid type if $allow_null is true. Validate a variable according to type. It may return NULL as a valid type if $allow_null is true. Parameters `$var` `mixed` $var Variable to validate `$type` `integer` $type Type of variable, see HTMLPurifier_VarParser->types `$allow_null` `boolean` $allow_null Whether or not to permit null as a value Returns `string` Validated and type-coerced variable Throws `HTMLPurifier_VarParserException`
`protected string`	# `parseImplementation( mixed $var, integer $type, boolean $allow_null )` Actually implements the parsing. Base implementation does not do anything to $var. Subclasses should overload this! Actually implements the parsing. Base implementation does not do anything to $var. Subclasses should overload this! Parameters `$var` `mixed` $var `$type` `integer` $type `$allow_null` `boolean` $allow_null Returns `string`
`protected`	# `error( mixed $msg )` Throws an exception. Throws an exception. Throws `HTMLPurifier_VarParserException`
`protected`	# `errorInconsistent( string $class, integer $type )` Throws an inconsistency exception. Throws an inconsistency exception. Parameters `$class` `string` $class `$type` `integer` $type Throws `HTMLPurifier_Exception` Note This should not ever be called. It would be called if we extend the allowed values of HTMLPurifier_VarParser without updating subclasses.
`protected`	# `errorGeneric( mixed $var, integer $type )` Generic error for if a type didn't work. Generic error for if a type didn't work. Parameters `$var` `mixed` $var `$type` `integer` $type
`public static string`	# `getTypeName( integer $type )` Parameters `$type` `integer` $type Returns `string`

Constants summary
`integer`	`STRING`	`1`	#
`integer`	`ISTRING`	`2`	#
`integer`	`TEXT`	`3`	#
`integer`	`ITEXT`	`4`	#
`integer`	`INT`	`5`	#
`integer`	`FLOAT`	`6`	#
`integer`	`BOOL`	`7`	#
`integer`	`LOOKUP`	`8`	#
`integer`	`ALIST`	`9`	#
`integer`	`HASH`	`10`	#
`integer`	`MIXED`	`11`	#

Properties summary
`public static array`	`$types`	`array( 'string' => self::STRING, 'istring' => self::ISTRING, 'text' => self::TEXT, 'itext' => self::ITEXT, 'int' => self::INT, 'float' => self::FLOAT, 'bool' => self::BOOL, 'lookup' => self::LOOKUP, 'list' => self::ALIST, 'hash' => self::HASH, 'mixed' => self::MIXED )`	# Lookup table of allowed types. Mainly for backwards compatibility, but also convenient for transforming string type names to the integer constants. Lookup table of allowed types. Mainly for backwards compatibility, but also convenient for transforming string type names to the integer constants.
`public static array`	`$stringTypes`	`array( self::STRING => true, self::ISTRING => true, self::TEXT => true, self::ITEXT => true, )`	# Lookup table of types that are string, and can have aliases or allowed value lists. Lookup table of types that are string, and can have aliases or allowed value lists.