LifeType 1.2.4 : Vue détaillée de locales.class.php

Classe: Locales - X-Ref

\ingroup Locale

Class that supports methods such as getAvailableLocales, addLocale
removeLocale and so on, basically to deal with locale files.

It also provides a singleton-like method called Locales::getLocale to load and cache locale
files from disk, so that we don't have to fetch the same file as many times
as we ask for it but else, we keep a cached copy of it for later use. It is advised to
use this method instead of creating a new Locale object every time we need a Locale.

Locales() X-Ref

Pas de description

getBlogLocale( $localeCode = null ) X-Ref

param: localeCode The code (eg. en_UK, es_ES) of the locale we want to get.
return: Returns a Locale object corresponding to the requested locale.

_loadPluginLocales( &$locale ) X-Ref

Pas de description

getLocale( $localeCode = null ) X-Ref

param: localeCode The code (eg. en_UK, es_ES) of the locale we want to get.
return: Returns a Locale object corresponding to the requested locale.

getPluginLocale( $pluginId, $localeCode = null ) X-Ref

loads the locale file provided by a plugin. First it will try to load the locale specified in
the $pluginId parameter and if not available, it will load the current default locale.

param: localeCode The locale code we would like to load
return: A PluginLocale object with the translated strings loaded from the plugin's own folder

getAvailableLocales() X-Ref

Returns an array with the codes of the locale files available.

return: An array containing all the locale codes available in the system.

getDefaultLocale() X-Ref

Returns default locale code

return: default locale code

isValidLocale( $localeCode ) X-Ref

Returns true if the given locale code is a valid one (i.e. if it is amongst
the available ones

param: localeCode The code of the locale we'd like to check
return: Returns 'true' if the locale file is already available in the system

isValidLocaleFileName( $fileName ) X-Ref

returns whether a file has the corect name format

param: fileName
return: true if format is correct or false otherwise

getLocales() X-Ref

Returns an array with all the locales available in the system.

This is quite memory and disk-intensive since we are loading a lot of lines
from possibly a lot of files!!!

return: Returns an array of Locale objects, which represent *all* the locales

getLocaleFilename( $localeCode ) X-Ref

Given a locale code, returns the path to the file that contains it.

param: localeCode The code representing the locale
return: A string containing the path (may be absolute or relative, it depends)

removeLocale( $localeCode ) X-Ref

Removes a locale from the system. First the file containing it is deleted
and then we also remove its entry from the configuration.

param: localeCode The code of the locale that we would like to delete.
return: Returns true if the locale was removed succesfully or false otherwise.

addLocale( $localeCode ) X-Ref

Adds a new locale to the list of available/supported locale. It checks to make
sure that the file exists and that has proper access permissions.

param: localeCode the code of the locale we'd like to add.
return: Returns true if the file was successfully added or false otherwise.

Poids:	364 lignes (14 kb)
Inclus ou requis:	0 fois
Référencé:	5 fois
Nécessite:	0 fichiers

Code source de LifeType 1.2.4

/class/locale/ -> locales.class.php (sommaire)

Définit 1 class

Généré le : Mon Nov 26 21:04:15 2007	par Balluche grâce à PHPXref 0.7