HTMLPurifier_VarParser

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

Constants

Constant	Visibility	Value
`C_STRING`	public	1
`ISTRING`	public	2
`TEXT`	public	3
`ITEXT`	public	4
`C_INT`	public	5
`C_FLOAT`	public	6
`C_BOOL`	public	7
`LOOKUP`	public	8
`ALIST`	public	9
`HASH`	public	10
`C_MIXED`	public	11

Lookup table of allowed types. Mainly for backwards compatibility, but also convenient for transforming string type names to the integer constants.

public static $types

Lookup table of types that are string, and can have aliases or allowed value lists.

public static $stringTypes

Validate a variable according to type.

final public parse(mixed $var, int $type, bool $allow_null = false): string

It may return NULL as a valid type if $allow_null is true.

Parameters:

Parameter	Type	Description
`$var`	mixed	Variable to validate
`$type`	int	Type of variable, see HTMLPurifier_VarParser->types
`$allow_null`	bool	Whether or not to permit null as a value

Return Value:

Validated and type-coerced variable

Throws:

Actually implements the parsing. Base implementation does not do anything to $var. Subclasses should overload this!

protected parseImplementation(mixed $var, int $type, bool $allow_null): string

Parameters:

Throws an exception.

protected error(mixed $msg): mixed

Parameters:

Parameter	Type	Description
`$msg`	mixed

Throws:

Throws an inconsistency exception.

protected errorInconsistent(string $class, int $type): mixed

Parameters:

Parameter	Type	Description
`$class`	string
`$type`	int

Throws:

Generic error for if a type didn't work.

protected errorGeneric(mixed $var, int $type): mixed

Parameters:

Parameter	Type	Description
`$var`	mixed
`$type`	int

public static getTypeName(int $type): string

Parameters:

Parameter	Type	Description
`$type`	int

Automatically generated on 2025-03-18