Docs For Class ResourceBundle

Description

This class provides methods for loading Translations Resources.

The file can be of two kinds.

First is PHP File formatted like this:

 &lt;?php
 // a comment
  $LANG['foo'] = 'bar';
 ...
 ?&gt;

Second one is a INI file like this:

 ; a comment
 foo = bar

To load a ResourceBunlde type something like this:

 ResourceBundle::getBundle('foo');

Method Summary

void getBundle ( $baseName, [ $locale = _ULC_], [ $directory = null])

void getFormattedString ( $key, $replacements)

void getString ( $key, [ $fallback = null])

void getTranslation ()

void load ( $baseName, [ $locale = _ULC_], [ $directory = null])

Methods

getBundle (line 75)

Fetches the Bundle with the given basename.

If none Translation File could be found with this name it returns null.

This method should be accessed static!

void getBundle ( $baseName, [ $locale = _ULC_], [ $directory = null])

getFormattedString (line 203)

TODO not implemented yet!

void getFormattedString ( $key, $replacements)

getString (line 189)

Return the Translation String with the given Key.

If this translation could not be found and

$fallback != null

this returns

$fallback

, otherwise it returns

'???' . $key . '???'

void getString ( $key, [ $fallback = null])

getTranslation (line 146)

Returns the internal translation Object.

void getTranslation ()

load (line 132)

This tries to load the Translations from the given File into the current ResourceBundle by appending them to the internal List.

void load ( $baseName, [ $locale = _ULC_], [ $directory = null])