SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

i18n.php

Table of Contents

Functions

_T()  : string
Traduction des textes de SPIP
_L()  : string
Remplace les variables `@...@` par leur valeur dans une chaîne de langue.
lang_select()  : string
Sélectionne la langue donnée en argument et mémorise la courante

Functions

_T()

Traduction des textes de SPIP

_T(string $texte[, array<string, scalar|Stringable> $args = [] ][, array{lang?: string, class?: string, force?: bool, sanitize?: bool} $options = [] ]) : string

Traduit une clé de traduction en l'obtenant dans les fichiers de langues.

Traduit vers la langue courante utilisée actuellement. On peut passer explicitement une langue cible dans le tableau d’option, via la clé 'lang'

Parameters
$texte : string

Clé de traduction

$args : array<string, scalar|Stringable> = []

Couples (variable => valeur) pour passer des variables à la chaîne traduite.

$options : array{lang?: string, class?: string, force?: bool, sanitize?: bool} = []
  • string lang : langue de traduction demandée (utilise la langue courante sinon)
  • string class ('') : si renseigné, encapsule chaque valeur d’argument remplacé dans un span ayant cette classe CSS
  • bool force (true) : forcer un retour meme si la chaine n'a pas de traduction
  • bool sanitize (true) : nettoyer le html suspect dans les arguments
Tags
uses
inc_traduire_dist()
uses
_L()
example 
_T('bouton_enregistrer')
_T('medias:image_tourner_droite')
_T('medias:erreurs', ['nb' => 3])
_T('email_sujet', [], ['lang' => 'en']))
_T('email_sujet', options: ['lang' => 'en']))
used-by
balise_TRAD_dist()
Return values
string —

texte

_L()

Remplace les variables `@...@` par leur valeur dans une chaîne de langue.

_L(string $text[, array<string, scalar|Stringable> $args = [] ][, array{class?: string, sanitize?: bool, debug?: bool} $options = [] ]) : string

Cette fonction est également appelée dans le code source de SPIP quand une chaîne n'est pas encore dans les fichiers de langue.

Parameters
$text : string

texte

$args : array<string, scalar|Stringable> = []

Couples (variable => valeur) à transformer dans le texte

$options : array{class?: string, sanitize?: bool, debug?: bool} = []
  • string class ('') : si renseigné, encapsule chaque valeur d’argument remplacé dans un span ayant cette classe CSS
  • bool sanitize (true) : nettoyer le html suspect dans les arguments
  • bool debug (false) : true encapsule la chaîne d’un span d’erreur
Tags
see
_T()
example 
_L('Texte avec @nb@ ...', ['nb'=>3])
used-by
_T()
Return values
string —

texte

lang_select()

Sélectionne la langue donnée en argument et mémorise la courante

lang_select([null|string $lang = null ]) : string

Restaure l'ancienne langue si appellée sans argument.

Parameters
$lang : null|string = null
  • string : Langue à appliquer,
  • null : Pour restituer la dernière langue mémorisée.
Tags
note

On pourrait économiser l'empilement en cas de non changemnt et lui faire retourner False pour prevenir l'appelant Le noyau de Spip sait le faire, mais pour assurer la compatibilité cette fonction retourne toujours non False

uses
changer_langue()
used-by
menu_lang_pour_tous()
Return values
string —
  • string Langue utilisée.

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results