Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Language

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
11.1

Documentation des constructeurs et destructeur

◆ __construct()

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

Constructor activating the default information of the language.

Paramètres
string$langThe language
boolean$debugIndicates if language debugging is enabled.
Depuis
11.1

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$stringThe string to translate
boolean$jsSafeMake the result javascript safe
boolean$interpretBackSlashesInterpret and
Renvoie
string The translation of the string
Depuis
11.1

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

◆ debugFile()

debugFile (   $filename)

Debugs a language file

Paramètres
string$filenameAbsolute 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$langLanguage to check.
string$basePathOptional path to check.
Renvoie
boolean True if the language exists.
Depuis
11.1
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$propertyThe name of the property.
mixed$defaultThe default value.
Renvoie
mixed The value of the property.
Depuis
11.1

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
11.1

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
11.1

Références Language\$debug.

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

◆ getDefault()

getDefault ( )

Get the default language code.

Renvoie
string Language code.
Depuis
11.1

Références Language\$default.

◆ getErrorFiles()

getErrorFiles ( )

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

Renvoie
array
Depuis
11.1

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
11.1

◆ getIgnoredSearchWords()

getIgnoredSearchWords ( )

Returns an array of ignored search words

Renvoie
array The array of ignored search words.
Depuis
11.1

Références null.

◆ getIgnoredSearchWordsCallback()

getIgnoredSearchWordsCallback ( )

Getter for ignoredSearchWordsCallback function.

Renvoie
callable Function name or the actual function.
Depuis
11.1

Références Language\$ignoredSearchWordsCallback.

◆ getInstance()

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

Returns a language object.

Paramètres
string$langThe language to use.
boolean$debugThe debug mode.
Renvoie
Language The Language object.
Depuis
11.1

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$basePathThe basepath to use
Renvoie
array key/value pair with the language file and real name.
Depuis
11.1
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$basePathThe basepath to use.
string$languageThe language tag.
Renvoie
string language related path or null.
Depuis
11.1
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
11.1

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
11.1

Références null.

◆ getLowerLimitSearchWordCallback()

getLowerLimitSearchWordCallback ( )

Getter for lowerLimitSearchWordCallback function

Renvoie
callable Function name or the actual function.
Depuis
11.1

Références Language\$lowerLimitSearchWordCallback.

◆ getMetadata()

static getMetadata (   $lang)
static

Returns an associative array holding the metadata.

Paramètres
string$langThe name of the language.
Renvoie
mixed If $lang exists return key/value pair with the language metadata, otherwise return NULL.
Depuis
11.1
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
11.1

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

◆ getOrphans()

getOrphans ( )

Get the list of orphaned strings if being tracked.

Renvoie
array Orphaned text.
Depuis
11.1

Références Language\$orphans.

◆ getPaths()

getPaths (   $extension = null)

Get a list of language files that have been loaded.

Paramètres
string$extensionAn optional extension name.
Renvoie
array
Depuis
11.1

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

◆ getPluralSuffixes()

getPluralSuffixes (   $count)

Returns an array of suffixes for plural rules.

Paramètres
integer$countThe count number the rule is for.
Renvoie
array The array of suffixes.
Depuis
11.1

Références $count, et null.

◆ getPluralSuffixesCallback()

getPluralSuffixesCallback ( )

Getter for pluralSuffixesCallback function.

Renvoie
callable Function name or the actual function.
Depuis
11.1

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
11.1

Références null.

◆ getSearchDisplayedCharactersNumberCallback()

getSearchDisplayedCharactersNumberCallback ( )

Getter for searchDisplayedCharactersNumberCallback function

Renvoie
callable Function name or the actual function.
Depuis
11.1

Références Language\$searchDisplayedCharactersNumberCallback.

◆ getTag()

getTag ( )

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

Renvoie
string The language tag.
Depuis
11.1

◆ getTransliterator()

getTransliterator ( )

Getter for transliteration function

Renvoie
callable The transliterator function
Depuis
11.1

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
11.1

Références null.

◆ getUpperLimitSearchWordCallback()

