Subversion Repositories eFlore/Projets.eflore-projets

Rev

Rev 16 | Rev 1099 | 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
 
36
	/** Variables constituant les parametres de la requete SQL (champ, condition, group by, limit) remplie
6 jpm 37
	 * selon ressources et paramètres	 */
38
	protected $requete_champ = ' * ';
39
	protected $requete_condition = '';
40
	protected $limite_requete = array(
16 jpm 41
		'depart' => 0,
6 jpm 42
		'limite' => 100
43
	);
16 jpm 44
 
6 jpm 45
	/** Stockage des ressources et paramétres */
46
	protected $table_ressources = array();
47
	protected $table_param = array();
48
	/**
16 jpm 49
	 * Precise la contenance plus ou moins précise du tableau à retourner :
50
	 *  - min = les données présentes dans la table
6 jpm 51
	 *  - max = les données de la table + les informations complémentaires (pour les identifiants et les codes)
16 jpm 52
	 *  - oss = la liste des nom_sci (uniquement pour noms et taxons)
6 jpm 53
	 */
54
	protected $retour_format = 'max';
16 jpm 55
	/** Valeur du paramètre de requete recherche :
56
	 *  - stricte : le masque est passé tel quel à l'opérateur LIKE.
57
	 *  - etendue : ajout automatique du signe % à la place des espaces et en fin de masque avec utilisation de LIKE.
6 jpm 58
	 *  - floue : recherche tolérante vis-à-vis d'approximations ou d'erreurs (fautes d'orthographe par exemple) */
59
	protected $recherche;
16 jpm 60
 
6 jpm 61
	/** Permet de stocker le tableau de résultat (non encodé en json) */
62
	protected $table_retour = array();
63
	/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
64
	protected $total_resultat;
16 jpm 65
 
69 jpm 66
	// +-----------------------------------------------------------------------------------------------------+
16 jpm 67
	public function traiterParametres() {
68
		if (isset($this->parametres) && !empty($this->parametres)) {
69
			$this->table_param = $this->parametres;
70
 
6 jpm 71
		//   masque : filtre la liste en fonction d'un masque de recherche portant sur le code, le nom ou la region.
72
        //   masque.code : filtre uniquement sur le code. masque.nom : filtre uniquement sur le nom.
73
        //   masque.region : filtre uniquement sur la region.
16 jpm 74
			if (isset($this->parametres['recherche']) && $this->parametres['recherche'] != '') {
75
				$this->recherche = $this->parametres['recherche'];
6 jpm 76
			}
16 jpm 77
 
69 jpm 78
			foreach ($this->parametres as $param => $valeur) {
6 jpm 79
				switch ($param) {
69 jpm 80
					case 'masque' :
81
						$this->ajouterLeFiltreMasque('masque', $valeur);
82
						break;
83
					case 'masque.code' :
84
						$this->ajouterLeFiltreMasque('dep', $valeur);
85
						break;
86
					case 'masque.nom' :
87
						$this->ajouterLeFiltreMasque('nccenr', $valeur);
88
						break;
89
					case 'masque.region' :
90
						$this->ajouterLeFiltreMasque('region', $valeur);
91
						break;
92
					case 'retour.format' :
93
						$this->retour_format = $valeur;
94
						break;
95
					case 'navigation.depart' :
96
						$this->limite_requete['depart'] = $valeur;
97
						break;
98
					case 'navigation.limite' :
99
						$this->limite_requete['limite'] = $valeur;
100
						break;
101
					case 'recherche' :
102
						break;
103
					default :
104
						$p = 'Erreur dans les paramètres de recherche de votre requête : '.
105
							'</br> Le paramètre " '.$param.' " n\'existe pas.';
106
							$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $p);
6 jpm 107
				}
108
			}
109
		}
110
	}
16 jpm 111
 
6 jpm 112
	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
