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 LanguageHelper

Fonctions membres publiques statiques

static createLanguageList ($actualLanguage, $basePath=JPATH_BASE, $caching=false, $installed=false)
 
static detectLanguage ()
 
static getLanguages ($key='default')
 
static getInstalledLanguages ($clientId=null, $processMetaData=false, $processManifest=false, $pivot='element', $orderField=null, $orderDirection=null)
 
static getContentLanguages ($publishedStates=array(1), $checkInstalled=true, $pivot='lang_code', $orderField=null, $orderDirection=null)
 
static saveToIniFile ($filename, array $strings)
 
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)
 

Description détaillée

Language helper class

Depuis
11.1

Documentation des fonctions membres

◆ createLanguageList()

static createLanguageList (   $actualLanguage,
  $basePath = JPATH_BASE,
  $caching = false,
  $installed = false 
)
static

Builds a list of the system languages which can be used in a select option

Paramètres
string$actualLanguageClient key for the area
string$basePathBase path to use
boolean$cachingTrue if caching is used
boolean$installedGet only installed languages
Renvoie
array List of system languages
Depuis
11.1

Références $basePath, $clientId, $language, Language\$languages, $list, Language\$metadata, JPATH_ADMINISTRATOR, et null.

Référencé par LanguageHelperWrapper\createLanguageList().

◆ detectLanguage()

static detectLanguage ( )
static

Tries to detect the language.

Renvoie
string locale or null if not found
Depuis
11.1

Références elseif.

Référencé par LanguageHelperWrapper\detectLanguage(), CMSHelper\getCurrentLanguage(), et ContentHelper\getCurrentLanguage().

◆ 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
3.7.0

Références $basePath, Language\$lang, $path, et Language\$paths.

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

◆ getContentLanguages()

static getContentLanguages (   $publishedStates = array(1),
  $checkInstalled = true,
  $pivot = 'lang_code',
  $orderField = null,
  $orderDirection = null 
)
static

Get a list of content languages.

Paramètres
array$publishedStatesArray with the content language published states. Empty array for all.
boolean$checkInstalledCheck if the content language is installed.
string$pivotThe pivot of the returning array.
string$orderFieldField to order the results.
string$orderDirectionDirection to order the results.
Renvoie
array Array of the content languages.
Depuis
3.7.0

Références $db, $key, $language, Language\$languages, $query, elseif, null, ArrayHelper\pivot(), et ArrayHelper\sortObjects().

Référencé par AssociationsHelper\getAssociationHtmlList(), et AssociationsHelper\getContentLanguages().

◆ getInstalledLanguages()

static getInstalledLanguages (   $clientId = null,
  $processMetaData = false,
  $processManifest = false,
  $pivot = 'element',
  $orderField = null,
  $orderDirection = null 
)
static

Get a list of installed languages.

Paramètres
integer$clientIdThe client app id.
boolean$processMetaDataFetch Language metadata.
boolean$processManifestFetch Language manifest.
string$pivotThe pivot of the returning array.
string$orderFieldField to order the results.
string$orderDirectionDirection to order the results.
Renvoie
array Array with the installed languages.
Depuis
3.7.0

Références $clientId, $db, Language\$lang, $language, Language\$languages, $query, JPATH_ADMINISTRATOR, JPATH_SITE, null, ArrayHelper\pivot(), et ArrayHelper\sortObjects().

Référencé par ModuleHelper\isAdminMultilang().

◆ 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
3.7.0

Références $basePath.

Référencé par Language\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
3.7.0

Références $basePath, et $language.

Référencé par Language\getLanguagePath(), et Language\load().

◆ getLanguages()

static getLanguages (   $key = 'default')
static

Get available languages

Paramètres
string$keyArray key
Renvoie
array An array of published languages
Depuis
11.1

Références $db, $key, Language\$lang, Language\$languages, Language\$metadata, $query, et JPATH_BASE.

Référencé par LanguageHelperWrapper\getLanguages().

◆ 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
3.7.0

Références $file, Language\$lang, JPATH_BASE, et null.

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

◆ 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
3.7.0

Références $file, Language\$languages, et Language\$metadata.

Référencé par Language\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
3.7.0
Exceptions

Références Language\$metadata, et $path.

Référencé par LanguageAdapter\_install(), et Language\parseXMLLanguageFile().

◆ saveToIniFile()

static saveToIniFile (   $filename,
array  $strings 
)
static

Save strings to a language file.

Paramètres
string$filenameThe language ini file path.
array$stringsThe array of strings.
Renvoie
boolean True if saved, false otherwise.
Depuis
3.7.0

Références $key, Language\$strings, JPATH_LIBRARIES, et JLoader\register().


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