XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence de la classe HTMLPurifier_VarParser
+ Graphe d'héritage de HTMLPurifier_VarParser:

Fonctions membres publiques

 parse ($var, $type, $allow_null=false)
 

Fonctions membres publiques statiques

static getTypeName ($type)
 

Champs de données

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
 

Attributs publics statiques

static $types
 
static $stringTypes
 

Fonctions membres protégées

 parseImplementation ($var, $type, $allow_null)
 
 error ($msg)
 
 errorInconsistent ($class, $type)
 
 errorGeneric ($var, $type)
 

Description détaillée

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

Documentation des fonctions membres

◆ error()

error (   $msg)
protected

Throws an exception.

Exceptions
HTMLPurifier_VarParserException
+ Voici le graphe des appelants de cette fonction :

◆ errorGeneric()

errorGeneric (   $var,
  $type 
)
protected

Generic error for if a type didn't work.

Paramètres
mixed$var
int$type
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ errorInconsistent()

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.
Paramètres
string$class
int$type
Exceptions
HTMLPurifier_Exception
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ getTypeName()

static getTypeName (   $type)
static
Paramètres
int$type
Renvoie
string
+ Voici le graphe des appelants de cette fonction :

◆ parse()

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.

Paramètres
mixed$varVariable to validate
int$typeType of variable, see HTMLPurifier_VarParser->types
bool$allow_nullWhether or not to permit null as a value
Renvoie
string Validated and type-coerced variable
Exceptions
HTMLPurifier_VarParserException
+ Voici le graphe d'appel pour cette fonction :

◆ parseImplementation()

parseImplementation (   $var,
  $type,
  $allow_null 
)
protected

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

Paramètres
mixed$var
int$type
bool$allow_null
Renvoie
string

Réimplémentée dans HTMLPurifier_VarParser_Flexible, et HTMLPurifier_VarParser_Native.

+ Voici le graphe des appelants de cette fonction :

Documentation des champs

◆ $stringTypes

$stringTypes
static
Valeur initiale :
= 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.

◆ $types

$types
static
Valeur initiale :
= 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
)

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

◆ ALIST

const ALIST = 9

◆ C_BOOL

const C_BOOL = 7

◆ C_FLOAT

const C_FLOAT = 6

◆ C_INT

const C_INT = 5

◆ C_MIXED

const C_MIXED = 11

◆ C_STRING

const C_STRING = 1

◆ HASH

const HASH = 10

◆ ISTRING

const ISTRING = 2

◆ ITEXT

const ITEXT = 4

◆ LOOKUP

const LOOKUP = 8

◆ TEXT

const TEXT = 3

La documentation de cette classe a été générée à partir du fichier suivant :