113
		if ($nom_champ == 'dep' || $nom_champ == 'region') {
114
			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
115
		} else {
116
			if ($this->recherche == 'floue') {
117
				if ($nom_champ == 'masque') {
118
					$this->requete_condition[] = '( dep = '.$this->getBdd()->proteger($valeur)
119
						.' OR region = '.$this->getBdd()->proteger($valeur)
120
						.' OR ( SOUNDEX(nccenr) = SOUNDEX(\''.$valeur.'\')'
121
						.' OR SOUNDEX(REVERSE(nccenr)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
122
						.')) ';
123
				} else {
124
					$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
125
						.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\'))) ';
126
				}
127
			} else {
128
				if ($this->recherche == 'etendue') {
129
					$valeur = str_replace(' ','%', $valeur);
130
					$valeur .= '%';
131
				}
16 jpm 132
 
6 jpm 133
				if ($nom_champ == 'masque') {
134
					$this->requete_condition[] = ' (dep = '.$this->getBdd()->proteger($valeur)
135
						.' OR nccenr LIKE '.$this->getBdd()->proteger($valeur)
136
						.' OR region = '.$this->getBdd()->proteger($valeur).')';
137
				} else {
138
					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
139
				}
140
			}
16 jpm 141
		}
142
	}
6 jpm 143
 
16 jpm 144
 
69 jpm 145
	//+------------------------------------------------------------------------------------------------------+
16 jpm 146
	public function traiterRessources() {
147
		if (isset($this->ressources) && !empty($this->ressources)) {
148
			$this->table_ressources = $this->ressources;
6 jpm 149
			if (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) {
150
				//requete = /zone-geo/#id
151
				$this->traiterRessourceId();
152
				if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
153
					//dans le cas /zone-geo/#id/#champ ou /zone-geo/#id/relations
154
					$this->traiterRessourceChampOuRelations();
155
				}
156
			}
157
		}
158
	}
16 jpm 159
 
6 jpm 160
	//requete : /zone-geo/#id (ex : /zone-geo/7)
161
	public function traiterRessourceId() {
162
		if (is_numeric($this->table_ressources[0])) {
163
			$this->requete_condition[] = ' dep = '.$this->getBdd()->proteger($this->table_ressources[0]);
164
			$this->format_reponse .= '/id';
165
		} else {
166
			$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->table_ressources[0].
167
				' " n\'existe pas.';
16 jpm 168
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r);
6 jpm 169
		}
170
	}
16 jpm 171
 
172
 
6 jpm 173
	public function traiterRessourceChampOuRelations() {
174
		//requete = /zone-geo/#id/relations :
175
		if ($this->table_ressources[1] == 'relations') {
176
			$this->format_reponse .= '/relations';
177
			$this->requete_condition[] = 'region = (SELECT region FROM '.$this->table.' WHERE '
178
										.implode(' AND ', $this->requete_condition).')';
179
		//requete = /zone-geo/#id/#champ :
180
		} else {
181
			$this->format_reponse .= '/champ';
182
		}
183
	}
16 jpm 184
 
69 jpm 185
	//+------------------------------------------------------------------------------------------------------+
6 jpm 186
	public function assemblerLaRequete() {
187
		//assemblage de la requete :
188
		$requete = ' SELECT '.$this->requete_champ.
189
					' FROM '.$this->table
190
					.$this->formerRequeteCondition()
191
					.$this->formerRequeteLimite();
192
		return $requete;
193
	}
16 jpm 194
 
6 jpm 195
	public  function formerRequeteCondition() {
196
		$condition = '';
16 jpm 197
		if ($this->requete_condition != null) {
6 jpm 198
			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
16 jpm 199
		}
6 jpm 200
		return $condition;
201
	}
16 jpm 202
 
203
 
204
	//ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes
6 jpm 205
	// suivantes : /zone-geo et /zone-geo/#id/relations)
206
	public function formerRequeteLimite() {
207
		if ($this->format_reponse != 'zone-geo' && $this->format_reponse != 'zone-geo/id/relations') {
208
			$this->requete_limite = '';
209
		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
210
			//cas où la requete presente un navigation.depart supérieur au nb total de resultats.
16 jpm 211
			$this->limite_requete['depart'] =
6 jpm 212
				(($nb - $this->limite_requete['limite']) < 0) ? 0 : ($nb - $this->limite_requete['limite']);
213
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
214
		} else {
215
			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
216
		}
217
		return $this->requete_limite;
218
	}
16 jpm 219
 
