lang.php
Gestion des langues et choix de langue
Table of Contents
Functions
- changer_langue() : string|bool
- Changer la langue courante
- choisir_traduction() : mixed
- approcher_langue() : mixed
- traduire_nom_langue() : string
- Traduit un code de langue (fr, en, etc...) vers le nom de la langue en toute lettres dans cette langue (français, English, etc....).
- lang_dir() : mixed
- lang_typo() : mixed
- changer_typo() : mixed
- menu_langues() : mixed
- select_langues() : mixed
- liste_options_langues() : array<string|int, mixed>
- Lister les langues disponibles
- verifier_lang_url() : void
- Redirige sur la bonne langue lorsque l'option forcer_lang est active
- utiliser_langue_site() : string
- Utilise la langue du site
- utiliser_langue_visiteur() : string
- Initialise la langue pour un visiteur du site
- match_langue() : int
- Verifier qu'une chaine suceptible d'etre un nom de langue a le bon format
- init_langues() : void
- Initialisation des listes de langues
- html_lang_attributes() : string
- Retourne une balise <html>
- aide_lang_dir() : string
- Calcul de la direction du texte et la mise en page selon la langue
Functions
changer_langue()
Changer la langue courante
changer_langue(string $lang[, string|array<string|int, mixed> $liste_langues = null ]) : string|bool
Définit la langue utilisée par la langue désignée si elle fait partie des langues utilisables dans le site.
Cette fonction définit les globales : spip_lang, spip_lang_rtl, spip_lang_right, spip_lang_left
Parameters
- $lang : string
-
La langue à utiliser
- $liste_langues : string|array<string|int, mixed> = null
-
La liste des langues valides
Tags
Return values
string|bool —string : La langue qui a été utilisée si trouvée false : aucune langue ne correspondait à la demande
choisir_traduction()
choisir_traduction(mixed $trads[, mixed $lang = '' ]) : mixed
Parameters
- $trads : mixed
- $lang : mixed = ''
approcher_langue()
approcher_langue(mixed $trads[, mixed $lang = '' ]) : mixed
Parameters
- $trads : mixed
- $lang : mixed = ''
traduire_nom_langue()
Traduit un code de langue (fr, en, etc...) vers le nom de la langue en toute lettres dans cette langue (français, English, etc....).
traduire_nom_langue(string $lang) : string
Si le spip ne connait pas le nom de la langue, il retourne le code
Parameters
- $lang : string
-
Code de langue
Return values
string —Nom de la langue, sinon son code.
lang_dir()
lang_dir([mixed $lang = '' ][, mixed $droitier = 'ltr' ][, mixed $gaucher = 'rtl' ]) : mixed
Parameters
- $lang : mixed = ''
- $droitier : mixed = 'ltr'
- $gaucher : mixed = 'rtl'
lang_typo()
lang_typo([mixed $lang = '' ]) : mixed
Parameters
- $lang : mixed = ''
changer_typo()
changer_typo([mixed $lang = '' ]) : mixed
Parameters
- $lang : mixed = ''
menu_langues()
menu_langues(mixed $nom_select[, mixed $default = '' ]) : mixed
Parameters
- $nom_select : mixed
- $default : mixed = ''
select_langues()
select_langues(mixed $nom_select, mixed $change, mixed $options[, mixed $label = '' ]) : mixed
Parameters
- $nom_select : mixed
- $change : mixed
- $options : mixed
- $label : mixed = ''
liste_options_langues()
Lister les langues disponibles
liste_options_langues(string $nom_select) : array<string|int, mixed>
Retourne un tableau de langue utilisables, triées par code de langue, mais pas le même tableau en fonction du paramètre $nom_select.
Parameters
- $nom_select : string
-
Attribut name du select Selon son nom, retourne une liste différente :
- var_lang ou changer_lang : liste des langues sélectionnées dans la config multilinguisme
- var_lang_ecrire : toutes les langues présentes en fichier de langue
Return values
array<string|int, mixed> —Liste des langues
verifier_lang_url()
Redirige sur la bonne langue lorsque l'option forcer_lang est active
verifier_lang_url() : void
Cette fonction est appelee depuis ecrire/public.php si on a installé la variable de personnalisation $forcer_lang ; elle renvoie le brouteur si necessaire vers l'URL xxxx?lang=ll
utiliser_langue_site()
Utilise la langue du site
utiliser_langue_site([string|array<string|int, mixed>|null $liste_langues = null ]) : string
Change la langue en cours d'utilisation par la langue du site si ce n'est pas déjà le cas.
Note : Cette fonction initialise la globale spip_lang au chargement de inc/lang
Parameters
- $liste_langues : string|array<string|int, mixed>|null = null
-
liste des langues valides
Return values
string —La langue sélectionnée
utiliser_langue_visiteur()
Initialise la langue pour un visiteur du site
utiliser_langue_visiteur([string|array<string|int, mixed>|null $liste_langues = null ]) : string
La langue est choisie dans cet ordre :
- Dans le cookie 'spip_lang' ou 'spip_lang_ecrire' s'il existe (selon l'espace public ou privé).
- Sinon dans la session du visiteur.
- Sinon dans une des langues définie en préférence du navigateur
- Sinon la langue du site
Parameters
- $liste_langues : string|array<string|int, mixed>|null = null
-
liste des langues valides
Return values
string —La langue utilisée
match_langue()
Verifier qu'une chaine suceptible d'etre un nom de langue a le bon format
match_langue(string $chaine) : int
Parameters
- $chaine : string
Return values
intinit_langues()
Initialisation des listes de langues
init_langues() : void
Initialise les métas :
- langues_proposees : liste des traductions disponibles
- langue_site : langue par défaut du site
Lorsque ces métas n'existent pas encore (c'est à dire à l'installation), elles sont calculées en obtenant la liste des langues dans les fichiers de lang
html_lang_attributes()
Retourne une balise <html>
html_lang_attributes() : string
Retourne une balise HTML contenant les attributs 'lang' et 'dir' définis sur la langue en cours d'utilisation, ainsi que des classes CSS de ces du nom de la langue et direction choisie.
Tags
Return values
string —Code html de la balise
aide_lang_dir()
Calcul de la direction du texte et la mise en page selon la langue
aide_lang_dir(string $spip_lang, string $spip_lang_rtl) : string
En hébreu le ? ne doit pas être inversé.
Parameters
- $spip_lang : string
- $spip_lang_rtl : string