Référence de la classe JLanguage

Graphe d'héritage de JLanguage:

Graphe de collaboration de JLanguage:

Liste de tous les membres

Fonctions membres publiques

• __construct ($lang=null)
• & getInstance ($lang)
• _ ($string, $jsSafe=false)
• transliterate ($string)
• exists ($lang, $basePath=JPATH_BASE)
• load ($extension= 'joomla', $basePath=JPATH_BASE, $lang=null, $reload=false)
• _load ($filename, $extension= 'unknown', $overwrite=true)
• get ($property, $default=null)
• _getCallerInfo ()
• getName ()
• getPaths ($extension=null)
• getPdfFontName ()
• getWinCP ()
• getBackwardLang ()
• getTag ()
• getLocale ()
• isRTL ()
• setDebug ($debug)
• getDebug ()
• getDefault ()
• setDefault ($lang)
• getOrphans ()
• getUsed ()
• hasKey ($key)
• getMetadata ($lang)
• getKnownLanguages ($basePath=JPATH_BASE)
• getLanguagePath ($basePath=JPATH_BASE, $language=null)
• setLanguage ($lang)
• _parseLanguageFiles ($dir=null)
• _parseXMLLanguageFiles ($dir=null)
• _parseXMLLanguageFile ($path)

Attributs publics

• $_debug = false
• $_default = 'en-GB'
• $_orphans = array()
• $_metadata = null
• $_lang = null
• $_paths = array()
• $_strings = null
• $_used = array()

---

Documentation des constructeurs et destructeur

JLanguage::__construct

(

$

lang = null

)

Constructor activating the default information of the language

protected

Références $lang.

---

Documentation des fonctions membres

JLanguage::_	(	$	string,
		$	jsSafe = false
	)

Translate function, mimics the php gettext (alias _) function

public

Paramètres:

string	$string	The string to translate
boolean	$jsSafe	Make the result javascript safe

Renvoie:

string The translation of the string

Depuis:

1.5

JLanguage::_getCallerInfo

(

)

Determine who called JLanguage or JText

private

Renvoie:

array Caller information

Depuis:

1.5

Références $class.

JLanguage::_load	(	$	filename,
		$	extension = 'unknown',
		$	overwrite = true
	)

Loads a language file

This method will not note the successful loading of a file - use load() instead

private

Paramètres:

string	The name of the file
string	The name of the extension

Renvoie:

boolean True if new strings have been added to the language

Voir également:

JLanguage::load()

Depuis:

1.5

Références $content, et $filename.

JLanguage::_parseLanguageFiles

(

$

dir = null

)

Searches for language directories within a certain base dir

public

Paramètres:

string

$dir

directory of files

Renvoie:

array Array holding the found languages as filename => real name pairs

Depuis:

1.5

Références $langs, $languages, $path, _parseXMLLanguageFiles(), JFolder::folders(), et jimport().

Référencé par getKnownLanguages().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JLanguage::_parseXMLLanguageFile

(

$

path

)

Parse XML file for language information

public

Paramètres:

string

$path

Path to the xml files

Renvoie:

array Array holding the found metadata as a key => value pair

Depuis:

1.5

Références $metadata, $path, et JFactory::getXMLParser().

Référencé par _parseXMLLanguageFiles(), et getMetadata().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JLanguage::_parseXMLLanguageFiles

(

$

dir = null

)

Parses XML files for language information

public

Paramètres:

string

$dir

Directory of files

Renvoie:

array Array holding the found languages as filename => metadata array

Depuis:

1.5

Références $content, $file, $lang, $languages, $metadata, _parseXMLLanguageFile(), JFolder::files(), et jimport().

Référencé par _parseLanguageFiles().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JLanguage::exists	(	$	lang,
		$	basePath = JPATH_BASE
	)

Check if a language exists

This is a simple, quick check for the directory that should contain language files for the given user.

public

Paramètres:

string	$lang	Language to check
string	$basePath	Optional path to check

Renvoie:

boolean True if the language exists

Depuis:

1.5

Références $lang, $path, JFolder::exists(), et jimport().

Référencé par JSite::initialise(), et JAdministrator::initialise().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JLanguage::get	(	$	property,
		$	default = null
	)

Get a matadata language property

public

Paramètres:

string	$property	The name of the property
mixed	$default	The default value

Renvoie:

mixed The value of the property

Depuis:

1.5

Réimplémentée à partir de JObject.

JLanguage::getBackwardLang

(

)

Getter for backward compatible language name

public

Renvoie:

string backward compatible name

Depuis:

1.5

JLanguage::getDebug

(

)

Get the Debug property

public

Renvoie:

boolean True is in debug mode

Depuis:

1.5

JLanguage::getDefault

(

)

Get the default language code

public

Renvoie:

string Language code

Depuis:

1.5

& JLanguage::getInstance

(

$

lang

)

Returns a reference to a language object

