Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 1104 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
6 jpm 1
<?php
2
/**
3
* Description :
16 jpm 4
* Classe ZoneGeo.php fournit des informations sur ensemble structuré des termes et concepts représentant les éléments
6 jpm 5
* d'un domaine de connaissances .
16 jpm 6
* Le but étant de fournir un ensemble minimal d'information comprenant :
7
* un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une region et
6 jpm 8
* éventuellement une relation hiérarchique avec un autre terme (=classe).
9
* Si l'url finit par /zone-geo on retourne une liste de termes (seulement les 100 premières par défaut).
10
* L'url peut contenir des paramètres optionnels passés après le ? : /observations?param1=val1&param2=val2&...
16 jpm 11
*
12
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.region , recherche,
6 jpm 13
* distinct, retour.format, navigation.depart et navigation.limite.
16 jpm 14
*
6 jpm 15
* Encodage en entrée : utf8
16
* Encodage en sortie : utf8
17
* @package framework-v3
16 jpm 18
* @author Delphine Cauquil <delphine@tela-botanica.org>
6 jpm 19
* @author Jennifer Dhé <jennifer.dhe@tela-botanica.org>
20
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
21
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
22
* @version 1.0
23
* @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org)
24
*/
25
 
26
class ZoneGeo extends Commun {
16 jpm 27
 
6 jpm 28
	protected $service = 'zone-geo';
16 jpm 29
 
6 jpm 30
	/**
31
	 * Permet de stocker la requete formulée : /zone-geo | /zone-geo/#id | /zone-geo/#id/champ | /zone-geo/#id/relations
16 jpm 32
	 * Est remplit au cours de l'analyse des ressources (traiterRessources()), par défaut, a la valeur du service.
6 jpm 33
	 * Est utilisée principalement pr déterminer le format du tableau à retourner.	 */
16 jpm 34
	protected $format_reponse = 'zone-geo';
35
 
1104 mathias 36
	/** Tri des résultats */
37
	protected $tri = 'dep';
38
	protected $ordre = 'ASC';
39
	/**
40
	 * Permet de trier selon les clefs des tableaux reçus, et que ça marche (en
41
	 * fait faut faire des alias de colonnes correspondant aux clefs de sortie
42
	 * mais bon bref...)
43
	 */
44
	protected $corres_tri = array('code' => 'dep', 'nom' => 'nccenr');
45
 
16 jpm 46
	/** Variables constituant les parametres de la requete SQL (champ, condition, group by, limit) remplie
6 jpm 47
	 * selon ressources et paramètres	 */
48
	protected $requete_champ = ' * ';
49
	protected $requete_condition = '';
50
	protected $limite_requete = array(
16 jpm 51
		'depart' => 0,
6 jpm 52
		'limite' => 100
53
	);
16 jpm 54
 
6 jpm 55
	/** Stockage des ressources et paramétres */
56
	protected $table_ressources = array();
57
	protected $table_param = array();
1104 mathias 58
 
6 jpm 59
	/**
16 jpm 60
	 * Precise la contenance plus ou moins précise du tableau à retourner :
61
	 *  - min = les données présentes dans la table
6 jpm 62
	 *  - max = les données de la table + les informations complémentaires (pour les identifiants et les codes)
16 jpm 63
	 *  - oss = la liste des nom_sci (uniquement pour noms et taxons)
6 jpm 64
	 */
65
	protected $retour_format = 'max';
1104 mathias 66
 
67
	/**
68
	 * Si "objet", renverra un objet dont les clefs sont les codes de départements;
69
	 * Si "liste", renverra une liste qui a le mérite de conserver l'ordre !
70
	 */
71
	protected $retour_type = 'objet';
72
 
16 jpm 73
	/** Valeur du paramètre de requete recherche :
74
	 *  - stricte : le masque est passé tel quel à l'opérateur LIKE.
75
	 *  - etendue : ajout automatique du signe % à la place des espaces et en fin de masque avec utilisation de LIKE.
6 jpm 76
	 *  - floue : recherche tolérante vis-à-vis d'approximations ou d'erreurs (fautes d'orthographe par exemple) */
77
	protected $recherche;
16 jpm 78
 
6 jpm 79
	/** Permet de stocker le tableau de résultat (non encodé en json) */
80
	protected $table_retour = array();
1104 mathias 81
 
6 jpm 82
	/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
83
	protected $total_resultat;
16 jpm 84
 
69 jpm 85
	// +-----------------------------------------------------------------------------------------------------+
16 jpm 86
	public function traiterParametres() {
87
		if (isset($this->parametres) && !empty($this->parametres)) {
88
			$this->table_param = $this->parametres;
89
 
6 jpm 90
		//   masque : filtre la liste en fonction d'un masque de recherche portant sur le code, le nom ou la region.
91
        //   masque.code : filtre uniquement sur le code. masque.nom : filtre uniquement sur le nom.
92
        //   masque.region : filtre uniquement sur la region.
16 jpm 93
			if (isset($this->parametres['recherche']) && $this->parametres['recherche'] != '') {
94
				$this->recherche = $this->parametres['recherche'];
6 jpm 95
			}
16 jpm 96
 
69 jpm 97
			foreach ($this->parametres as $param => $valeur) {
6 jpm 98
				switch ($param) {
69 jpm 99
					case 'masque' :
100
						$this->ajouterLeFiltreMasque('masque', $valeur);
101
						break;
102
					case 'masque.code' :
103
						$this->ajouterLeFiltreMasque('dep', $valeur);
104
						break;
105
					case 'masque.nom' :
1099 mathias 106
						if ($valeur !== '') {
107
							$this->ajouterLeFiltreMasque('nccenr', $valeur);
108
						}
69 jpm 109
						break;
110
					case 'masque.region' :
111
						$this->ajouterLeFiltreMasque('region', $valeur);
112
						break;
113
					case 'retour.format' :
114
						$this->retour_format = $valeur;
115
						break;
1104 mathias 116
					case 'retour.type' :
117
						if (in_array($valeur, array('objet', 'liste')))
118
							$this->retour_type = $valeur;
119
						break;
120
					case 'retour.tri' :
121
						if ($valeur != '' ) {
122
							if (in_array($valeur, array_keys($this->corres_tri))) {
123
								$this->tri = $this->corres_tri[$valeur];
124
							} else {
125
								$this->tri = $valeur; // au petit bonheur la chance
126
							}
127
						}
128
						break;
129
					case 'retour.ordre' :
130
						if (in_array(strtoupper($valeur), array('ASC', 'DESC')))
131
							$this->ordre = $valeur;
132
						break;
69 jpm 133
					case 'navigation.depart' :
1099 mathias 134
						if ($valeur != '')
135
							$this->limite_requete['depart'] = $valeur;
69 jpm 136
						break;
137
					case 'navigation.limite' :
1099 mathias 138
						if ($valeur != '')
139
							$this->limite_requete['limite'] = $valeur;
69 jpm 140
						break;
141
					case 'recherche' :
142
						break;
143
					default :
144
						$p = 'Erreur dans les paramètres de recherche de votre requête : '.
145
							'</br> Le paramètre " '.$param.' " n\'existe pas.';
146
							$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $p);
6 jpm 147
				}
148
			}
149
		}
150
	}