getUpperLimitSearchWordCallback ( )

Getter for upperLimitSearchWordCallback function

Renvoie
callable Function name or the actual function.
Depuis
11.1

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
11.1

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$stringThe key to check.
Renvoie
boolean True, if the key exists.
Depuis
11.1

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
11.1

◆ 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$extensionThe extension for which a language file should be loaded.
string$basePathThe basepath to use.
string$langThe language to load, default null for the current language.
boolean$reloadFlag that will force a language to be reloaded if set to true.
boolean$defaultFlag that force the default language to be loaded if the current does not exist.
Renvoie
boolean True if the file has successfully loaded.
Depuis
11.1

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$filenameThe name of the file.
string$extensionThe name of the extension.
Renvoie
boolean True if new strings have been added to the language
Voir également
Language::load()
Depuis
11.1

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$filenameThe name of the file.
Renvoie
array The array of parsed strings.
Depuis
11.1

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

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$dirdirectory of files.
Renvoie
array Array holding the found languages as filename => real name pairs.
Depuis
11.1
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$pathPath to the XML files.
Renvoie
array Array holding the found metadata as a key => value pair.
Depuis
11.1
Exceptions

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

◆ setDebug()

setDebug (   $debug)

Set the Debug property.

Paramètres
boolean$debugThe debug setting.
Renvoie
boolean Previous value.
Depuis
11.1

Références Language\$debug.

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

◆ setDefault()

setDefault (   $lang)

Set the default language code.

Paramètres
string$langThe language code.
Renvoie
string Previous value.
Depuis
11.1

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

◆ setIgnoredSearchWordsCallback()

setIgnoredSearchWordsCallback (   $function)

Setter for the ignoredSearchWordsCallback function

Paramètres
callable$functionFunction name or actual function.
Renvoie
callable The previous function.
Depuis
11.1

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$langLanguage code.
Renvoie
string Previous value.
Depuis
11.1
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$functionFunction name or actual function.
Renvoie
callable The previous function.
Depuis
11.1

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

◆ setPluralSuffixesCallback()

setPluralSuffixesCallback (   $function)

Set the pluralSuffixes function.

Paramètres
callable$functionFunction name or actual function.
Renvoie
callable The previous function.
Depuis
11.1

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

◆ setSearchDisplayedCharactersNumberCallback()

setSearchDisplayedCharactersNumberCallback (   $function)

Setter for the searchDisplayedCharactersNumberCallback function.

Paramètres
callable$functionFunction name or the actual function.
Renvoie
callable The previous function.
Depuis
11.1

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

◆ setTransliterator()

setTransliterator (   $function)

Set the transliteration function.

Paramètres
callable$functionFunction name or the actual function.
Renvoie
callable The previous function.
Depuis
11.1

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

◆ setUpperLimitSearchWordCallback()

setUpperLimitSearchWordCallback (   $function)

Setter for the upperLimitSearchWordCallback function

Paramètres
callable$functionFunction name or the actual function.
Renvoie
callable The previous function.
Depuis
11.1

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$stringThe string to transliterate.
Renvoie
string The transliteration of the string.
Depuis
11.1

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

Documentation des champs

◆ $counter

$counter = 0
protected

◆ $debug

◆ $default

◆ $errorfiles

$errorfiles = array()
protected

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

◆ $ignoredSearchWordsCallback

$ignoredSearchWordsCallback = null
protected

◆ $lang

◆ $languages

◆ $locale

$locale = null
protected

◆ $lowerLimitSearchWordCallback

$lowerLimitSearchWordCallback = null
protected

◆ $metadata

◆ $orphans

$orphans = array()
protected

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

◆ $override

$override = array()
protected

◆ $paths

$paths = array()
protected

◆ $pluralSuffixesCallback

$pluralSuffixesCallback = null
protected

◆ $searchDisplayedCharactersNumberCallback

$searchDisplayedCharactersNumberCallback = null
protected

◆ $strings

◆ $transliterator

$transliterator = null
protected

◆ $upperLimitSearchWordCallback

$upperLimitSearchWordCallback = null
protected

◆ $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 :