| 183 |
jpm |
1 |
<?php
|
|
|
2 |
// declare(encoding='UTF-8');
|
|
|
3 |
/**
|
|
|
4 |
* I18n permet de traduire une application à partir de données stockées dans des fichiers ini.
|
|
|
5 |
* Si vous souhaitez utiliser le fonctionnement par défaut vous devrez :
|
|
|
6 |
* - déposer les fichiers ini dans le dossier définit par la variable de config "chemin_i18n".
|
|
|
7 |
* - nommer les fichiers selon la forme "locale.ini" (Ex.: fr.ini ou fr_CH.ini ).
|
|
|
8 |
*
|
| 226 |
jpm |
9 |
* Elle offre l'accès en lecture seule aux paramètres des fichiers ini.
|
| 183 |
jpm |
10 |
* C'est une Singleton. Une seule classe de traduction peut être instanciée par Application.
|
|
|
11 |
*
|
| 226 |
jpm |
12 |
* @category PHP 5.2
|
|
|
13 |
* @package Framework
|
|
|
14 |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
|
|
|
15 |
* @copyright 2010 Tela-Botanica
|
|
|
16 |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
|
|
|
17 |
* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
|
|
|
18 |
* @version $Id$
|
|
|
19 |
* @link /doc/framework/
|
| 183 |
jpm |
20 |
*/
|
|
|
21 |
|
|
|
22 |
class I18n {
|
|
|
23 |
/** Format de traduction utilisant les fichier .ini */
|
|
|
24 |
const FORMAT_INI = '.ini';
|
|
|
25 |
|
|
|
26 |
/** Instance de la classe pointant sur elle même (pour le pattern singleton) */
|
|
|
27 |
private static $instance = null;
|
|
|
28 |
|
|
|
29 |
/** Fichiers de traduction disponibles. */
|
|
|
30 |
private static $traductions = array();
|
|
|
31 |
|
|
|
32 |
/** Langue courrante utilisée par l'application. */
|
|
|
33 |
private static $langue = null;
|
|
|
34 |
|
|
|
35 |
private function __construct() {
|
|
|
36 |
self::verifierParametresConfig();
|
|
|
37 |
self::trouverLangue();
|
|
|
38 |
}
|
|
|
39 |
|
|
|
40 |
/**
|
|
|
41 |
* Accesseur pour la valeur d'une traduction
|
|
|
42 |
* @param string $param le nom du paramètre
|
|
|
43 |
* @return string la valeur du paramètre
|
|
|
44 |
*/
|
|
|
45 |
public static function get($identifiant, $langue = null) {
|
|
|
46 |
self::verifierCreationInstance();
|
|
|
47 |
$texte = '';
|
|
|
48 |
|
|
|
49 |
// Récupération de la langue actuellement demandée
|
|
|
50 |
$langue_a_charger = self::$langue;
|
|
|
51 |
if (!is_null($langue)) {
|
|
|
52 |
$langue_a_charger = $langue;
|
|
|
53 |
}
|
|
|
54 |
|
|
|
55 |
if (!isset(self::$traductions[$langue_a_charger])) {
|
|
|
56 |
// Tentative de chargement du fichier de traduction
|
|
|
57 |
$chargement = self::charger($langue_a_charger);
|
|
|
58 |
if ($chargement === false) {
|
|
|
59 |
$m = "Le fichier d'i18n pour la langue '$langue_a_charger' demandée n'a pas été trouvé.";
|
|
|
60 |
self::ajouterErreur($m);
|
|
|
61 |
}
|
|
|
62 |
}
|
|
|
63 |
|
|
|
64 |
// Recherche de la langue dans le tableau des traductions
|
|
|
65 |
if (isset(self::$traductions[$langue_a_charger]) && self::$traductions[$langue_a_charger] !== false) {
|
|
|
66 |
// Recherche de la traduction demandée
|
|
|
67 |
$valeur = self::getValeur($identifiant, self::$traductions[$langue_a_charger]);
|
|
|
68 |
if ($valeur !== false) {
|
|
|
69 |
$texte = $valeur;
|
|
|
70 |
} else {
|
|
|
71 |
$m = "Le traduction n'existe pas pour l'identifiant '$identifiant' demandé.";
|
|
|
72 |
self::ajouterErreur($m);
|
|
|
73 |
}
|
|
|
74 |
}
|
|
|
75 |
|
|
|
76 |
return $texte;
|
|
|
77 |
}
|
|
|
78 |
|
|
|
79 |
/**
|
|
|
80 |
* Charge un fichier ini dans le tableau des paramètres de l'appli
|
|
|
81 |
* @param string $fichier_ini le nom du fichier à charger
|
|
|
82 |
* @return boolean true, si le fichier a été trouvé et correctement chargé, sinon false.
|
|
|
83 |
*/
|
|
|
84 |
public static function charger($langue, $fichier = null, $format = self::FORMAT_INI) {
|
|
|
85 |
self::verifierCreationInstance();
|
|
|
86 |
$ok = false;
|
|
|
87 |
|
|
|
88 |
// Création du chemin vers le fichier de traduction par défaut
|
|
|
89 |
if (is_null($fichier)) {
|
|
|
90 |
$fichier = Config::get('chemin_i18n').$langue.$format;
|
|
|
91 |
}
|
|
|
92 |
|
|
|
93 |
// Chargement
|
|
|
94 |
if ($format == self::FORMAT_INI) {
|
|
|
95 |
$ok = self::chargerFichierIni($fichier, $langue);
|
|
|
96 |
} else {
|
|
|
97 |
$m = "Le format '$format' de fichier de traduction n'est pas pris en compte par le Framework.";
|
|
|
98 |
self::ajouterErreur($m);
|
|
|
99 |
}
|
|
|
100 |
|
|
|
101 |
return $ok;
|
|
|
102 |
}
|
|
|
103 |
|
|
|
104 |
/**
|
|
|
105 |
* Définit la langue utiliser pour rechercher une traduction.
|
|
|
106 |
* @param string $fichier_ini le nom du fichier à charger
|
|
|
107 |
* @return array le fichier ini parsé
|
|
|
108 |
*/
|
|
|
109 |
public static function setLangue($langue) {
|
|
|
110 |
self::verifierCreationInstance();
|
|
|
111 |
self::$langue = $langue;
|
|
|
112 |
}
|
|
|
113 |
|
|
|
114 |
/**
|
|
|
115 |
* Renvoie la valeur demandé grâce une chaine de paramètres
|
|
|
116 |
* @param string $param la chaine identifiante
|
|
|
117 |
* @param array $i18n le tableau de traductions
|
|
|
118 |
* @return mixed la valeur correspondante à la chaine identifiante si elle est trouvée, sinon false.
|
|
|
119 |
*/
|
|
|
120 |
private static function getValeur($param, $i18n) {
|
|
|
121 |
if ($param === null) {
|
|
|
122 |
return false;
|
|
|
123 |
} else {
|
|
|
124 |
if (isset($i18n[$param])) {
|
|
|
125 |
return $i18n[$param];
|
|
|
126 |
} else if (strpos($param, '.') !== false) {
|
|
|
127 |
$pieces = explode('.', $param, 2);
|
|
|
128 |
if (strlen($pieces[0]) && strlen($pieces[1])) {
|
|
|
129 |
if (isset($i18n[$pieces[0]])) {
|
|
|
130 |
if (is_array($i18n[$pieces[0]])) {
|
|
|
131 |
return self::getValeur($pieces[1], $i18n[$pieces[0]]);
|
|
|
132 |
}
|
|
|
133 |
}
|
|
|
134 |
}
|
|
|
135 |
} else {
|
|
|
136 |
return false;
|
|
|
137 |
}
|
|
|
138 |
}
|
|
|
139 |
}
|
|
|
140 |
|
|
|
141 |
/**
|
|
|
142 |
* Parse le fichier ini donné en paramètre
|
|
|
143 |
* @param string $fichier_ini nom du fichier ini à parser
|
|
|
144 |
* @param string $langue la langue correspondant au fichier
|
|
|
145 |
* @return boolean true si le chargement c'est bien passé, sinon false.
|
|
|
146 |
*/
|
|
|
147 |
private static function chargerFichierIni($fichier_ini, $langue) {
|
|
|
148 |
self::$traductions[$langue] = false;
|
|
|
149 |
if (file_exists($fichier_ini)) {
|
| 186 |
jpm |
150 |
$ini = parse_ini_file($fichier_ini, true);
|
|
|
151 |
$ini = self::analyserTableauIni($ini);
|
|
|
152 |
self::$traductions[$langue] = $ini;
|
| 183 |
jpm |
153 |
}
|
|
|
154 |
return (self::$traductions[$langue] === false) ? false : true;
|
|
|
155 |
}
|
|
|
156 |
|
|
|
157 |
/**
|
| 186 |
jpm |
158 |
* Analyse un tableau de traductions pour évaluer les clés.
|
|
|
159 |
* @param array $i18n le tableau de traductions
|
|
|
160 |
* @return array le tableau analysé et modifié si nécessaire.
|
|
|
161 |
*/
|
|
|
162 |
private static function analyserTableauIni($i18n = array()) {
|
|
|
163 |
//ATTENTION : il est important de passer la valeur par référence car nous la modifions dynamiquement dans la boucle
|
|
|
164 |
foreach ($i18n as $cle => &$valeur) {
|
|
|
165 |
if (is_array($valeur)) {
|
|
|
166 |
$i18n[$cle] = self::analyserTableauIni($valeur);
|
|
|
167 |
} else {
|
|
|
168 |
$i18n = self::evaluerCle($i18n, $cle, $valeur);
|
|
|
169 |
}
|
|
|
170 |
}
|
|
|
171 |
return $i18n;
|
|
|
172 |
}
|
|
|
173 |
|
|
|
174 |
/**
|
|
|
175 |
* Dans le cas des chaines de traduction à sous clé (ex.: cle.souscle), cette méthode
|
|
|
176 |
* évalue les valeurs correspondantes et créée les sous tableaux associés.
|
|
|
177 |
* @param array $i18n tableau de traductions (par référence)
|
|
|
178 |
* @param string $cle la cle dans le tableau
|
|
|
179 |
* @param string $valeur la valeur à affecter
|
|
|
180 |
*/
|
|
|
181 |
private static function evaluerCle($i18n, $cle, $valeur) {
|
|
|
182 |
if (strpos($cle, '.') !== false) {
|
|
|
183 |
unset($i18n[$cle]);
|
|
|
184 |
$pieces = explode('.', $cle, 2);
|
|
|
185 |
if (strlen($pieces[0]) && strlen($pieces[1])) {
|
|
|
186 |
if (isset($i18n[$pieces[0]]) && !is_array($i18n[$pieces[0]])) {
|
|
|
187 |
$m = "Ne peut pas créer de sous-clé pour '{$pieces[0]}' car la clé existe déjà";
|
|
|
188 |
trigger_error($m, E_USER_WARNING);
|
|
|
189 |
} else {
|
|
|
190 |
$i18n[$pieces[0]][$pieces[1]] = $valeur;
|
|
|
191 |
$i18n[$pieces[0]] = self::evaluerCle($i18n[$pieces[0]], $pieces[1], $valeur);
|
|
|
192 |
}
|
|
|
193 |
} else {
|
|
|
194 |
$m = "Clé invalide '$cle'";
|
|
|
195 |
trigger_error($m, E_USER_WARNING);
|
|
|
196 |
}
|
|
|
197 |
} else {
|
|
|
198 |
$i18n[$cle] = $valeur;
|
|
|
199 |
}
|
|
|
200 |
return $i18n;
|
|
|
201 |
}
|
|
|
202 |
|
|
|
203 |
/**
|
| 183 |
jpm |
204 |
* Cherche l'information sur la langue demandée par l'application
|
|
|
205 |
*/
|
|
|
206 |
private static function trouverLangue() {
|
|
|
207 |
if (isset($_GET[Config::get('i18n_url_parametre')])) {
|
|
|
208 |
self::$langue = $_GET[Config::get('i18n_url_parametre')];
|
|
|
209 |
} else {
|
|
|
210 |
self::$langue = Config::get('i18n_langue_defaut');
|
|
|
211 |
}
|
|
|
212 |
}
|
|
|
213 |
|
|
|
214 |
/**
|
|
|
215 |
* Vérifie si l'instance de classe à été crée, si non la crée
|
|
|
216 |
*/
|
|
|
217 |
private static function verifierCreationInstance() {
|
|
|
218 |
if (empty(self::$instance)) {
|
|
|
219 |
self::$instance = new I18n();
|
|
|
220 |
}
|
|
|
221 |
}
|
|
|
222 |
|
|
|
223 |
/**
|
|
|
224 |
* Vérifie que tous les paramêtres de config nécessaires au fonctionnement de cette classe existe dans les fichiers
|
|
|
225 |
* de configurations.
|
|
|
226 |
*/
|
|
|
227 |
private static function verifierParametresConfig() {
|
|
|
228 |
$ok = true;
|
|
|
229 |
$parametres = array('chemin_i18n', 'i18n_url_parametre', 'i18n_langue_defaut');
|
|
|
230 |
foreach ($parametres as $param) {
|
|
|
231 |
if (is_null(Config::get($param))) {
|
|
|
232 |
$m = "L'utilisation de la classe I18n nécessite de définir '$param' dans un fichier de configuration.";
|
|
|
233 |
self::ajouterErreur($m);
|
|
|
234 |
$ok = false;
|
|
|
235 |
}
|
|
|
236 |
}
|
|
|
237 |
return $ok;
|
|
|
238 |
}
|
|
|
239 |
|
|
|
240 |
/**
|
|
|
241 |
* Ajouter une message d'erreur
|
|
|
242 |
*/
|
|
|
243 |
private static function ajouterErreur($m, $e = E_USER_WARNING) {
|
|
|
244 |
if (Config::get('fw_debogage') === true) {
|
|
|
245 |
trigger_error($m, $e);
|
|
|
246 |
}
|
|
|
247 |
}
|
|
|
248 |
}
|