16 jpm 151
 
6 jpm 152
	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
153
		if ($nom_champ == 'dep' || $nom_champ == 'region') {
154
			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
155
		} else {
156
			if ($this->recherche == 'floue') {
157
				if ($nom_champ == 'masque') {
158
					$this->requete_condition[] = '( dep = '.$this->getBdd()->proteger($valeur)
159
						.' OR region = '.$this->getBdd()->proteger($valeur)
160
						.' OR ( SOUNDEX(nccenr) = SOUNDEX(\''.$valeur.'\')'
161
						.' OR SOUNDEX(REVERSE(nccenr)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
162
						.')) ';
163
				} else {
164
					$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
165
						.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\'))) ';
166
				}
167
			} else {
168
				if ($this->recherche == 'etendue') {
169
					$valeur = str_replace(' ','%', $valeur);
170
					$valeur .= '%';
171
				}
16 jpm 172
 
6 jpm 173
				if ($nom_champ == 'masque') {
174
					$this->requete_condition[] = ' (dep = '.$this->getBdd()->proteger($valeur)
175
						.' OR nccenr LIKE '.$this->getBdd()->proteger($valeur)
176
						.' OR region = '.$this->getBdd()->proteger($valeur).')';
177
				} else {
178
					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
179
				}
180
			}
16 jpm 181
		}
