Inheritance diagram for HTMLPurifier_VarParser:

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

Static Public Member Functions
static	getTypeName ($type)

Public Attributes
const	ALIST = 9

const	BOOL = 7

const	FLOAT = 6

const	HASH = 10

const	INT = 5

const	ISTRING = 2

const	ITEXT = 4

const	LOOKUP = 8

const	MIXED = 11

const	STRING = 1

const	TEXT = 3

Static Public Attributes
static	$stringTypes

static	$types

Protected Member Functions
	error ($msg)

	errorGeneric ($var, $type)

	errorInconsistent ($class, $type)

	parseImplementation ($var, $type, $allow_null)

Detailed Description

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

Definition at line 7 of file VarParser.php.

Member Function Documentation

HTMLPurifier_VarParser::error ( $msg )

protected

Throws an exception.

Definition at line 120 of file VarParser.php.

References $msg.

Referenced by errorGeneric(), and parse().

Here is the caller graph for this function:

HTMLPurifier_VarParser::errorGeneric	(	$var,
		$type
	)

protected

Generic error for if a type didn't work.

Definition at line 137 of file VarParser.php.

References $type, $var, error(), and getTypeName().

Referenced by parse(), and HTMLPurifier_VarParser_Flexible\parseImplementation().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Definition at line 130 of file VarParser.php.

References $type, and getTypeName().

Referenced by parse(), and HTMLPurifier_VarParser_Flexible\parseImplementation().

Here is the call graph for this function:

Here is the caller graph for this function:

static HTMLPurifier_VarParser::getTypeName ( $type )

static

Definition at line 142 of file VarParser.php.

References $type, and $types.

Referenced by errorGeneric(), errorInconsistent(), and HTMLPurifier_Config\set().

Here is the caller graph for this function:

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

final

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

Parameters

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

Returns: Validated and type-coerced variable

Definition at line 61 of file VarParser.php.

References $type, $types, $var, error(), errorGeneric(), errorInconsistent(), and parseImplementation().

Here is the call graph for this function:

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

protected

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

Definition at line 113 of file VarParser.php.

References $var.

Referenced by parse().

Here is the caller graph for this function:

Member Data Documentation

HTMLPurifier_VarParser::$stringTypes

static

Initial value:

= 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.

Definition at line 44 of file VarParser.php.

Referenced by HTMLPurifier_ConfigSchema_Validator\validateDirective().

HTMLPurifier_VarParser::$types

static

Initial value:

= 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
    )