Subversion Repositories eFlore/Projets.eflore-projets

Rev

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