182
	}
6 jpm 183
 
16 jpm 184
 
69 jpm 185
	//+------------------------------------------------------------------------------------------------------+
16 jpm 186
	public function traiterRessources() {
187
		if (isset($this->ressources) && !empty($this->ressources)) {
188
			$this->table_ressources = $this->ressources;
6 jpm 189
			if (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) {
190
				//requete = /zone-geo/#id
191
				$this->traiterRessourceId();
192
				if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
193
					//dans le cas /zone-geo/#id/#champ ou /zone-geo/#id/relations
194
					$this->traiterRessourceChampOuRelations();
195
				}
196
			}
197
		}
198
	}
16 jpm 199
 
6 jpm 200
	//requete : /zone-geo/#id (ex : /zone-geo/7)
201
	public function traiterRessourceId() {
202
		if (is_numeric($this->table_ressources[0])) {
203
			$this->requete_condition[] = ' dep = '.$this->getBdd()->proteger($this->table_ressources[0]);
204
			$this->format_reponse .= '/id';
205
		} else {
206
			$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->table_ressources[0].
207
				' " n\'existe pas.';
16 jpm 208
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r);
6 jpm 209
		}
210
	}
16 jpm 211
 
212
 
6 jpm 213
	public function traiterRessourceChampOuRelations() {
214
		//requete = /zone-geo/#id/relations :
215
		if ($this->table_ressources[1] == 'relations') {
216
			$this->format_reponse .= '/relations';
217
			$this->requete_condition[] = 'region = (SELECT region FROM '.$this->table.' WHERE '
218
										.implode(' AND ', $this->requete_condition).')';
219
		//requete = /zone-geo/#id/#champ :
220
		} else {
221
			$this->format_reponse .= '/champ';
222
		}
223
	}
16 jpm 224
 
69 jpm 225
	//+------------------------------------------------------------------------------------------------------+
6 jpm 226
	public function assemblerLaRequete() {
227
		//assemblage de la requete :
228
		$requete = ' SELECT '.$this->requete_champ.
229
					' FROM '.$this->table
230
					.$this->formerRequeteCondition()
1104 mathias 231
					. ' ORDER BY ' . $this->tri . ' ' . $this->ordre
6 jpm 232
					.$this->formerRequeteLimite();
233
		return $requete;
234
	}
16 jpm 235
 
6 jpm 236
	public  function formerRequeteCondition() {
237
		$condition = '';
16 jpm 238
		if ($this->requete_condition != null) {
6 jpm 239
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
16 jpm 240
		}
6 jpm 241
		return $condition;
242
	}
16 jpm 243
 
244
 
245
	//ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes
6 jpm 246
	// suivantes : /zone-geo et /zone-geo/#id/relations)
247
	public function formerRequeteLimite() {
248
		if ($this->format_reponse != 'zone-geo' && $this->format_reponse != 'zone-geo/id/relations') {
249
			$this->requete_limite = '';
250
		} else {
1099 mathias 251
			$this->total_resultat = $this->recupererTotalResultat();
6 jpm 252
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
253
		}
254
		return $this->requete_limite;
255
	}
16 jpm 256
 
6 jpm 257
	public function recupererTotalResultat() {
258
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /zone-geo)
259
		$requete = 'SELECT count(*) as nombre FROM '
260
			.$this->table
261
			.$this->formerRequeteCondition();
262
		$res = $this->getBdd()->recuperer($requete);
16 jpm 263
 
