Fonctions membres publiques
	__construct ($lang=null, $debug=false)

	_ ($string, $jsSafe=false, $interpretBackSlashes=true)

	transliterate ($string)

	getTransliterator ()

	setTransliterator ($function)

	getPluralSuffixes ($count)

	getPluralSuffixesCallback ()

	setPluralSuffixesCallback ($function)

	getIgnoredSearchWords ()

	getIgnoredSearchWordsCallback ()

	setIgnoredSearchWordsCallback ($function)

	getLowerLimitSearchWord ()

	getLowerLimitSearchWordCallback ()

	setLowerLimitSearchWordCallback ($function)

	getUpperLimitSearchWord ()

	getUpperLimitSearchWordCallback ()

	setUpperLimitSearchWordCallback ($function)

	getSearchDisplayedCharactersNumber ()

	getSearchDisplayedCharactersNumberCallback ()

	setSearchDisplayedCharactersNumberCallback ($function)

	load ($extension='joomla', $basePath=JPATH_BASE, $lang=null, $reload=false, $default=true)

	debugFile ($filename)

	get ($property, $default=null)

	getName ()

	getPaths ($extension=null)

	getErrorFiles ()

	getTag ()

	getCalendar ()

	isRtl ()

	setDebug ($debug)

	getDebug ()

	getDefault ()

	setDefault ($lang)

	getOrphans ()

	getUsed ()

	hasKey ($string)

	setLanguage ($lang)

	getLocale ()

	getFirstDay ()

	getWeekEnd ()

Fonctions membres publiques statiques
static	getInstance ($lang, $debug=false)

static	exists ($lang, $basePath=JPATH_BASE)

static	getMetadata ($lang)

static	getKnownLanguages ($basePath=JPATH_BASE)

static	getLanguagePath ($basePath=JPATH_BASE, $language=null)

static	parseLanguageFiles ($dir=null)

static	parseXMLLanguageFile ($path)

Fonctions membres protégées
	loadLanguage ($fileName, $extension='unknown')

	parse ($fileName)

	getCallerInfo ()

Attributs protégés
	$debug = false

	$default = 'en-GB'

	$orphans = array()

	$metadata = null

	$locale = null

	$lang = null

	$paths = array()

	$errorfiles = array()

	$strings = array()

	$used = array()

	$counter = 0

	$override = array()

	$transliterator = null

	$pluralSuffixesCallback = null

	$ignoredSearchWordsCallback = null

	$lowerLimitSearchWordCallback = null

	$upperLimitSearchWordCallback = null

	$searchDisplayedCharactersNumberCallback = null

Attributs protégés statiques
static	$languages = array()

Description détaillée

Languages/translation handler class

Depuis: 1.7.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	$lang = `null`,
		$debug = `false`
	)

Constructor activating the default information of the language.

Paramètres

string	$lang	The language
boolean	$debug	Indicates if language debugging is enabled.

Depuis: 1.7.0

Class exists. Try to find -a transliterate method, -a getPluralSuffixes method, -a getIgnoredSearchWords method -a getLowerLimitSearchWord method -a getUpperLimitSearchWord method -a getSearchDisplayCharactersNumber method

Références $class, Language\$debug, Language\$default, Language\$lang, $path, Language\$paths, LanguageHelper\getMetadata(), JPATH_ADMINISTRATOR, JPATH_BASE, JPATH_SITE, Language\load(), null, Language\parse(), et Language\setDebug().

Documentation des fonctions membres

◆ _()

_	(	$string,
		$jsSafe = `false`,
		$interpretBackSlashes = `true`
	)

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

The function checks if $jsSafe is true, then if $interpretBackslashes is true.

Paramètres

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

Renvoie: string The translation of the string

Depuis: 1.7.0

Références $key, $value, elseif, et Language\getCallerInfo().

◆ debugFile()

debugFile ( $filename )

Debugs a language file

Paramètres

string $filename Absolute path to the file to debug

Renvoie: integer A count of the number of parsing errors

Depuis: 3.6.3

Exceptions

Références Language\$debug, $file, $key, elseif, Language\getDebug(), et null.

Référencé par Language\parse().

◆ exists()

static exists	(	$lang,
		$basePath = `JPATH_BASE`
	)

static

Checks if a language exists.

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

Paramètres

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

Renvoie: boolean True if the language exists.

Depuis: 1.7.0

Obsolète:: 3.7.0, use LanguageHelper::exists() instead.

