Subversion Repositories eFlore/Projets.eflore-projets

Rev

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