1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
|
<?php
/***********************************************************
Nom du fichier : XMLEngine.php
Auteur : Flauder Vincent
Description : Fichier de classe XMLEngine permettant de manipuler
les fichiers XML conforme.
************************************************************/
class XMLEngine
{
private $domFile;//Attribut de l'instance de la classe DOMDocument
private $currentLanguage;//Attribut de la langue courante à lire
private $currentFile;//Attribut comportant le chemin du fichier actuel.
private $fileLock;//Attribut utilisé comme verrou de sécurité, notemment lors de la sauvegarde
/********************************************************************************
METHODES PUBLIQUES DE L'OBJET
********************************************************************************/
/**
* Constructeur de la classe qui prépare le fichier et l'objet à l'utilisation
* Arguments :
* $filename : chemin du fichier XML (string)
* $lang : langue utilisée (string)
*/
public function __construct( $filename, $language )
{
$this->currentLanguage = $language;
$this->currentFile = $filename;
//$this->domFile = new DOMDocument('1.0', 'iso-8859-1');
$this->domFile = new DOMDocument('1.0', 'UTF-8');
$this->domFile->preserveWhiteSpace = false; //On ne se soucie pas des espaces blancs.
$this->fileLock = fopen( str_replace( '.xml', 'xml.checker', $this->currentFile ),'a+'); //Ouverture du fichier de sécurité.
$this->changeFile( $filename );
}
/*
* Cette méthode permet de récupérer le nom du fichier en cours d'utilisation
*/
public function getCurrentFile()
{
return $this->currentFile;
}
/** La méthode suivante permet de récuperer le texte contenu dans la balise dont
* l'ID est donné en paramètre.
*/
public function getItemValue( $itemName )
{
//On recherche l'élément selon sont IDentifiant.
$item = $this->domFile->getElementById( $itemName );
if ( $item != NULL )
{
//On récupere la liste des éléments "translation" que l'on parcours...
foreach ( ($item->getElementsByTagName( 'translation' )) as $itemTest )
{
//...afin de trouver celui dont l'attribut lang est égal à celui de l'objet.
if ( $itemTest->getAttribute( 'lang' ) == $this->currentLanguage )
{
//Puis on retourne le texte donné.
return utf8_decode( $itemTest->nodeValue );
}
}
}
else
{
return "NULL";
}
}
/** La méthode suivante permet d'extraire la liste de tous les éléments "xmldata" du fichier actuel,
* cette méthode est utilisée par d'autre lors de la recherche d'éléments.
*/
public function getItemNodeList()
{
$i = 0;
//On parcours tous les éléments "xmldata"
foreach ( ($this->domFile->getElementsByTagName( 'xmldata' )) as $item )
{
//Puis on sauve chacun des identifiants dans un tableau.
$returnTab[$i++] = $item->getAttribute( 'id' );
}
return $returnTab;
}
/**
* La méthode changeFile permet de charger un nouveau fichier XML
* dans l'objet en cours.
*/
public function changeFile( $newFile )
{
$this->domFile->load($newFile);
$this->domFile->validate();
$this->currentFile = $newFile;
}
/**
* La méthode changeLanguage permet de changer la langue utilisée.
*/
public function changeLanguage( $newLanguage )
{
$this->currentLanguage = $newLanguage;
}
/**
* La méthode suivante permet d'ajouter un nouvel élément "xmldata" avec un élément translation
* de la langue courrante et avec une valeur par défaut
*/
public function addXmlElement( $itemID, $lang, $itemDefaultValue )
{
//On créer l'objet "xmldata"
$xmlItem = $this->domFile->createElement( 'xmldata', '' );
//Puis l'objet "translation"
$translateItem = $this->domFile->createElement( 'translation', utf8_encode($itemDefaultValue) );
$translateItem->setAttribute( 'lang', $lang );
//On associe l'élément "translate" dans "xmldata".
$xmlItem->appendChild( $translateItem );
if ( $this->domFile->getElementById( $itemID ) == NULL )
{
//On rajoute seulement l'attribut ID
$xmlItem->setAttribute( 'id', utf8_encode($itemID) );
//On attache le nouvel élément au noeud principal
$root = $this->domFile->getElementsByTagName( 'language' );
$root->item(0)->appendChild( $xmlItem );
//Sauvegarde du fichier.
$this->saveFile();
return true;//La création de l'objet s'est bien déroulée.
}
else
{
//Renvoi faux si l'élément existe déjà.
return false;
}
}
/**
* Cette méthode permet de modifier un élément $itemID dans la langue $lang
* avec le nouveau contenu $newContent.
*/
public function modifyXmlElement( $itemID, $lang, $newContent )
{
//On recherche l'élément selon sont IDentifiant.
$item = $this->domFile->getElementById( $itemID );
if ( $item != NULL )
{
//On récupere la liste des éléments "translation" que l'on parcours...
foreach ( ($item->getElementsByTagName( 'translation' )) as $itemTest )
{
//...afin de trouver celui dont l'attribut lang est égal à celui de l'objet.
if ( $itemTest->getAttribute( 'lang' ) == $lang )
{
$itemTest->nodeValue = utf8_encode($newContent);
$this->saveFile();
return true; //L'opération s'est bien déroulée.
}
}
}
return false;//L'élément n'a pas été trouvé.
}
/**
* Méthode supprimant un élément translation dans la langue $lang, et ce dans
* l'élément xmldata dont l'ID est $itemID.
*/
public function removeXmlElement( $itemID, $lang )
{
/*
* On doit parcourir toutes les balises et les rechercher manuellement
* pour pouvoir au final supprimer le noeud, ceci à cause de la fonction
* getElementById qui renvoi un objet
*/
$nodeList = $this->domFile->getElementsByTagName( 'xmldata' );
for ( $i=0; $i<$nodeList->length; $i++ )
{
//Recherche selon l'identifiant
if ( utf8_decode($nodeList->item($i)->getAttribute( 'id' )) == $itemID )
{
$transNode = $nodeList->item($i)->getElementsByTagName( 'translation' );
//Parcours des éléments 'translation'
for ( $j=0; $j<$transNode->length; $j++ )
{
//Recherche selon la langue
if ( $transNode->item($j)->getAttribute( 'lang' ) == $lang )
{
$goodNode = $transNode->item($j);
//Suppresion du noeud.
$oldNode = $nodeList->item($i)->removeChild( $goodNode );
$this->saveFile();
return true;//L'opération s'est bien déroulée.
}
}
}
}
return false;//L'élément n'a pas été trouver/supprimer.
}
/**
* Méthode supprimant un élément xmldata avec l'ID $itemID.
*/
public function completelyRemoveXmlElement( $itemID )
{
/*
* On doit parcourir toutes les balises et les rechercher manuellement
* pour pouvoir au final supprimer le noeud, ceci à cause de la fonction
* getElementById qui renvoi un objet
*/
$nodeList = $this->domFile->getElementsByTagName( 'xmldata' );
for ( $i=0; $i<$nodeList->length; $i++ )
{
//Recherche selon l'identifiant
if ( utf8_decode($nodeList->item($i)->getAttribute( 'id' )) == $itemID )
{
$goodNode = $nodeList->item($i);
//Suppresion du noeud.
$oldNode = $this->domFile->getElementsByTagName( 'language' )->item(0)->removeChild( $goodNode );
$this->saveFile();
return true;//L'opération s'est bien déroulée.
}
}
return false;//La suppression n'a pas eu lieue.
}
/**
* M�thode permettant de savoir si un élément est vide ou non.
*/
public function isEmptyXml( $itemID, $lang )
{
//On recherche l'élément selon sont IDentifiant.
$item = $this->domFile->getElementById( $itemID );
if ( $item != NULL )
{
//On récupere la liste des éléments "translation" que l'on parcours...
foreach ( ($item->getElementsByTagName( 'translation' )) as $itemTest )
{
//...afin de trouver celui dont l'attribut lang est égal à celui de l'objet.
if ( $itemTest->getAttribute( 'lang' ) == $lang )
{
//On vérifie si la valeur de l'élément est vide.
if ( $itemTest->nodeValue == "" )
{
return TRUE;
}
else
{
return FALSE;
}
}
}
}
else
{
return false;
}
}
/*
* Méthode ajoutant des balises translation dans la langue $lang si elles
* n'existent pas.
*/
public function addLanguageToFile( $newLanguage )
{
$allData = $this->domFile->getElementsByTagName( 'xmldata' );
$control = true;//Variable de controle pour insérérer ou non un nouvel élément.
//On parcours tous les éléments pour vérifier s'il existe un élément de même langue
for ( $i=0; $i<$allData->length; $i++ )
{
$transData = $allData->item($i)->getElementsByTagName( 'translation' );
for ( $j=0; $j<$transData->length; $j++ )
{
if ( $transData->item($j)->getAttribute( 'lang' ) == $newLanguage )
{
$control = false;
}
}
if ( $control )
{
$newTrans = $this->domFile->createElement( 'translation', '' );
$newTrans->setAttribute( 'lang', $newLanguage );
$allData->item($i)->appendChild( $newTrans );
}
else
{
$control = true;
}
}
$this->saveFile();//Sauvegarde du fichier
//Cette fonction ne renvoi aucune valeur
}
/*
* Méthode vérifiant que tous les éléments xmldata possèdent des éléments
* translation dans la langue $lang, et qu'ils soient remplis.
*/
public function checkIntegrity( $lang )
{
$this->addLanguageToFile( $lang );//On rajoute la langue au cas où.
$nodeList = $this->domFile->getElementsByTagName( 'xmldata' );
$nodeCount = $nodeList->length;
$nodeCounter = 0;
for ( $i=0; $i<$nodeCount; $i++ )
{
//...et vérifier que les éléments sont bien remplis
if ( !$this->isEmptyXml( $nodeList->item($i)->getAttribute( 'id' ), $lang ) )
{
//On incrémente le compteur de variables validées.
$nodeCounter++;
}
}
if ( $nodeCounter == $nodeCount )
{
//Aucun élément vide
return true;
}
else
{
//Si un seul élément est vide, on renvoi faux
return false;
}
}
/** On utilise ici la méthode magique __get qu'offre PHP afin de simplifier grandement
* la sortie des données. Cette méthode sera appellée lorsque vous demanderez d'accéder
* à un attribut de la classe . Elle retournera alors dans ce cas, la valeur textuelle
* de la balise.
*/
public function __get( $itemName )
{
return $this->getItemValue( $itemName );
}
/************************************************************************************
METHODES PRIVEES
************************************************************************************/
//Méthode privée permettant de sauvegarder le fichier XML de manière sécurisée.
private function saveFile()
{
//On pose un verrou d'écriture pour éviter des écritures multiples pouvant créer des erreurs.
while ( flock( $this->fileLock, LOCK_EX ) == FALSE )
{
//Ne rien faire en attendant que le verrou soit posé.
}
//On rajoute le mot BACKUP a la fin des fichiers pour la sauvegarde préalable.
$backupfile = str_replace( '.xml', 'xml.backup', $this->currentFile );
//Vérification avant sauvegarde pour éviter une erreur pouvant supprimer l'intégralité du fichier.
if ( $this->domFile->save($backupfile) != FALSE )
{
//Sauvegarde du fichier XML.
$this->domFile->save($this->currentFile);
}
else
{
die('Erreur lors de la sauvegarde du fichier XML '.$this->currentFile);
}
//On libére le verrou du fichier.
if ( !flock( $this->fileLock, LOCK_UN ) )
{
die('Erreur lors de la sauvegarde du fichier XML '.$this->currentFile.'Liberation');
}
}
}?> |
[DOM] Problème d'accent pour un mot venant d'un xml
Répondre avec citation
Partager