Références $basePath, Language\$lang, et LanguageHelper\exists().

◆ get()

get	(	$property,
		$default = `null`
	)

Get a metadata language property.

Paramètres

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

Renvoie: mixed The value of the property.

Depuis: 1.7.0

Références Language\$default.

◆ getCalendar()

getCalendar ( )

Getter for the calendar type

Renvoie: string The calendar type.

Depuis: 3.7.0

◆ getCallerInfo()

getCallerInfo ( )

protected

Determine who called Language or JText.

Renvoie: array Caller information.

Depuis: 1.7.0

Références $class, $info, et $step.

Référencé par Language\_().

◆ getDebug()

getDebug ( )

Get the Debug property.

Renvoie: boolean True is in debug mode.

Depuis: 1.7.0

Références Language\$debug.

Référencé par Language\debugFile().

◆ getDefault()

getDefault ( )

Get the default language code.

Renvoie: string Language code.

Depuis: 1.7.0

Références Language\$default.

◆ getErrorFiles()

getErrorFiles ( )

Get a list of language files that are in error state.

Renvoie: array

Depuis: 1.7.0

Références Language\$errorfiles.

◆ getFirstDay()

getFirstDay ( )

Get the first day of the week for this language.

Renvoie: integer The first day of the week according to the language

Depuis: 1.7.0

◆ getIgnoredSearchWords()

getIgnoredSearchWords ( )

Returns an array of ignored search words

Renvoie: array The array of ignored search words.

Depuis: 1.7.0

Références null.

◆ getIgnoredSearchWordsCallback()

getIgnoredSearchWordsCallback ( )

Getter for ignoredSearchWordsCallback function.

Renvoie: callable Function name or the actual function.

Depuis: 1.7.0

Références Language\$ignoredSearchWordsCallback.

◆ getInstance()

static getInstance	(	$lang,
		$debug = `false`
	)

static

Returns a language object.

Paramètres

string	$lang	The language to use.
boolean	$debug	The debug mode.

Renvoie: Language The Language object.

Depuis: 1.7.0

Références Language\$debug, et Language\$lang.

Référencé par Factory\createLanguage(), et OutputFilter\stringURLSafe().

◆ getKnownLanguages()

static getKnownLanguages ( $basePath = JPATH_BASE )

static

Returns a list of known languages for an area

Paramètres

string $basePath The basepath to use

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

Depuis: 1.7.0

Obsolète:: 3.7.0, use LanguageHelper::getKnownLanguages() instead.

Références $basePath, et LanguageHelper\getKnownLanguages().

◆ getLanguagePath()

static getLanguagePath	(	$basePath = `JPATH_BASE`,
		$language = `null`
	)

static

Get the path to a language

Paramètres

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

Renvoie: string language related path or null.

Depuis: 1.7.0

Obsolète:: 3.7.0, use LanguageHelper::getLanguagePath() instead.

Références $basePath, $language, et LanguageHelper\getLanguagePath().

◆ getLocale()

getLocale ( )

Get the language locale based on current language.

Renvoie: array The locale according to the language.

Depuis: 1.7.0

Références Language\$locale.

◆ getLowerLimitSearchWord()

getLowerLimitSearchWord ( )

Returns a lower limit integer for length of search words

Renvoie: integer The lower limit integer for length of search words (3 if no value was set for a specific language).

Depuis: 1.7.0

Références null.

◆ getLowerLimitSearchWordCallback()

getLowerLimitSearchWordCallback ( )

Getter for lowerLimitSearchWordCallback function

Renvoie: callable Function name or the actual function.

Depuis: 1.7.0

Références Language\$lowerLimitSearchWordCallback.

◆ getMetadata()

static getMetadata ( $lang )

static

Returns an associative array holding the metadata.

Paramètres

string $lang The name of the language.

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

Depuis: 1.7.0

Obsolète:: 3.7.0, use LanguageHelper::getMetadata() instead.

Références Language\$lang, et LanguageHelper\getMetadata().

◆ getName()

getName ( )

Getter for Name.

Renvoie: string Official name element of the language.

Depuis: 1.7.0

Référencé par JFormFieldText\setup().

◆ getOrphans()

getOrphans ( )

Get the list of orphaned strings if being tracked.

Renvoie: array Orphaned text.

Depuis: 1.7.0

Références Language\$orphans.

◆ getPaths()

getPaths ( $extension = null )