This method must be invoked as:

  $browser = &JLanguage::getInstance([$lang);

public

Paramètres:

string

$lang

The language to use.

Renvoie:

JLanguage The Language object.

Depuis:

1.5

Références $lang.

Référencé par JFactory::_createLanguage().

Voici le graphe d'appel pour cette fonction :

JLanguage::getKnownLanguages

(

$

basePath = JPATH_BASE

)

Returns a list of known languages for an area

public

Paramètres:

string

$basePath

The basepath to use

Renvoie:

array key/value pair with the language file and real name

Depuis:

1.5

Références _parseLanguageFiles(), et getLanguagePath().

Référencé par JLanguageHelper::createLanguageList(), et JLanguageHelper::detectLanguage().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JLanguage::getLanguagePath	(	$	basePath = JPATH_BASE,
		$	language = null
	)

Get the path to a language

public

Paramètres:

string	$basePath	The basepath to use
string	$language	The language tag

Renvoie:

string language related path or null

Depuis:

1.5

Référencé par InstallerModelLanguages::_loadItems(), getKnownLanguages(), JInstallation::getLocaliseAdmin(), getMetadata(), et load().

Voici le graphe d'appel pour cette fonction :

JLanguage::getLocale

(

)

Get locale property

public

Renvoie:

string The locale property

Depuis:

1.5

Références $i.

JLanguage::getMetadata

(

$

lang

)

Returns a associative array holding the metadata

public

Paramètres:

string

The name of the language

Renvoie:

mixed If $lang exists return key/value pair with the language metadata, otherwise return NULL

Depuis:

1.5

Références $file, $lang, $path, _parseXMLLanguageFile(), et getLanguagePath().

Voici le graphe d'appel pour cette fonction :

JLanguage::getName

(

)

Getter for Name

public

Renvoie:

string Official name element of the language

Depuis:

1.5

JLanguage::getOrphans

(

)

Get the list of orphaned strings if being tracked

public

Renvoie:

array Orphaned text

Depuis:

1.5

JLanguage::getPaths

(

$

extension = null

)

Get a list of language files that have been loaded

public

Paramètres:

string

$extension

An option extension name

Renvoie:

array

Depuis:

1.5

JLanguage::getPdfFontName

(

)

Getter for PDF Font Name

public

Renvoie:

string name of pdf font to be used

Depuis:

1.5

JLanguage::getTag

(

)

Get for the language tag (as defined in RFC 3066)

public

Renvoie:

string The language tag

Depuis:

1.5

JLanguage::getUsed

(

)

Get the list of used strings

Used strings are those strings requested and found either as a string or a constant

public

Renvoie:

array Used strings

Depuis:

1.5

JLanguage::getWinCP

(

)

Getter for Windows locale code page

public

Renvoie:

string windows locale encoding

Depuis:

1.5

JLanguage::hasKey

(

$

key

)

Determines is a key exists

public

Paramètres:

key

$key

The key to check

Renvoie:

boolean True, if the key exists

Depuis:

1.5

JLanguage::isRTL

(

)

Get the RTL property

public

Renvoie:

boolean True is it an RTL language

Depuis:

1.5

JLanguage::load	(	$	extension = 'joomla',
		$	basePath = JPATH_BASE,
		$	lang = null,
		$	reload = false
	)

Loads a single language file and appends the results to the existing strings

public

Paramètres:

string	$extension	The extension for which a language file should be loaded
string	$basePath	The basepath to use
string	$lang	The language to load, default null for the current language
boolean	$reload	Flag that will force a language to be reloaded if set to true

Renvoie:

boolean True, if the file has successfully loaded.

Depuis:

1.5

Références $filename, $lang, $path, et getLanguagePath().

Voici le graphe d'appel pour cette fonction :

JLanguage::setDebug

(

$

debug

)

Set the Debug property

public

Renvoie:

boolean Previous value

Depuis:

1.5

Références $debug.

JLanguage::setDefault

(

$

lang

)

Set the default language code

public

Renvoie:

string Previous value

Depuis:

1.5

Références $lang.

JLanguage::setLanguage

(

$

lang

)

Set the language attributes to the given language

Once called, the language still needs to be loaded using JLanguage::load()

public

Paramètres:

string

$lang

Language code

Renvoie:

string Previous value

Depuis:

1.5

Références $lang.

JLanguage::transliterate

(

$

string

)

Transliterate function

This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents"

public

Paramètres:

string

$string

The string to transliterate

Renvoie:

string The transliteration of the string

Depuis:

1.5

---

Documentation des données membres

JLanguage::$_debug = false

JLanguage::$_default = 'en-GB'

JLanguage::$_lang = null

JLanguage::$_metadata = null

JLanguage::$_orphans = array()

JLanguage::$_paths = array()

JLanguage::$_strings = null

JLanguage::$_used = array()

---

La documentation de cette classe a été générée à partir du fichier suivant :

• language/language.php