Inheritance diagram for HTMLPurifier_VarParser:

Public Member Functions
	parse ($var, $type, $allow_null=false)

Static Public Member Functions
static	getTypeName ($type)

Public Attributes
const	C_STRING = 1

const	ISTRING = 2

const	TEXT = 3

const	ITEXT = 4

const	C_INT = 5

const	C_FLOAT = 6

const	C_BOOL = 7

const	LOOKUP = 8

const	ALIST = 9

const	HASH = 10

const	C_MIXED = 11

Static Public Attributes
static	$types

static	$stringTypes

Protected Member Functions
	parseImplementation ($var, $type, $allow_null)

	error ($msg)

	errorInconsistent ($class, $type)

	errorGeneric ($var, $type)

Detailed Description

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

Definition at line 9937 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ error()

HTMLPurifier_VarParser::error ( $msg )

protected

Throws an exception.

Exceptions

HTMLPurifier_VarParserException

Definition at line 10077 of file HTMLPurifier.standalone.php.

◆ errorGeneric()

HTMLPurifier_VarParser::errorGeneric	(	$var,
		$type
	)

protected

Generic error for if a type didn't work.

Parameters

mixed	$var
int	$type

Definition at line 10104 of file HTMLPurifier.standalone.php.

◆ errorInconsistent()

HTMLPurifier_VarParser::errorInconsistent	(	$class,
		$type
	)

protected

Throws an inconsistency exception.

Note: This should not ever be called. It would be called if we extend the allowed values of HTMLPurifier_VarParser without updating subclasses.

Parameters

string	$class
int	$type

Exceptions

HTMLPurifier_Exception

Definition at line 10091 of file HTMLPurifier.standalone.php.

◆ getTypeName()

static HTMLPurifier_VarParser::getTypeName ( $type )

static

Parameters

int $type

Returns: string

Definition at line 10114 of file HTMLPurifier.standalone.php.

◆ parse()

HTMLPurifier_VarParser::parse	(	$var,
		$type,
		$allow_null = `false`
	)

final

Validate a variable according to type. It may return NULL as a valid type if $allow_null is true.

Parameters

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

Returns: string Validated and type-coerced variable

Exceptions

HTMLPurifier_VarParserException

Definition at line 9991 of file HTMLPurifier.standalone.php.

◆ parseImplementation()

HTMLPurifier_VarParser::parseImplementation	(	$var,
		$type,
		$allow_null
	)

protected

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

Parameters

mixed	$var
int	$type
bool	$allow_null

Returns: string

Reimplemented in HTMLPurifier_VarParser_Native, and HTMLPurifier_VarParser_Flexible.

Definition at line 10068 of file HTMLPurifier.standalone.php.

Member Data Documentation

◆ $stringTypes

HTMLPurifier_VarParser::$stringTypes

static

Initial value:

= array(
        self::C_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.

Definition at line 9974 of file HTMLPurifier.standalone.php.

◆ $types

HTMLPurifier_VarParser::$types

static

Initial value:

= array(
        'string' => self::C_STRING,
        'istring' => self::ISTRING,
        'text' => self::TEXT,
        'itext' => self::ITEXT,
        'int' => self::C_INT,
        'float' => self::C_FLOAT,
        'bool' => self::C_BOOL,
        'lookup' => self::LOOKUP,
        'list' => self::ALIST,
        'hash' => self::HASH,
        'mixed' => self::C_MIXED
    )