6 jpm 220
	public function recupererTotalResultat() {
221
		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /zone-geo)
222
		$requete = 'SELECT count(*) as nombre FROM '
223
			.$this->table
224
			.$this->formerRequeteCondition();
225
		$res = $this->getBdd()->recuperer($requete);
16 jpm 226
 
6 jpm 227
		if ($res) {
228
			$total = $res['nombre'];
229
		} else {
230
			$t = 'Fonction recupererTotalResultat() : <br/>Données introuvables dans la base';
231
			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $t);
232
		}
233
		return $total;
234
	}
16 jpm 235
 
69 jpm 236
	//+------------------------------------------------------------------------------------------------------+
16 jpm 237
	// determine en fct du service appelé (/zone-geo | /zone-geo/#id | /zone-geo/#id/champ |
6 jpm 238
	// /zone-geo/#id/relations) le format du tableau à retourner.
239
	public function retournerResultatFormate($resultat) {
240
		$this->recupererTableConfig('correspondance_champs');
241
		switch ($this->format_reponse) {
242
			case 'zone-geo'					: $reponse = $this->formaterZoneGeo($resultat);				break;
243
			case 'zone-geo/id'				: $reponse = $this->formaterZoneGeoId($resultat[0]);		break;
244
			case 'zone-geo/id/champ'		: $reponse = $this->formaterZoneGeoIdChamp($resultat[0]);	break;
245
			case 'zone-geo/id/relations'	: $reponse = $this->formaterZoneGeoIdRelations($resultat);	break;
246
			default							:															break;
247
		}
248
		return $reponse;
249
	}
16 jpm 250
 