6 jpm 264
		if ($res) {
265
			$total = $res['nombre'];
266
		} else {
267
			$t = 'Fonction recupererTotalResultat() : <br/>Données introuvables dans la base';
268
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $t);
269
		}
270
		return $total;
271
	}
16 jpm 272
 
69 jpm 273
	//+------------------------------------------------------------------------------------------------------+
16 jpm 274
	// determine en fct du service appelé (/zone-geo | /zone-geo/#id | /zone-geo/#id/champ |
6 jpm 275
	// /zone-geo/#id/relations) le format du tableau à retourner.
276
	public function retournerResultatFormate($resultat) {
277
		$this->recupererTableConfig('correspondance_champs');
278
		switch ($this->format_reponse) {
279
			case 'zone-geo'					: $reponse = $this->formaterZoneGeo($resultat);				break;
280
			case 'zone-geo/id'				: $reponse = $this->formaterZoneGeoId($resultat[0]);		break;
281
			case 'zone-geo/id/champ'		: $reponse = $this->formaterZoneGeoIdChamp($resultat[0]);	break;
282
			case 'zone-geo/id/relations'	: $reponse = $this->formaterZoneGeoIdRelations($resultat);	break;
283
			default							:															break;
284
		}
285
		return $reponse;
286
	}
16 jpm 287
 
