TBFramework - v0.4
\

\I18n

I18n permet de traduire une application à partir de données stockées dans des fichiers ini.

Si vous souhaitez utiliser le fonctionnement par défaut vous devrez :

  • déposer les fichiers ini dans le dossier définit par la variable de config "chemin_i18n".
  • nommer les fichiers selon la forme "locale.ini" (Ex.: fr.ini ou fr_CH.ini ).

Elle offre l'accès en lecture seule aux paramètres des fichiers ini. C'est une Singleton. Une seule classe de traduction peut être instanciée par Application.

Summary

Methods
Properties
Constants
get()
charger()
setLangue()
No public properties found
FORMAT_INI
No protected methods found
No protected properties found
N/A
__construct()
getValeur()
chargerFichierIni()
analyserTableauIni()
evaluerCle()
trouverLangue()
verifierCreationInstance()
ajouterErreur()
$instance
$traductions
$langue
$parametres_obligatoires
N/A

Constants

FORMAT_INI

FORMAT_INI

Format de traduction utilisant les fichier .ini

Properties

$instance

$instance

Instance de la classe pointant sur elle même (pour le pattern singleton)

$traductions

$traductions

Fichiers de traduction disponibles.

$langue

$langue

Langue courrante utilisée par l'application.

$parametres_obligatoires

$parametres_obligatoires

Tableau des noms des paramètres à définir dans le fichier de config car obligatoirement nécessaire à cette classe.

Methods

get()

get( $identifiant,  $langue) : string

Accesseur pour la valeur d'une traduction

Parameters

$identifiant
$langue

Returns

string —

la valeur du paramètre

charger()

charger( $langue,  $fichier,  $format) : boolean

Charge un fichier ini dans le tableau des paramètres de l'appli

Parameters

$langue
$fichier
$format

Returns

boolean —

true, si le fichier a été trouvé et correctement chargé, sinon false.

setLangue()

setLangue( $langue) : array

Définit la langue utiliser pour rechercher une traduction.

Parameters

$langue

Returns

array —

le fichier ini parsé

__construct()

__construct()

getValeur()

getValeur(string $param, array $i18n) : mixed

Renvoie la valeur demandé grâce une chaine de paramètres

Parameters

string $param

la chaine identifiante
array $i18n

le tableau de traductions

Returns

mixed —

la valeur correspondante à la chaine identifiante si elle est trouvée, sinon false.

chargerFichierIni()

chargerFichierIni(string $fichier_ini, string $langue) : boolean

Parse le fichier ini donné en paramètre

Parameters

string $fichier_ini

nom du fichier ini à parser
string $langue

la langue correspondant au fichier

Returns

boolean —

true si le chargement c'est bien passé, sinon false.

analyserTableauIni()

analyserTableauIni(array $i18n) : array

Analyse un tableau de traductions pour évaluer les clés.

Parameters

array $i18n

le tableau de traductions

Returns

array —

le tableau analysé et modifié si nécessaire.

evaluerCle()

evaluerCle(array $i18n, string $cle, string $valeur)

Dans le cas des chaines de traduction à sous clé (ex.: cle.souscle), cette méthode évalue les valeurs correspondantes et créée les sous tableaux associés.

Parameters

array $i18n

tableau de traductions (par référence)
string $cle

la cle dans le tableau
string $valeur

la valeur à affecter

trouverLangue()

trouverLangue()

Cherche l'information sur la langue demandée par l'application

verifierCreationInstance()

verifierCreationInstance()

Vérifie si l'instance de classe à été crée, si non la crée

ajouterErreur()

ajouterErreur( $m,  $e)

Ajouter une message d'erreur

Parameters

$m
$e