HTMLPurifier_VarParser Klassenreferenz

Klassendiagramm für HTMLPurifier_VarParser:

Öffentliche Methoden

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

Öffentliche, statische Methoden

static getTypeName ($type)
 

Datenfelder

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
 

Statische öffentliche Attribute

static $types
 
static $stringTypes
 

Geschützte Methoden

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

Ausführliche Beschreibung

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

Definiert in Zeile 7 der Datei VarParser.php.

Dokumentation der Elementfunktionen

error (   $msg)
protected

Throws an exception.

Ausnahmebehandlung
HTMLPurifier_VarParserException

Definiert in Zeile 147 der Datei VarParser.php.

Wird benutzt von errorGeneric() und parse().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

errorGeneric (   $var,
  $type 
)
protected

Generic error for if a type didn't work.

Parameter
mixed$var
int$type

Definiert in Zeile 174 der Datei VarParser.php.

Benutzt error() und getTypeName().

Wird benutzt von parse() und HTMLPurifier_VarParser_Flexible\parseImplementation().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

errorInconsistent (   $class,
  $type 
)
protected

Throws an inconsistency exception.

Zu beachten
This should not ever be called. It would be called if we extend the allowed values of HTMLPurifier_VarParser without updating subclasses.
Parameter
string$class
int$type
Ausnahmebehandlung
HTMLPurifier_Exception

Definiert in Zeile 161 der Datei VarParser.php.

Benutzt getTypeName().

Wird benutzt von parse() und HTMLPurifier_VarParser_Flexible\parseImplementation().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

static getTypeName (   $type)
static
Parameter
int$type
Rückgabe
string

Definiert in Zeile 184 der Datei VarParser.php.

Benutzt $types.

Wird benutzt von errorGeneric(), errorInconsistent() und HTMLPurifier_Config\set().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

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.

Parameter
mixed$varVariable to validate
int$typeType of variable, see HTMLPurifier_VarParser->types
bool$allow_nullWhether or not to permit null as a value
Rückgabe
string Validated and type-coerced variable
Ausnahmebehandlung
HTMLPurifier_VarParserException

Definiert in Zeile 61 der Datei VarParser.php.

Benutzt $types, error(), errorGeneric(), errorInconsistent() und parseImplementation().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

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

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

Parameter
mixed$var
int$type
bool$allow_null
Rückgabe
string

Definiert in Zeile 138 der Datei VarParser.php.

Wird benutzt von parse().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Dokumentation der Datenelemente

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

Definiert in Zeile 44 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_ConfigSchema_Validator\validateDirective().

$types
static
Initialisierung:
= 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.

Definiert in Zeile 26 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_ConfigSchema\add(), getTypeName(), parse() und HTMLPurifier_ConfigSchema_Validator\validateDirective().

const ALIST = 9

Definiert in Zeile 18 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm_default\render().

const BOOL = 7

Definiert in Zeile 16 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm\__construct().

const FLOAT = 6

Definiert in Zeile 15 der Datei VarParser.php.

const HASH = 10

Definiert in Zeile 19 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm_default\render().

const INT = 5

Definiert in Zeile 14 der Datei VarParser.php.

const ISTRING = 2

Definiert in Zeile 11 der Datei VarParser.php.

const ITEXT = 4

Definiert in Zeile 13 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm_default\render().

const LOOKUP = 8

Definiert in Zeile 17 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm_default\render().

const MIXED = 11

Definiert in Zeile 20 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm_default\render().

const STRING = 1

Definiert in Zeile 10 der Datei VarParser.php.

const TEXT = 3

Definiert in Zeile 12 der Datei VarParser.php.

Wird benutzt von HTMLPurifier_Printer_ConfigForm_default\render().


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:




Korrekturen, Hinweise und Ergänzungen

Bitte scheuen Sie sich nicht und melden Sie, was auf dieser Seite sachlich falsch oder irreführend ist, was ergänzt werden sollte, was fehlt usw. Dazu bitte oben aus dem Menü Seite den Eintrag Support Forum wählen. Es ist eine kostenlose Anmeldung erforderlich, um Anmerkungen zu posten. Unpassende Postings, Spam usw. werden kommentarlos entfernt.