HTMLPurifier 4.4.0
|
Parses string representations into their corresponding native PHP variable type. More...
Public Member Functions | |
parse ($var, $type, $allow_null=false) | |
Validate a variable according to type. | |
parse ($var, $type, $allow_null=false) | |
Validate a variable according to type. | |
Static Public Member Functions | |
static | getTypeName ($type) |
static | getTypeName ($type) |
Public Attributes | |
const | STRING = 1 |
const | ISTRING = 2 |
const | TEXT = 3 |
const | ITEXT = 4 |
const | INT = 5 |
const | FLOAT = 6 |
const | BOOL = 7 |
const | LOOKUP = 8 |
const | ALIST = 9 |
const | HASH = 10 |
const | MIXED = 11 |
Static Public Attributes | |
static | $types |
Lookup table of allowed types. | |
static | $stringTypes |
Lookup table of types that are string, and can have aliases or allowed value lists. | |
Protected Member Functions | |
parseImplementation ($var, $type, $allow_null) | |
Actually implements the parsing. | |
error ($msg) | |
Throws an exception. | |
errorInconsistent ($class, $type) | |
Throws an inconsistency exception. | |
errorGeneric ($var, $type) | |
Generic error for if a type didn't work. | |
parseImplementation ($var, $type, $allow_null) | |
Actually implements the parsing. | |
error ($msg) | |
Throws an exception. | |
errorInconsistent ($class, $type) | |
Throws an inconsistency exception. | |
errorGeneric ($var, $type) | |
Generic error for if a type didn't work. |
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.
HTMLPurifier_VarParser::error | ( | $ | msg | ) | [protected] |
Throws an exception.
Definition at line 120 of file VarParser.php.
Referenced by errorGeneric(), and parse().
HTMLPurifier_VarParser::error | ( | $ | msg | ) | [protected] |
Throws an exception.
Definition at line 8132 of file HTMLPurifier.standalone.php.
HTMLPurifier_VarParser::errorGeneric | ( | $ | var, |
$ | type | ||
) | [protected] |
Generic error for if a type didn't work.
Definition at line 137 of file VarParser.php.
References error(), and getTypeName().
Referenced by parse(), and HTMLPurifier_VarParser_Flexible::parseImplementation().
HTMLPurifier_VarParser::errorGeneric | ( | $ | var, |
$ | type | ||
) | [protected] |
Generic error for if a type didn't work.
Definition at line 8149 of file HTMLPurifier.standalone.php.
References error(), and getTypeName().
HTMLPurifier_VarParser::errorInconsistent | ( | $ | class, |
$ | type | ||
) | [protected] |
Throws an inconsistency exception.
Definition at line 8142 of file HTMLPurifier.standalone.php.
References getTypeName().
HTMLPurifier_VarParser::errorInconsistent | ( | $ | class, |
$ | type | ||
) | [protected] |
Throws an inconsistency exception.
Definition at line 130 of file VarParser.php.
References getTypeName().
Referenced by parse(), and HTMLPurifier_VarParser_Flexible::parseImplementation().
static HTMLPurifier_VarParser::getTypeName | ( | $ | type | ) | [static] |
Definition at line 142 of file VarParser.php.
References $types.
Referenced by errorGeneric(), errorInconsistent(), and HTMLPurifier_Config::set().
static HTMLPurifier_VarParser::getTypeName | ( | $ | type | ) | [static] |
Definition at line 8154 of file HTMLPurifier.standalone.php.
References $types.
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.
$var | Variable to validate |
$type | Type of variable, see HTMLPurifier_VarParser->types |
$allow_null | Whether or not to permit null as a value |
Definition at line 61 of file VarParser.php.
References $types, error(), errorGeneric(), errorInconsistent(), and parseImplementation().
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.
$var | Variable to validate |
$type | Type of variable, see HTMLPurifier_VarParser->types |
$allow_null | Whether or not to permit null as a value |
Definition at line 8073 of file HTMLPurifier.standalone.php.
References $types, error(), errorGeneric(), errorInconsistent(), and parseImplementation().
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!
Reimplemented in HTMLPurifier_VarParser_Flexible, HTMLPurifier_VarParser_Native, HTMLPurifier_VarParser_Flexible, and HTMLPurifier_VarParser_Native.
Definition at line 8125 of file HTMLPurifier.standalone.php.
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!
Reimplemented in HTMLPurifier_VarParser_Flexible, HTMLPurifier_VarParser_Native, HTMLPurifier_VarParser_Flexible, and HTMLPurifier_VarParser_Native.
Definition at line 113 of file VarParser.php.
Referenced by parse().
static HTMLPurifier_VarParser::$stringTypes [static] |
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().
static HTMLPurifier_VarParser::$types [static] |
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.
Definition at line 26 of file VarParser.php.
Referenced by HTMLPurifier_ConfigSchema::add(), getTypeName(), parse(), and HTMLPurifier_ConfigSchema_Validator::validateDirective().
const HTMLPurifier_VarParser::ALIST = 9 |
Definition at line 18 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm_default::render().
const HTMLPurifier_VarParser::BOOL = 7 |
Definition at line 16 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm::__construct().
const HTMLPurifier_VarParser::FLOAT = 6 |
Definition at line 15 of file VarParser.php.
const HTMLPurifier_VarParser::HASH = 10 |
Definition at line 19 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm_default::render().
const HTMLPurifier_VarParser::INT = 5 |
Definition at line 14 of file VarParser.php.
const HTMLPurifier_VarParser::ISTRING = 2 |
Definition at line 11 of file VarParser.php.
const HTMLPurifier_VarParser::ITEXT = 4 |
Definition at line 13 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm_default::render().
const HTMLPurifier_VarParser::LOOKUP = 8 |
Definition at line 17 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm_default::render().
const HTMLPurifier_VarParser::MIXED = 11 |
Definition at line 20 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm_default::render().
const HTMLPurifier_VarParser::STRING = 1 |
Definition at line 10 of file VarParser.php.
const HTMLPurifier_VarParser::TEXT = 3 |
Definition at line 12 of file VarParser.php.
Referenced by HTMLPurifier_Printer_ConfigForm_default::render().