A_RVP_Locale Class Reference

Inheritance diagram for A_RVP_Locale:

Static Public Member Functions
static	get_error_message ( $in_code)

Static Protected Member Functions
static	_get_default_error_message ()
static	_get_error_table ()

Detailed Description

This abstract base class is the template for localizations.

All localizations should derive from this class, presenting their localized strings in the indicated table functions.

Definition at line 44 of file common.php.

Member Function Documentation

_get_default_error_message()

static _get_default_error_message ( )

staticabstractprotected

Returns

the default (unknown) error message.

_get_error_table()

static _get_error_table ( )

staticabstractprotected

Returns

an associative array of error messages, resolved by numerical code.

get_error_message()

static get_error_message (   $in_code )

static

Returns

a string, based upon the given error code.

Parameters

$in_code

REQUIRED: The error code to translate. An integer.

Definition at line 61 of file common.php.

                                          {
        $key = "message_$in_code";
        $ret = static::_get_default_error_message();
        $table = static::_get_error_table();
        
        if (isset($table[$key]) && $table[$key]) {
            $ret = $table[$key];
        }
        
        return $ret;
    }

---

The documentation for this class was generated from the following file:

• common.php