Get a list of language files that have been loaded.

Paramètres

string $extension An optional extension name.

Renvoie: array

Depuis: 1.7.0

Références $extension, et Language\$paths.

◆ getPluralSuffixes()

getPluralSuffixes ( $count )

Returns an array of suffixes for plural rules.

Paramètres

integer $count The count number the rule is for.

Renvoie: array The array of suffixes.

Depuis: 1.7.0

Références $count, et null.

◆ getPluralSuffixesCallback()

getPluralSuffixesCallback ( )

Getter for pluralSuffixesCallback function.

Renvoie: callable Function name or the actual function.

Depuis: 1.7.0

Références Language\$pluralSuffixesCallback.

◆ getSearchDisplayedCharactersNumber()

getSearchDisplayedCharactersNumber ( )

Returns the number of characters displayed in search results.

Renvoie: integer The number of characters displayed (200 if no value was set for a specific language).

Depuis: 1.7.0

Références null.

◆ getSearchDisplayedCharactersNumberCallback()

getSearchDisplayedCharactersNumberCallback ( )

Getter for searchDisplayedCharactersNumberCallback function

Renvoie: callable Function name or the actual function.

Depuis: 1.7.0

Références Language\$searchDisplayedCharactersNumberCallback.

◆ getTag()

getTag ( )

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

Renvoie: string The language tag.

Depuis: 1.7.0

◆ getTransliterator()

getTransliterator ( )

Getter for transliteration function

Renvoie: callable The transliterator function

Depuis: 1.7.0

Références Language\$transliterator.

◆ getUpperLimitSearchWord()

getUpperLimitSearchWord ( )

Returns an upper limit integer for length of search words

Renvoie: integer The upper limit integer for length of search words (200 if no value was set or if default value is < 200).

Depuis: 1.7.0

Références null.

◆ getUpperLimitSearchWordCallback()

getUpperLimitSearchWordCallback ( )

Getter for upperLimitSearchWordCallback function

Renvoie: callable Function name or the actual function.

Depuis: 1.7.0

Références Language\$upperLimitSearchWordCallback.

◆ getUsed()

getUsed ( )

Get the list of used strings.

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

Renvoie: array Used strings.

Depuis: 1.7.0

Références Language\$used.

◆ getWeekEnd()

getWeekEnd ( )

Get the weekends days for this language.

Renvoie: string The weekend days of the week separated by a comma according to the language

Depuis: 3.2

◆ hasKey()

hasKey ( $string )

Determines is a key exists.

Paramètres

string $string The key to check.

Renvoie: boolean True, if the key exists.

Depuis: 1.7.0

Références $key.

Référencé par Text\alt().

◆ isRtl()

isRtl ( )

Get the RTL property.

Renvoie: boolean True is it an RTL language.

Depuis: 1.7.0

◆ load()

load	(	$extension = `'joomla'`,
		$basePath = `JPATH_BASE`,
		$lang = `null`,
		$reload = `false`,
		$default = `true`
	)

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

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.
boolean	$default	Flag that force the default language to be loaded if the current does not exist.

Renvoie: boolean True if the file has successfully loaded.

Depuis: 1.7.0

Références $basePath, Language\$default, $extension, Language\$lang, $path, LanguageHelper\getLanguagePath(), et Language\loadLanguage().

Référencé par Language\__construct().

◆ loadLanguage()

loadLanguage	(	$fileName,
		$extension = `'unknown'`
	)

protected

Loads a language file.

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

Paramètres

string	$fileName	The name of the file.
string	$extension	The name of the extension.

Renvoie: boolean True if new strings have been added to the language

Voir également: Language::load()

Depuis: 1.7.0

Références $extension, Language\$strings, et Language\parse().

Référencé par Language\load().

◆ parse()

parse ( $fileName )

protected

Parses a language file.

Paramètres

string $fileName The name of the file.

Renvoie: array The array of parsed strings.

Depuis: 1.7.0

Références Language\$strings, et Language\debugFile().

Référencé par Language\__construct(), et Language\loadLanguage().

◆ parseLanguageFiles()

static parseLanguageFiles ( $dir = null )

static

Searches for language directories within a certain base dir.

Paramètres

string $dir directory of files.

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

Depuis: 1.7.0

Obsolète:: 3.7.0, use LanguageHelper::parseLanguageFiles() instead.

Références LanguageHelper\parseLanguageFiles().

◆ parseXMLLanguageFile()

