Public Member Functions | |
| __construct ($config, $context) | |
| load () | |
| getMessage ($key) | |
| getErrorName ($int) | |
| listify ($array) | |
| formatMessage ($key, $args=array()) | |
Public Attributes | |
| $code = 'en' | |
| $fallback = false | |
| $messages = array() | |
| $errorNames = array() | |
| $error = false | |
| $_loaded = false | |
Protected Attributes | |
| $config | |
| $context | |
Detailed Description
Represents a language and defines localizable string formatting and other functions, as well as the localized messages for HTML Purifier.
Definition at line 7051 of file HTMLPurifier.standalone.php.
Constructor & Destructor Documentation
◆ __construct()
| HTMLPurifier_Language::__construct | ( | $config, | |
| $context | |||
| ) |
- Parameters
-
HTMLPurifier_Config $config HTMLPurifier_Context $context
Definition at line 7107 of file HTMLPurifier.standalone.php.
Member Function Documentation
◆ formatMessage()
| HTMLPurifier_Language::formatMessage | ( | $key, | |
$args = array() |
|||
| ) |
Formats a localised message with passed parameters
- Parameters
-
string $key string identifier of message array $args Parameters to substitute in
- Returns
- string localised message
Definition at line 7192 of file HTMLPurifier.standalone.php.
◆ getErrorName()
| HTMLPurifier_Language::getErrorName | ( | $int | ) |
Retrieves a localised error name.
- Parameters
-
int $int error number, corresponding to PHP's error reporting
- Returns
- string localised message
Definition at line 7151 of file HTMLPurifier.standalone.php.
◆ getMessage()
| HTMLPurifier_Language::getMessage | ( | $key | ) |
Retrieves a localised message.
- Parameters
-
string $key string identifier of message
- Returns
- string localised message
Definition at line 7135 of file HTMLPurifier.standalone.php.
◆ listify()
| HTMLPurifier_Language::listify | ( | $array | ) |
Converts an array list into a string readable representation
- Parameters
-
array $array
- Returns
- string
Definition at line 7167 of file HTMLPurifier.standalone.php.
◆ load()
| HTMLPurifier_Language::load | ( | ) |
Loads language object with necessary info from factory cache
- Note
- This is a lazy loader
Definition at line 7117 of file HTMLPurifier.standalone.php.
Member Data Documentation
◆ $_loaded
| HTMLPurifier_Language::$_loaded = false |
Has the language object been loaded yet? @type bool
Definition at line 7091 of file HTMLPurifier.standalone.php.
◆ $code
| HTMLPurifier_Language::$code = 'en' |
ISO 639 language code of language. Prefers shortest possible version. @type string
Definition at line 7058 of file HTMLPurifier.standalone.php.
◆ $config
|
protected |
@type HTMLPurifier_Config
Definition at line 7096 of file HTMLPurifier.standalone.php.
◆ $context
|
protected |
@type HTMLPurifier_Context
Definition at line 7101 of file HTMLPurifier.standalone.php.
◆ $error
| HTMLPurifier_Language::$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. @type bool
Definition at line 7084 of file HTMLPurifier.standalone.php.
◆ $errorNames
| HTMLPurifier_Language::$errorNames = array() |
Array of localizable error codes. @type array
Definition at line 7076 of file HTMLPurifier.standalone.php.
◆ $fallback
| HTMLPurifier_Language::$fallback = false |
Fallback language code. @type bool|string
Definition at line 7064 of file HTMLPurifier.standalone.php.
◆ $messages
| HTMLPurifier_Language::$messages = array() |
Array of localizable messages. @type array
Definition at line 7070 of file HTMLPurifier.standalone.php.
The documentation for this class was generated from the following file:
- plugins/htmlpurifier/HTMLPurifier.standalone.php
