Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 700 | Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
631 delphine 1
<?php
2
 
3
// declare(encoding='UTF-8');// ou ISO-8859-15
4
/**
5
* Description :
6
* Classe Taxons.php permettant de fournir des informations sur les noms scientifiques retenu.
7
* Si l'url finit par /taxons on retourne une liste de noms latin et leurs identifiants (seulement les 100 premeiers noms par défaut).
8
* L'url peut contenir des paramètres optionnels passés après le ? : /taxons?param1=val1&param2=val2&...
9
*
10
* Les paramètres de requête disponibles sont : masque, recherche, rang, distinct, retour.format, nl.format,
11
* nl.structure, navigation.depart et navigation.limite.
12
*
13
* Encodage en entrée : utf8
14
* Encodage en sortie : utf8
15
* @package framework-v3
16
* @author Jennifer Dhé <jennifer.dhe@tela-botanica.org>
17
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
18
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
19
* @version 1.0
20
* @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org)
21
*/
22
 
23
 
24
class Taxons extends CommunNomsTaxons {
25
 
26
	/** Permet de stocker la requete formulée taxons | taxons/#id | taxons/#id/#champ+#champ ...*/
27
	protected $format_reponse	 = 'taxons';
28
	protected $service 			 = 'taxons';
29
	protected $requete_champ 	 = 'num_nom, nom_sci, num_nom_retenu, num_tax as num_taxonomique ';
30
	protected $requete_condition = null;
31
	protected $requete_group_by  = ' ';
32
	/** Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés).*/
33
	protected $limite_requete 	 = array('depart' => 0, 'limite' => 100);
34
	protected $num_nom_taxon; //Stocke le num_nom du nom retenu du num_nom recherché
35
	protected $presence_num_tax = true;
36
 
37
 
38
	public function consulter($ressources, $parametres) {
39
		return parent::consulter($ressources, $parametres);
40
	}
41
 
42
	public function traiterParametresSpecifiques() {
43
		$this->requete_condition[] = 'num_nom = num_nom_retenu';
44
 
45
		foreach ($this->parametres as $param => $val) {
46
			switch ($param) {
47
				case 'masque' :
48
					$this->ajouterFiltreMasque('nom_sci', $val);
49
					break;
50
				case 'masque.nt' :
51
					$this->requete_condition[] = "num_taxonomique IN ($val)";
52
					$this->masque[] = "num_tax=$val";
53
					break;
54
				case 'masque.rg':
55
					$this->requete_condition[] = 'rang = '.$this->getBdd()->proteger($val);
56
					$this->masque[] = "rang=$val";
57
					break;
58
			}
59
		}
60
	}
61
 
62
//------------------------------------------Fonction ressources---------------------------------------------------------------------
63
 
64
	public function gererNumTax() {
65
		if (!in_array('num_taxonomique', $this->champs_table)) {
66
			$this->presence_num_tax = false;
67
			$this->requete_champ = str_replace(', num_taxonomique ', '', $this->requete_champ);
68
		} else {
69
			$this->presence_num_tax = true;
70
		}
71
	}
72
 
73
	public function traiterRessourcesIdentifiant() {
74
		$this->format_reponse = 'taxons/id';
75
		$this->traiterRessourceNtId();
76
		$this->num_nom_taxon =  $this->recupererNumNomTaxon(); //on recupere le taxon correspondant au num_nom recherché
77
		if ($this->entete_http == '') {
78
			$this->requete_condition[0] = 'num_nom = '.$this->getBdd()->proteger($this->num_nom_taxon);
79
			if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
80
				//---------------- requete de type taxons/#id/#champ+#champ--------------------------------------
81
				if ($this->ressources[1] != 'relations') { // SELECT *, nom_sci FROM bftfx_v2_00 WHERE num_nom = X;
82
					$this->requete_champ = ' *, nom_sci ';
83
					$this->format_reponse .= '/champ';
84
				//---------------- requete de type taxons/#id/relations/#relation--------------------------------
85
				} elseif ($this->ressources[1] == 'relations') {
86
					$this->traiterRessourceIdRelations();
87
				} else {
88
					$e = 'Erreur dans votre requête </br> Ressources disponibles : <br/>
89
						 <li> #id/relations </li>  <li> #id/#champ+#champ </li> <li> #id/relations </li>
90
						 <li> #id/relations/inferieurs </li> <li> #id/relations/superieurs </li>';
91
					$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
92
				}
93
			} else { //--------------- requete de type taxons/#id-----------------------------------------------------
94
				$this->requete_champ = ' *, nom_sci ';
95
			}
96
		}
97
	}