static parseXMLLanguageFile ( $path )

static

Parse XML file for language information.

Paramètres

string $path Path to the XML files.

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

Depuis: 1.7.0

Exceptions

Références $path, et LanguageHelper\parseXMLLanguageFile().

◆ setDebug()

setDebug ( $debug )

Set the Debug property.

Paramètres

boolean $debug The debug setting.

Renvoie: boolean Previous value.

Depuis: 1.7.0

Références Language\$debug.

Référencé par Language\__construct().

◆ setDefault()

setDefault ( $lang )

Set the default language code.

Paramètres

string $lang The language code.

Renvoie: string Previous value.

Depuis: 1.7.0

Références Language\$default, et Language\$lang.

◆ setIgnoredSearchWordsCallback()

setIgnoredSearchWordsCallback ( $function )

Setter for the ignoredSearchWordsCallback function

Paramètres

callable $function Function name or actual function.

Renvoie: callable The previous function.

Depuis: 1.7.0

Références $function, et Language\$ignoredSearchWordsCallback.

◆ setLanguage()

setLanguage ( $lang )

Set the language attributes to the given language.

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

Paramètres

string $lang Language code.

Renvoie: string Previous value.

Depuis: 1.7.0

Obsolète:: 4.0 (CMS) - Instantiate a new Language object instead

Références Language\$lang, et LanguageHelper\getMetadata().

◆ setLowerLimitSearchWordCallback()

setLowerLimitSearchWordCallback ( $function )

Setter for the lowerLimitSearchWordCallback function.

Paramètres

callable $function Function name or actual function.

Renvoie: callable The previous function.

Depuis: 1.7.0

Références $function, et Language\$lowerLimitSearchWordCallback.

◆ setPluralSuffixesCallback()

setPluralSuffixesCallback ( $function )

Set the pluralSuffixes function.

Paramètres

callable $function Function name or actual function.

Renvoie: callable The previous function.

Depuis: 1.7.0

Références $function, et Language\$pluralSuffixesCallback.

◆ setSearchDisplayedCharactersNumberCallback()

setSearchDisplayedCharactersNumberCallback ( $function )

Setter for the searchDisplayedCharactersNumberCallback function.

Paramètres

callable $function Function name or the actual function.

Renvoie: callable The previous function.

Depuis: 1.7.0

Références $function, et Language\$searchDisplayedCharactersNumberCallback.

◆ setTransliterator()

setTransliterator ( $function )

Set the transliteration function.

Paramètres

callable $function Function name or the actual function.

Renvoie: callable The previous function.

Depuis: 1.7.0

Références $function, et Language\$transliterator.

◆ setUpperLimitSearchWordCallback()

setUpperLimitSearchWordCallback ( $function )

Setter for the upperLimitSearchWordCallback function

Paramètres

callable $function Function name or the actual function.

Renvoie: callable The previous function.

Depuis: 1.7.0

Références $function, et Language\$upperLimitSearchWordCallback.

◆ transliterate()

transliterate ( $string )

Transliterate function

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

Paramètres

string $string The string to transliterate.

Renvoie: string The transliteration of the string.

Depuis: 1.7.0

Références null, et Transliterate\utf8_latin_to_ascii().

Documentation des champs

◆ $counter

$counter = 0

protected

◆ $debug

$debug = false

protected

Référencé par Language\__construct(), Language\debugFile(), Language\getDebug(), Language\getInstance(), et Language\setDebug().

◆ $default

$default = 'en-GB'

protected

Référencé par Language\__construct(), Language\get(), Language\getDefault(), Language\load(), et Language\setDefault().

◆ $errorfiles

$errorfiles = array()

protected

Référencé par Language\getErrorFiles().

◆ $ignoredSearchWordsCallback

$ignoredSearchWordsCallback = null

protected

Référencé par Language\getIgnoredSearchWordsCallback(), et Language\setIgnoredSearchWordsCallback().

◆ $lang

$lang = null

protected

Référencé par Text\_(), Language\__construct(), LanguageHelper\exists(), Language\exists(), LanguageHelper\getInstalledLanguages(), Language\getInstance(), LanguageHelper\getLanguages(), LanguageHelper\getMetadata(), Language\getMetadata(), Language\load(), Text\passSprintf(), Text\plural(), Text\printf(), Language\setDefault(), Language\setLanguage(), Text\sprintf(), et Porteren\stem().

◆ $languages

