HTMLPurifier_Language Klassenreferenz

Klassendiagramm für HTMLPurifier_Language:

Öffentliche Methoden
	__construct ($config, $context)
	load ()
	getMessage ($key)
	getErrorName ($int)
	listify ($array)
	formatMessage ($key, $args=array())

Datenfelder
	$code = 'en'
	$fallback = false
	$messages = array()
	$errorNames = array()
	$error = false
	$_loaded = false

Geschützte Attribute
	$config
	$context

Ausführliche Beschreibung

Represents a language and defines localizable string formatting and other functions, as well as the localized messages for HTML Purifier.

Definiert in Zeile 7 der Datei Language.php.

Beschreibung der Konstruktoren und Destruktoren

__construct	(		$config,
			$context
	)

Parameter

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Definiert in Zeile 63 der Datei Language.php.

Benutzt $config und $context.

Dokumentation der Elementfunktionen

formatMessage	(		$key,
			$args = array()
	)

Formats a localised message with passed parameters

Parameter

string	$key	string identifier of message
array	$args	Parameters to substitute in

Rückgabe

string localised message

Noch zu erledigen:

Implement conditionals? Right now, some messages make reference to line numbers, but those aren't always available

Definiert in Zeile 148 der Datei Language.php.

Benutzt listify() und load().

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

getErrorName

(

$int)

Retrieves a localised error name.

Parameter

int

$int

error number, corresponding to PHP's error reporting

Rückgabe

string localised message

Definiert in Zeile 107 der Datei Language.php.

Benutzt load().

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

getMessage

(

$key)

Retrieves a localised message.

Parameter

string

$key

string identifier of message

Rückgabe

string localised message

Definiert in Zeile 91 der Datei Language.php.

Benutzt load().

Wird benutzt von listify().

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

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

listify

(

$array)

Converts an array list into a string readable representation

Parameter

array

$array

Rückgabe

string

Definiert in Zeile 123 der Datei Language.php.

Benutzt getMessage().

Wird benutzt von formatMessage().

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

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

load

(

)

Loads language object with necessary info from factory cache

Zu beachten

This is a lazy loader

Definiert in Zeile 73 der Datei Language.php.

Benutzt $code und HTMLPurifier_LanguageFactory\instance().

Wird benutzt von formatMessage(), getErrorName() und getMessage().

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

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

Dokumentation der Datenelemente

$_loaded = false

Has the language object been loaded yet? bool

Noch zu erledigen:

Make it private, fix usage in HTMLPurifier_LanguageTest

Definiert in Zeile 47 der Datei Language.php.

$code = 'en'

ISO 639 language code of language. Prefers shortest possible version. string

Definiert in Zeile 14 der Datei Language.php.

Wird benutzt von load().

$config

protected

HTMLPurifier_Config

Definiert in Zeile 52 der Datei Language.php.

Wird benutzt von __construct().

$context

protected

HTMLPurifier_Context

Definiert in Zeile 57 der Datei Language.php.

Wird benutzt von __construct().

$error = false

True if no message file was found for this language, so English is being used instead. Check this if you'd like to notify the user that they've used a non-supported language. bool

Definiert in Zeile 40 der Datei Language.php.

$errorNames = array()

Array of localizable error codes. array

Definiert in Zeile 32 der Datei Language.php.

$fallback = false

Fallback language code. bool|string

Definiert in Zeile 20 der Datei Language.php.

$messages = array()

Array of localizable messages. array

Definiert in Zeile 26 der Datei Language.php.

---

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

• HTMLPurifier/Language.php