98
 
99
	public function traiterRessourceNtId() {
100
		if (strrpos($this->ressources[0], 'nt:') !== false) {
101
			if ($this->presence_num_tax) {
102
				// SELECT num_nom FROM bdtfx_v2_00 WHERE num_nom = num_nom_retenu AND num_taxonomique = X;
103
				$this->requete_condition[0] = ' num_taxonomique = '
104
					.str_replace('nt:', '', $this->ressources[0]).' ';
105
			} else {
106
				$e = 'Erreur dans votre requête : </br> Le numéro taxonomique n\'existe pas dans ce projet';
107
				$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
108
			}
109
		} else {
110
			// SELECT num_nom FROM bdtfx_v2_00 WHERE num_nom = (SELECT num_nom_retenu FROM bdtfx_v2_00 WHERE num_nom = X);
111
			$this->requete_condition[0] = 'num_nom = '.$this->ressources[0];
112
		}
113
	}
114
 
115
 
116
	/** Permet de récupérer le num_nom du taxon recherché. Soit le numéro taxonomique est demandé (avec nt: )
117
	 * soit un num_nom dont on recherche le num_nom_retenu */
118
	public function recupererNumNomTaxon() {
119
		$identifiant = '';
120
		if ($this->entete_http == '') {
121
			//on récupere l'identifiant du taxon correspondant au num_nom ou num_taxonomique demandé pour pouvoir l'afficher
122
			$req_tax = 'SELECT num_nom_retenu FROM '.$this->table.' WHERE '.$this->requete_condition[0];
123
			$res_tax = $this->getBdd()->recuperer($req_tax);
124
			//on recherche ensuite les identifiants des taxons supérieurs ou inférieurs
125
			if ($res_tax && $res_tax != '') {
126
				$identifiant = $res_tax['num_nom_retenu'];
127
			} else {
128
				$e = 'Le numéro de taxon ou l\'identifiant de nom correspondant au num_nom '
129
					.$this->ressources[0].' n\'existe pas dans la base.';
130
				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
131
				Debug::printr($req_tax);
132
			}
133
		}
134
		return $identifiant;
135
	}
136
 
137
	public function traiterRessourceIdRelations() {
138
		//----------------- requete de type taxons/#id/relations-------------------------------------------
139
		// SELECT *, nom_sci FROM bftfx_v2_00 WHERE num_nom = X;
140
		$this->format_reponse .= '/relations';
141
		if (isset($this->ressources[2]) && !empty($this->ressources[2])) {
142
			//------------- requete de type taxons/#id/relations/#relation--------------------------------
143
			switch ($this->ressources[2]) {
144
				case 'superieurs' :
145
					$rel = 'recupererIdSup';
146
					$this->format_reponse .= '/superieurs';
147
					$this->traiterRessourceIdRelationInfSup($rel);
148
					break;
149
				case 'inferieurs' :
150
					$rel = 'recupererIdInf';
151
					$this->format_reponse .= '/inferieurs';
152
					$this->traiterRessourceIdRelationInfSup($rel);
153
					break;
154
				default :
155
					$e = 'Erreur dans votre requête </br> Ressources disponibles : <br/>
156
						 <li> taxons/#id/relations </li><li> #id/relations/inferieurs </li>
157
						 <li> #id/relations/superieurs </li>';
158
					$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
159
					break;
160
			}
161
		}
162
	}