6 jpm 251
	public function formaterZoneGeo($resultat) {
252
		//on remplit la table $table_retour_json['entete']
253
		$this->table_retour['depart'] = $this->limite_requete['depart'];
254
		$this->table_retour['limite'] = $this->limite_requete['limite'];
255
		$this->table_retour['total']  = $this->total_resultat;
256
		$url = $this->formulerUrl($this->total_resultat, '/zone-geo');
69 jpm 257
		if (isset($url['precedent']) && $url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
258
		if (isset($url['suivant']) && $url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
6 jpm 259
		$table_retour_json['entete'] = $this->table_retour;
16 jpm 260
 
6 jpm 261
		//on remplit la table $table_retour_json['resultat']
262
		$this->table_retour = array();
263
		if (isset($this->table_param['masque_nom'])) $resultat = $this->trierRechercheFloue($this->table_param['masque_nom'], $resultat, 'nccenr');
264
		foreach ($resultat as $tab) {
265
			foreach ($tab as $key => $valeur) {
266
				if ($valeur != '') {
267
					switch ($key) {
268
						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
269
						case 'nccenr'	: $this->table_retour['nom'] = $valeur;						break;
270
						default			:															break;
271
					}
272
				}
273
			}
274
			if ($this->retour_format == 'max') {
275
				$this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
276
			}
277
			$resultat_json[$num] = $this->table_retour;
278
			$this->table_retour = array();
279
		}
280
		$table_retour_json['resultat'] = $resultat_json;
281
		return $table_retour_json;
282
	}
16 jpm 283
 
6 jpm 284
	public function formaterZoneGeoId($resultat) {
285
		foreach ($resultat as $key => $valeur) {
286
			if ($valeur != '') {
287
				$this->afficherDonnees($key, $valeur);
288
			}
289
		}
290
		unset($this->table_retour['href']);
291
		return $this->table_retour;
292
	}
16 jpm 293
 
6 jpm 294
	public function formaterZoneGeoIdRelations($resultat) {
295
		if ($resultat == '') {
296
			$retour = null;
297
		} else {
298
			//on remplit la table $table_retour_json['entete']
299
			$this->table_retour['depart'] = $this->limite_requete['depart'];
300
			$this->table_retour['limite'] = $this->limite_requete['limite'];
301
			$this->table_retour['total']  = $this->total_resultat;
302
			//formuler les urls
303
			$url = $this->formulerUrl(count($resultat), '/zone-geo');
304
			if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
305
			if ($url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
306
			$retour['entete'] = $this->table_retour;
307
			$this->table_retour = array();
16 jpm 308
 
6 jpm 309
			//on remplit la table $table_retour_json['resultat']
310
			foreach ($resultat as $tab) {
311
				foreach ($tab as $key => $valeur) {
312
					switch ($key) {
313
						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
314
						case 'nccenr'	: $this->table_retour['nom'] = $valeur;						break;
315
						default			:					 										break;
316
					}
317
				}
318
				if ($this->retour_format == 'max') $this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
319
				$resultat_json[$num] = $this->table_retour;
320
				$this->table_retour = array();
321
			}
16 jpm 322
			$retour['resultat'] = $resultat_json;
6 jpm 323
		}
324
		return $retour;
325
	}
16 jpm 326
 
6 jpm 327
	public function formaterZoneGeoIdChamp($resultat) {
328
		//on recupère tous les resultats possibles
329
		$reponse = $this->formaterZoneGeoId($resultat);
330
		$this->table_retour = array();
331
		//on recupère les résultats demandés à partir du tableau de résultat complet
332
		$this->table_retour['id'] = $reponse['code'];
333
		$champs = explode(' ', $this->table_ressources[1]);
16 jpm 334
 
6 jpm 335
		foreach ($champs as $champ) {
336
			if ($this->verifierValiditeChamp($champ)) {
337
				if (strrpos($champ, '.*') !== false) {
338
					$this->afficherPointEtoile($champ, $reponse);
16 jpm 339
 
6 jpm 340
				} else {
341
					if (isset($reponse[$champ])) {
342
						$this->table_retour[$champ] = $reponse[$champ];
343
					} else {
344
						$this->table_retour[$champ] = null;
345
					}
346
				}
347
			}
348
		}
349
		return $this->table_retour;
350
	}
16 jpm 351
 
6 jpm 352
	public function verifierValiditeChamp($champ) {
353
		preg_match('/^([^.]+)(\.([^.]+))?$/', $champ, $match);
354
		$champs_possibles = $this->correspondance_champs;
355
		$champs_possibles[] = 'nom.*';
16 jpm 356
 
6 jpm 357
		if (in_array($match[1], $champs_possibles)) {
358
			$validite = true;
359
		} elseif (in_array($match[0], $champs_possibles)) {
360
			$validite = true;
361
		} else {
362
			$champs_possibles = implode('</li><li>', $champs_possibles);
363
			$c = 'Erreur dans votre requête : </br> Le champ "'.$champ_possibles.'" n\'existe pas. '.
364
				'Les champs disponibles sont : <li>'.$champs_possibles.'</li>';
365
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $c);
366
		}
367
		return $validite;
368
	}
16 jpm 369
 
6 jpm 370
	public function afficherPointEtoile($champ, $reponse) {
371
		preg_match('/^([^.]+\.)\*$/', $champ, $match);
372
		foreach ($reponse as $chp => $valeur) {
373
			if (strrpos($chp, $match[1]) !== false) {
374
				if ($valeur != '') {
375
					$this->table_retour[$chp] = $valeur;
376
				} else {
377
					$this->table_retour[$chp] = null;
378
				}
379
			}
380
		}
16 jpm 381
	}
382
 
6 jpm 383
	public function afficherDonnees($champ, $valeur) {
384
		if ($this->retour_format == 'max') {
385
			if ($champ == 'region' || $champ == 'chef_lieu') {
386
				$projet = 'insee-'.substr($champ, 0, 1);
387
				$this->table_retour[$champ.'.code'] = $valeur;
388
				$this->table_retour[$champ.'.href'] = $this->ajouterHrefAutreProjet('zone-geo', '', $valeur, $projet);
389
			} elseif ($champ == 'tncc') {
390
				$url = $this->ajouterHref('ontologies', $valeur);
391
				$res = $this->consulterHref($url);
392
				$this->table_retour['type_nom'] = $res->nom;
393
				$this->table_retour['type_nom.code'] = $valeur;
394
				$this->table_retour['type_nom.href'] = $url;
395
			} else {
396
				$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
397
			}
398
		} else {
399
			$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
400
		}
401
	}
16 jpm 402
 
6 jpm 403
}
404
 
405
?>