6 jpm 288
	public function formaterZoneGeo($resultat) {
289
		//on remplit la table $table_retour_json['entete']
290
		$this->table_retour['depart'] = $this->limite_requete['depart'];
291
		$this->table_retour['limite'] = $this->limite_requete['limite'];
292
		$this->table_retour['total']  = $this->total_resultat;
293
		$url = $this->formulerUrl($this->total_resultat, '/zone-geo');
69 jpm 294
		if (isset($url['precedent']) && $url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
295
		if (isset($url['suivant']) && $url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
6 jpm 296
		$table_retour_json['entete'] = $this->table_retour;
16 jpm 297
 
6 jpm 298
		//on remplit la table $table_retour_json['resultat']
299
		$this->table_retour = array();
300
		if (isset($this->table_param['masque_nom'])) $resultat = $this->trierRechercheFloue($this->table_param['masque_nom'], $resultat, 'nccenr');
301
		foreach ($resultat as $tab) {
302
			foreach ($tab as $key => $valeur) {
303
				if ($valeur != '') {
304
					switch ($key) {
305
						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
306
						case 'nccenr'	: $this->table_retour['nom'] = $valeur;						break;
307
						default			:															break;
308
					}
309
				}
310
			}
311
			if ($this->retour_format == 'max') {
312
				$this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
313
			}
1104 mathias 314
			if ($this->retour_type == 'objet') {
315
				$resultat_json[$num] = $this->table_retour;
316
			} elseif ($this->retour_type == 'liste') {
317
				$resultat_json[] = $this->table_retour;
318
			}
6 jpm 319
			$this->table_retour = array();
320
		}
321
		$table_retour_json['resultat'] = $resultat_json;
322
		return $table_retour_json;
323
	}
16 jpm 324
 
6 jpm 325
	public function formaterZoneGeoId($resultat) {
326
		foreach ($resultat as $key => $valeur) {
327
			if ($valeur != '') {
328
				$this->afficherDonnees($key, $valeur);
329
			}
330
		}
331
		unset($this->table_retour['href']);
332
		return $this->table_retour;
333
	}
16 jpm 334
 
6 jpm 335
	public function formaterZoneGeoIdRelations($resultat) {
336
		if ($resultat == '') {
337
			$retour = null;
338
		} else {
339
			//on remplit la table $table_retour_json['entete']
340
			$this->table_retour['depart'] = $this->limite_requete['depart'];
341
			$this->table_retour['limite'] = $this->limite_requete['limite'];
342
			$this->table_retour['total']  = $this->total_resultat;
343
			//formuler les urls
344
			$url = $this->formulerUrl(count($resultat), '/zone-geo');
345
			if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
346
			if ($url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
347
			$retour['entete'] = $this->table_retour;
348
			$this->table_retour = array();
16 jpm 349
 
6 jpm 350
			//on remplit la table $table_retour_json['resultat']
351
			foreach ($resultat as $tab) {
352
				foreach ($tab as $key => $valeur) {
353
					switch ($key) {
354
						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
355
						case 'nccenr'	: $this->table_retour['nom'] = $valeur;						break;
356
						default			:					 										break;
357
					}
358
				}
359
				if ($this->retour_format == 'max') $this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
360
				$resultat_json[$num] = $this->table_retour;
361
				$this->table_retour = array();
362
			}
16 jpm 363
			$retour['resultat'] = $resultat_json;
6 jpm 364
		}
365
		return $retour;
366
	}
16 jpm 367
 
6 jpm 368
	public function formaterZoneGeoIdChamp($resultat) {
369
		//on recupère tous les resultats possibles
370
		$reponse = $this->formaterZoneGeoId($resultat);
371
		$this->table_retour = array();
372
		//on recupère les résultats demandés à partir du tableau de résultat complet
373
		$this->table_retour['id'] = $reponse['code'];
374
		$champs = explode(' ', $this->table_ressources[1]);
16 jpm 375
 
6 jpm 376
		foreach ($champs as $champ) {
377
			if ($this->verifierValiditeChamp($champ)) {
378
				if (strrpos($champ, '.*') !== false) {
379
					$this->afficherPointEtoile($champ, $reponse);
16 jpm 380
 
6 jpm 381
				} else {
382
					if (isset($reponse[$champ])) {
383
						$this->table_retour[$champ] = $reponse[$champ];
384
					} else {
385
						$this->table_retour[$champ] = null;
386
					}
387
				}
388
			}
389
		}
390
		return $this->table_retour;
391
	}
16 jpm 392
 
6 jpm 393
	public function verifierValiditeChamp($champ) {
394
		preg_match('/^([^.]+)(\.([^.]+))?$/', $champ, $match);
395
		$champs_possibles = $this->correspondance_champs;
396
		$champs_possibles[] = 'nom.*';
16 jpm 397
 
6 jpm 398
		if (in_array($match[1], $champs_possibles)) {
399
			$validite = true;
400
		} elseif (in_array($match[0], $champs_possibles)) {
401
			$validite = true;
402
		} else {
403
			$champs_possibles = implode('</li><li>', $champs_possibles);
404
			$c = 'Erreur dans votre requête : </br> Le champ "'.$champ_possibles.'" n\'existe pas. '.
405
				'Les champs disponibles sont : <li>'.$champs_possibles.'</li>';
406
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $c);
407
		}
408
		return $validite;
409
	}
16 jpm 410
 
6 jpm 411
	public function afficherPointEtoile($champ, $reponse) {
412
		preg_match('/^([^.]+\.)\*$/', $champ, $match);
413
		foreach ($reponse as $chp => $valeur) {
414
			if (strrpos($chp, $match[1]) !== false) {
415
				if ($valeur != '') {
416
					$this->table_retour[$chp] = $valeur;
417
				} else {
418
					$this->table_retour[$chp] = null;
419
				}
420
			}
421
		}
16 jpm 422
	}
423
 
6 jpm 424
	public function afficherDonnees($champ, $valeur) {
425
		if ($this->retour_format == 'max') {
426
			if ($champ == 'region' || $champ == 'chef_lieu') {
427
				$projet = 'insee-'.substr($champ, 0, 1);
428
				$this->table_retour[$champ.'.code'] = $valeur;
429
				$this->table_retour[$champ.'.href'] = $this->ajouterHrefAutreProjet('zone-geo', '', $valeur, $projet);
430
			} elseif ($champ == 'tncc') {
431
				$url = $this->ajouterHref('ontologies', $valeur);
432
				$res = $this->consulterHref($url);
433
				$this->table_retour['type_nom'] = $res->nom;
434
				$this->table_retour['type_nom.code'] = $valeur;
435
				$this->table_retour['type_nom.href'] = $url;
436
			} else {
437
				$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
438
			}
439
		} else {
440
			$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
441
		}
442
	}
16 jpm 443
 
6 jpm 444
}
445
 
446
?>