163
 
164
	public function traiterRessourceIdRelationInfSup($rel) {
165
		//Appel de la fct récupérerIdSup ou recupererIdInf : retourne les num_nom des noms inferieurs ou superieurs
166
		$res_relation = $this->$rel();
167
		//analyse du résultat retourné par la requete de recherche des identifiants correspondant aux taxons inf|sup :
168
		if ($res_relation == '') { 	//dans le cas ou la requete comporte des erreurs
169
			$e = 'Fct traiterRessourceIdRelationInfSup : La requête forme comporte une erreur!';
170
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
171
		} elseif ($res_relation) {
172
			//dans le cas ou une ou plusieurs relations est retournée, on récupère les identifiants ss la forme (id, id, id)
173
			foreach ($res_relation as $ligne) $res[] = $ligne['num_nom'];
174
			$res = implode(',',$res);
175
			$this->requete_condition[0] = "num_nom IN ($res)";
176
			$this->requete_champ 	 .=  ', rang, num_tax_sup ';
177
		} else { //dans le cas ou aucune relation n'existe
178
			$res = array($this->num_nom_taxon => null);
179
			$this->corps_http = json_encode($res);
180
			$this->entete_http = RestServeur::HTTP_CODE_OK;
181
		}
182
	}
183
 
184
	public function recupererIdInf() {
185
		//SELECT num_nom FROM bfdtx_v2_00 WHERE num_tax_sup = (SELECT num_nom FROM bdtfx_v2_00 WHERE num_nom = X);
186
		$req_relation = 'SELECT num_nom FROM '.$this->table
187
							.' WHERE num_tax_sup = (SELECT num_nom FROM '
188
							.$this->table
189
							.' WHERE '.implode(' AND ', $this->requete_condition).')';
190
		$res_relation = $this->getBdd()->recupererTous($req_relation);
191
		return $res_relation;
192
	}
193
 
194
 
195
	public function recupererIdSup() {
196
		//SELECT num_nom FROM bfdtx_v2_00 WHERE num_nom = (SELECT num_tax_sup FROM bdtfx_v2_00 WHERE num_nom = X);
197
		$req_relation = 'SELECT num_tax_sup as num_nom FROM '.$this->table
198
							.' WHERE '.implode(' AND ', $this->requete_condition);
199
		$res_relation = $this->getBdd()->recupererTous($req_relation);
200
		return $res_relation;
201
	}
202
 
203
 
204
	public function traiterRessourceStatsInitiales() {
205
		// SELECT count(nom_sci) as nb, rang, left(nom_sci, 2) as lettre FROM bdtfx_v2_00  GROUP BY rang, left(nom_sci, 2);
206
		$this->format_reponse	= 'taxons/stats/initiales';
207
		$this->requete_champ	 = 'count(nom_sci) as nb, rang, left(nom_sci, 2) as lettre ';
208
		$this->requete_group_by  = ' GROUP BY rang, left(nom_sci, 2) ';
209
	}
210
 
211
	public function traiterRessourceStatsRangs() {
212
		// SELECT count(*) as nombre, rang FROM bdtfx_v2_00 [WHERE rang = 290] GROUP BY rang ORDER BY rang;
213
		$this->format_reponse	= 'taxons/stats/rangs';
214
		$this->requete_champ	 = 'count(*) as nombre, rang ';
215
		$this->requete_group_by  = ' GROUP BY rang ORDER BY rang ';
216
	}
217
 
218
	public function traiterRessourceStatsAnnees() {
219
		// SELECT count(*) as nombre, annee FROM bdtfx_v2_00 GROUP BY annee ORDER BY annee;
220
		$this->format_reponse	= 'taxons/stats/annees';
221
		$this->requete_champ	 = 'count(*) as nombre, annee ';
222
		$this->requete_group_by  = ' GROUP BY annee ORDER BY annee ';
223
	}