$languages = array()

staticprotected

Référencé par LanguageHelper\createLanguageList(), AssociationsHelper\getAssociationHtmlList(), LanguageHelper\getContentLanguages(), LanguageHelper\getInstalledLanguages(), InstallerModelLanguages\getLanguages(), LanguageHelper\getLanguages(), et LanguageHelper\parseLanguageFiles().

◆ $locale

$locale = null

protected

Référencé par JFormFieldTimezone\getGroups(), et Language\getLocale().

◆ $lowerLimitSearchWordCallback

$lowerLimitSearchWordCallback = null

protected

Référencé par Language\getLowerLimitSearchWordCallback(), et Language\setLowerLimitSearchWordCallback().

◆ $metadata

$metadata = null

protected

Référencé par LanguageHelper\createLanguageList(), LanguageHelper\getLanguages(), LanguageHelper\parseLanguageFiles(), et LanguageHelper\parseXMLLanguageFile().

◆ $orphans

$orphans = array()

protected

Référencé par Language\getOrphans().

◆ $override

$override = array()

protected

◆ $paths

$paths = array()

protected

Référencé par Language\__construct(), LanguageHelper\exists(), et Language\getPaths().

◆ $pluralSuffixesCallback

$pluralSuffixesCallback = null

protected

Référencé par Language\getPluralSuffixesCallback(), et Language\setPluralSuffixesCallback().

◆ $searchDisplayedCharactersNumberCallback

$searchDisplayedCharactersNumberCallback = null

protected

Référencé par Language\getSearchDisplayedCharactersNumberCallback(), et Language\setSearchDisplayedCharactersNumberCallback().

◆ $strings

$strings = array()

protected

Référencé par Language\loadLanguage(), Language\parse(), et LanguageHelper\saveToIniFile().

◆ $transliterator

$transliterator = null

protected

Référencé par Language\getTransliterator(), et Language\setTransliterator().

◆ $upperLimitSearchWordCallback

$upperLimitSearchWordCallback = null

protected

Référencé par Language\getUpperLimitSearchWordCallback(), et Language\setUpperLimitSearchWordCallback().

◆ $used

$used = array()

protected

Référencé par Language\getUsed().

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

Language/Language.php

Fonctions membres publiques

Fonctions membres publiques statiques

Fonctions membres protégées

Attributs protégés

Attributs protégés statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ _()

◆ debugFile()

◆ exists()

◆ get()

◆ getCalendar()

◆ getCallerInfo()

◆ getDebug()

◆ getDefault()

◆ getErrorFiles()

◆ getFirstDay()

◆ getIgnoredSearchWords()

◆ getIgnoredSearchWordsCallback()

◆ getInstance()

◆ getKnownLanguages()

◆ getLanguagePath()

◆ getLocale()

◆ getLowerLimitSearchWord()

◆ getLowerLimitSearchWordCallback()

◆ getMetadata()

◆ getName()

◆ getOrphans()

◆ getPaths()

◆ getPluralSuffixes()

◆ getPluralSuffixesCallback()

◆ getSearchDisplayedCharactersNumber()

◆ getSearchDisplayedCharactersNumberCallback()

◆ getTag()

◆ getTransliterator()

◆ getUpperLimitSearchWord()

◆ getUpperLimitSearchWordCallback()

◆ getUsed()

◆ getWeekEnd()

◆ hasKey()

◆ isRtl()

◆ load()

◆ loadLanguage()

◆ parse()

◆ parseLanguageFiles()

◆ parseXMLLanguageFile()

◆ setDebug()

◆ setDefault()

◆ setIgnoredSearchWordsCallback()

◆ setLanguage()

◆ setLowerLimitSearchWordCallback()

◆ setPluralSuffixesCallback()

◆ setSearchDisplayedCharactersNumberCallback()

◆ setTransliterator()

◆ setUpperLimitSearchWordCallback()

◆ transliterate()

Documentation des champs

◆ $counter

◆ $debug

◆ $default

◆ $errorfiles

◆ $ignoredSearchWordsCallback

◆ $lang

◆ $languages

◆ $locale

◆ $lowerLimitSearchWordCallback

◆ $metadata

◆ $orphans

◆ $override

◆ $paths

◆ $pluralSuffixesCallback

◆ $searchDisplayedCharactersNumberCallback

◆ $strings

◆ $transliterator

◆ $upperLimitSearchWordCallback

◆ $used