224
 
225
 
226
//-----------------------------FONCTIONS DASSEMBLAGE DE LA REQUETE-----------------------------------------------------
227
 
228
	public function assemblerLaRequete() {
229
		if ($this->format_reponse != 'taxons/stats/initiales') {
230
			$this->mettreAuFormat(); //on remplace les nom_sci par les nom_sci_html
231
		}
232
		$requete = 	' SELECT '.$this->requete_champ.
233
						' FROM '.$this->table
234
							.$this->retournerRequeteCondition()
235
							.$this->requete_group_by
236
							.$this->formerRequeteLimite();
237
		return $requete;
238
	}
239
 
240
	public function formerRequeteLimite() {
241
		if ($this->format_reponse != 'taxons' && $this->format_reponse != 'taxons/id/relations/homonymie') {
242
			$this->requete_limite = '';
243
		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
244
			$this->limite_requete['depart'] = (($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
245
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
246
		} else {
247
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
248
		}
249
		return $this->requete_limite;
250
	}
251
 
252
	public function retournerRequeteCondition() {
253
		$condition = '';
254
		if ($this->requete_condition) {
255
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
256
		}
257
		return $condition;
258
	}
259
 
260
	public function recupererTotalResultat() {
261
		$requete = 'SELECT count(*) as nombre FROM '.$this->table.$this->retournerRequeteCondition().$this->requete_group_by;
262
		$res = $this->getBdd()->recuperer($requete);
263
		if ($res) {
264
			$total = $res['nombre'];
265
		}
266
		return $total;
267
	}
268
 
269
//-------------------------FONCTIONS DE FORMATION DU RESULTAT-----------------------------------------------------------
270
 
271
	/** Permet de récupérer le résultat à retourner propre à chaque requete et de l'encoder en json*/
272
	public function retournerResultatFormate($resultat, $version) {
273
		switch ($this->format_reponse) {
274
			case 'taxons/id' ://ds CommunNomsTaxons
275
				$reponse = $this->formaterId($resultat[0]);
276
				break;
277
			case 'taxons/id/champ' ://ds CommunNomsTaxons
278
				$reponse = $this->formaterIdChamp($resultat[0]);
279
				break;
280
			case 'taxons/id/relations' :
281
				$reponse = $this->formaterIdRelations($resultat[0],$version);
282
				break;
283
			case 'taxons/id/relations/superieurs' :
284
				$reponse = $this->formaterIdSuperieur($resultat, $version);
285
				break;
286
			case 'taxons/id/relations/inferieurs' :
287
				$reponse = $this->formaterIdInferieur($resultat);
288
				break;
289
			case 'taxons/stats/annees' :  //ds CommunNomsTaxons
290
				$reponse = $this->formaterStatsAnnee($resultat);
291
				break;
292
			case 'taxons/stats/rangs' ://ds CommunNomsTaxons
293
				$reponse = $this->formaterStatsRang($resultat);
294
				break;
295
			case 'taxons/stats/initiales' ://ds CommunNomsTaxons
296
				$reponse = $this->formaterStatsInitiales($resultat);
297
				break;
298
			case 'taxons' :
299
				$reponse = $this->formatertaxons($resultat);
300
				break;
301
		}
302
		return $reponse;
303
	}
304
 
305
 
306
//----------------------concerne les resultats pour des requetes de type /noms avec ou sans paramètres--------------
307
 
308
	public function formaterTaxons($resultat) {
309
		if ($this->parametres['retour.format'] == 'oss') {
310
			$reponse = $this->formaterEnOss($resultat);
311
		} else {
312
			$reponse = $this->formaterEnJsonMax($resultat);
313
		}
314
		return $reponse;
315
	}
316
 
317
	public function formaterEnJsonMax($resultat) {
318
		//print_r($resultat);
319
		$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
320
		$masque = $this->recupererMasquePrincipal();
321
		if (isset($masque)) $resultat = $this->trierRechercheFloue($this->parametres[$masque[0]], $resultat, $masque[1]);
322
		if (isset($this->masque)) $this->table_retour['masque'] = implode('&', $this->masque);
323
		$this->afficherEnteteResultat('/'.$this->service);
324
		$table_retour_json['entete'] = $this->table_retour;
325
		$this->table_retour = array();
326
		//on remplit la table $table_retour_json['resultat']
327
		$tab_tax_inf = $this->recupererListeTaxonInf($resultat);
328
		foreach ($resultat as $tab) {
329
			$num = $tab['num_nom'];
330
			if (isset($this->parametres['masque.nt'])) $this->afficherDonnees('num_taxonomique', $tab['num_taxonomique']);
331
			$this->afficherNomHrefRetenu($tab, $num);
332
			$this->afficherTaxonInfNb($num, $tab_tax_inf);
333
			$resultat_json[$num] = $this->table_retour;
334
			$this->table_retour = array(); //on vide le tableau table_retour
335
		}
336
		$table_retour_json['resultat'] = $resultat_json;
337
		return $table_retour_json;
338
	}
339
 
340
 
341
//--------------------concerne les resultats pour des requetes de type noms/id----------------------------------------
342
 
343
	public function formaterIdRelations($resultat, $version) {
344
		$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
345
		$this->resultat_req = $resultat;
346
		$retour_id_rel = array ('entete' => array()); //on initialise pr que l'entete apparaisse en premier
347
 
348
		$superieurs = $this->ajouterRelations('superieurs'); //, $version);
349
		if (isset($superieurs)) $retour_id_rel['resultat']['superieurs'] = $superieurs;
350
		$inferieurs = $this->ajouterRelations('inferieurs', $version);
351
		if (isset($inferieurs)) $retour_id_rel['resultat']['inferieurs'] = $inferieurs;
352
 
353
		if (!isset($retour_id_rel['resultat']))	{ //on renvoit un tableau null si il n'existe aucune relations
354
			$retour_id_rel = 'null';
355
		} else { //on rajoute l'entete si des relations existent
356
			$this->afficherDonnees('num_nom', $this->num_nom_taxon); //$this->afficherEnteteResultat($resultat, '/'.$this->service.'/'.$this->ressources[0].'/relations/synonymie');
357
			$retour_id_rel['entete'] = $this->table_retour;
358
			$this->table_retour = array();
359
		}
360
		return $retour_id_rel;
361
	}
362
 
363
	public function ajouterRelations($relation, $version) {
364
		$version = str_replace(Config::get('bdd_table').'_', '', $version);
365
		$res = null;
366
		$taxon = $this->num_nom_taxon;
367
		$parametres_url = '';
368
		if ($this->parametres != array()) $parametres_url = '?'.http_build_query($this->parametres, '', '&');
369
		$url = Config::get('url_service').'/'
370
				.$this->service.'/'.$version.'/'
371
				.$this->ressources[0].'/relations/'
372
				.$relation.$parametres_url;
373
		$relation = $this->consulterHref($url);
374
		if (isset($relation->resultat)) {
375
			$res = $relation->resultat;
376
		} elseif (isset($relation->$taxon)) { //pour les relations inf et sup
377
			$res = $relation->$taxon;
378
		}
379
		return $res;
380
	}
381
 
382
	public function formaterIdSuperieur($resultat, $version) {
383
		$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
384
		$tab_relation = null; //si il n'existe aucune relation
385
		$taxon_sup_traites = array();
386
		if (($resultat) != '' ) {
387
			//on recupere d'abord les rangs supérieurs
388
			$sup = $resultat[0];
389
			do {
390
				$sup = $this->recupererIdSuperieur($sup['num_tax_sup'], $version);
391
				if(!in_array($sup['num_nom'], $taxon_sup_traites)) {
392
					$taxon_sup_traites[] = $sup['num_nom'];
393
				} else {
394
					$sup = null;
395
				}
396
				if ($sup['rang'] == '0') $sup['rang'] = '10'; //erreur dans la base
397
				if (isset($sup)) $resultat[] = $sup;
398
			} while ($sup != null);
399
			krsort($resultat);
400
			//on les affiche ensuite
401
			foreach ($resultat as $tab) {
402
				$this->resultat_req = $tab;
403
				$num = $tab['num_nom'];
404
				$this->afficherNomHrefRetenu($tab, $num);
405
				$this->afficherDonnees('rang', $tab['rang']);
406
				$tab_inf[$num] = $this->table_retour;
407
				$tab_inf[$num]['num_nom'] = $tab['num_nom'];
408
				$this->table_retour = array();
409
			}
410
 
411
			$tab_relation[$this->num_nom_taxon] = $tab_inf;
412
		}
413
		return $tab_relation;
414
	}
415
 
416
 
417
	public function recupererIdSuperieur($id, $version) {
418
		$req = 'SELECT num_nom, num_nom_retenu, num_tax_sup, rang, nom_sci FROM '
419
				.$version.' WHERE num_nom = '.$this->getBdd()->proteger($id);
420
		$res = $this->getBdd()->recupererTous($req);
421
		if ($res) {
422
			$resultat = $res[0];
423
		} else {
424
			$resultat = null; //on return null si il n'y a pas de taxon superieur
425
		}
426
		return $resultat;
427
	}
428
 
429
	public function formaterIdInferieur($resultat) {
430
		// Attention à l'ordre, on doit d'abord récupérer correpondance_champs avant champs_api
431
		$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
432
		$tab_relation = null;
433
		if (($resultat) != array()) {
434
			foreach ($resultat as $tab) {
435
				$this->resultat_req = $tab;
436
				$num = $tab['num_nom'];
437
				$this->afficherNomHrefRetenu($tab, $num);
438
				$this->afficherDonnees('rang', $tab['rang']);
439
				$tab_inf[$num] = $this->table_retour;
440
				$tab_inf[$num]['nom_sci'] = $tab['nom_sci'];
441
				$tab_inf[$num]['num_nom'] = $tab['num_nom'];
442
				$this->table_retour = array();
443
			}
444
			$tab_relation[$this->num_nom_taxon] = $tab_inf;
445
		}
446
		return $tab_relation;
447
	}
448
 
449
	public function afficherTaxonInfNb($num, $tab_tax_inf) {
450
		foreach ($tab_tax_inf as $taxNb) {
451
			if ($taxNb['num_tax_sup'] == $num) {
452
				$this->table_retour['taxon_inferieur_nbre'] = $taxNb['nb'];
453
			}
454
		}
455
		if (!isset($this->table_retour['taxon_inferieur_nbre'])) {
456
			$this->table_retour['taxon_inferieur_nbre'] = '0';
457
		}
458
	}
459
 
460
	public function recupererListeTaxonInf($resultat) {
461
		// SELECT num_tax_sup, count(*) as nb FROM bdtfx_v2_00 WHERE num_tax_sup IN (id, id, id) AND num_nom = num_nom_retenu GROUP BY num_tax_sup';
462
		foreach ($resultat as $tab) {
463
			$tab_num[] = $tab['num_nom']; //on regroupe ici les id des taxons dont on cherche le nb de taxon inf
464
		}
465
		$req = 'SELECT num_tax_sup, count(*) as nb FROM '.$this->table
466
				.' WHERE num_tax_sup IN ('.implode(',',$tab_num)
467
				.') AND num_nom = num_nom_retenu GROUP BY num_tax_sup';
468
		$res = $this->getBdd()->recupererTous($req);
469
		if ($res) {
470
			$resultat = $res;
471
		} else {
472
			$resultat = array(); //on retourne un tableau vide s'il n'y a pas de taxon inférieurs
473
		}
474
		return $resultat;
475
	}
476
}
477
 
478
?>