WebSVN – eFlore/Projets.eflore-projets – Diff – /trunk/services/modules/0.1/insee-d/ZoneGeo.php

 <?php
 /**
 * Description :
 * Classe ZoneGeo.php fournit des informations sur ensemble structuré des termes et concepts représentant les éléments
 * d'un domaine de connaissances .
 * Le but étant de fournir un ensemble minimal d'information comprenant :
 * un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une region et
 * éventuellement une relation hiérarchique avec un autre terme (=classe).
 * Si l'url finit par /zone-geo on retourne une liste de termes (seulement les 100 premières par défaut).
 * L'url peut contenir des paramètres optionnels passés après le ? : /observations?param1=val1&param2=val2&...
 *
 * Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.region , recherche,
 * distinct, retour.format, navigation.depart et navigation.limite.
 *
 * Encodage en entrée : utf8
 * Encodage en sortie : utf8
 * @package framework-v3
 * @author Delphine Cauquil <delphine@tela-botanica.org>
 * @author Jennifer Dhé <jennifer.dhe@tela-botanica.org>
 * @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
 * @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
 * @version 1.0
 * @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org)
 */
 class ZoneGeo extends Commun {
 	protected $service = 'zone-geo';
 	/**
 	 * Permet de stocker la requete formulée : /zone-geo | /zone-geo/#id | /zone-geo/#id/champ | /zone-geo/#id/relations
 	 * Est remplit au cours de l'analyse des ressources (traiterRessources()), par défaut, a la valeur du service.
 	 * Est utilisée principalement pr déterminer le format du tableau à retourner.	 */
 	protected $format_reponse = 'zone-geo';
 	/** Variables constituant les parametres de la requete SQL (champ, condition, group by, limit) remplie
 	 * selon ressources et paramètres	 */
 	protected $requete_champ = ' * ';
 	protected $requete_condition = '';
 	protected $limite_requete = array(
 		'depart' => 0,
 		'limite' => 100
 	);
 	/** Stockage des ressources et paramétres */
 	protected $table_ressources = array();
 	protected $table_param = array();
 	/**
 	 * Precise la contenance plus ou moins précise du tableau à retourner :
 	 *  - min = les données présentes dans la table
 	 *  - max = les données de la table + les informations complémentaires (pour les identifiants et les codes)
 	 *  - oss = la liste des nom_sci (uniquement pour noms et taxons)
 	 */
 	protected $retour_format = 'max';
 	/** Valeur du paramètre de requete recherche :
 	 *  - stricte : le masque est passé tel quel à l'opérateur LIKE.
 	 *  - etendue : ajout automatique du signe % à la place des espaces et en fin de masque avec utilisation de LIKE.
 	 *  - floue : recherche tolérante vis-à-vis d'approximations ou d'erreurs (fautes d'orthographe par exemple) */
 	protected $recherche;
 	/** Permet de stocker le tableau de résultat (non encodé en json) */
 	protected $table_retour = array();
 	/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
-	protected $total_resultat;
-// +-------------------------------------------------------------------------------------------------------------------+
-	public function consulter($ressources, $parametres) {
-		$this->traiterParametres($parametres);
-		$this->traiterVersionProjet($ressources);
-		$this->traiterRessources($ressources);
-		$resultat_formate = '';
-		if ($this->corps_http == '' && $this->entete_http == '') {
-			foreach ($this->table_version as $version) {
-				$this->table = $version; //on stocke le nom de la table correspondant à la version du projet en cours
-				$requete = $this->assemblerLaRequete(); //print_r($requete);
-				$resultat = $this->getBdd()->recupererTous($requete);
-				$res_version = $this->testerResultat($resultat, $requete);
-			}
-			if ($this->corps_http == '' && $this->entete_http == '') {
-				if (isset($res_version)) {
-					$resultat_formate = json_encode($res_version);
-				}
-			}
-		}
-		$this->formerReponseHTTP($resultat_formate);
-	}
-	public function testerResultat($resultat, $requete) {
-		if ($resultat == '') { //cas ou la requete comporte des erreurs
-			$s = 'La requête SQL formée comporte une erreur !!';
-			Debug::printr($requete);
-			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $s);
-		} elseif ($resultat) {
-			if (count($this->table_version) > 1) {
-				$res_version[$version] = $this->retournerResultatFormate($resultat);
-			} else {
-				$res_version = $this->retournerResultatFormate($resultat);
-			}
-		} else {
-			if ($this->format_reponse == 'zone-geo/id/relations') {
-				//si aucune relation n'existe, la valeur null est retournée
-				$res_version = null;
-			} else {
-				$d = 'Données recherchées introuvables dans la base';
-				$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $d);
-				Debug::printr($requete);
-			}
-		}
-		return $res_version;
-	}
+	protected $total_resultat;
 // +-------------------------------------------------------------------------------------------------------------------+
-	public function traiterParametres($parametres) {
+	public function traiterParametres() {
-		if (isset($parametres) && !empty($parametres)) {
+		if (isset($this->parametres) && !empty($this->parametres)) {
-			$this->table_param = $parametres;
+			$this->table_param = $this->parametres;
 		//   masque : filtre la liste en fonction d'un masque de recherche portant sur le code, le nom ou la region.
         //   masque.code : filtre uniquement sur le code. masque.nom : filtre uniquement sur le nom.
         //   masque.region : filtre uniquement sur la region.
-			if (isset($parametres['recherche']) && $parametres['recherche'] != '') {
+			if (isset($this->parametres['recherche']) && $this->parametres['recherche'] != '') {
-				$this->recherche = $parametres['recherche'];
+				$this->recherche = $this->parametres['recherche'];
 			}
 			foreach ($parametres as $param => $valeur) {
 				switch ($param) {
 					case 'masque'				: $this->ajouterLeFiltreMasque('masque', $valeur);			break;
-					case 'masque_code'			: $this->ajouterLeFiltreMasque('dep', $valeur);				break;
+					case 'masque.code'			: $this->ajouterLeFiltreMasque('dep', $valeur);				break;
-					case 'masque_nom'			: $this->ajouterLeFiltreMasque('nccenr', $valeur);			break;
+					case 'masque.nom'			: $this->ajouterLeFiltreMasque('nccenr', $valeur);			break;
-					case 'masque_region'		: $this->ajouterLeFiltreMasque('region', $valeur);			break;
+					case 'masque.region'		: $this->ajouterLeFiltreMasque('region', $valeur);			break;
-					case 'retour_format'		: $this->retour_format = $valeur;							break;
+					case 'retour.format'		: $this->retour_format = $valeur;							break;
-					case 'navigation_depart'	: $this->limite_requete['depart'] = $valeur;				break;
+					case 'navigation.depart'	: $this->limite_requete['depart'] = $valeur;				break;
-					case 'navigation_limite'	: $this->limite_requete['limite'] = $valeur;				break;
+					case 'navigation.limite'	: $this->limite_requete['limite'] = $valeur;				break;
 					case 'recherche'			:															break;
 					default						:  $p = 'Erreur dans les paramètres de recherche de votre requête : '.
 													'</br> Le paramètre " '.$param.' " n\'existe pas.';
 												$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $p);	break;
+				}
+			}
+		}
 	}
 	public function ajouterLeFiltreMasque($nom_champ, $valeur) {
 		if ($nom_champ == 'dep' || $nom_champ == 'region') {
 			$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
 		} else {
 			} else {
 				if ($this->recherche == 'etendue') {
 					$valeur = str_replace(' ','%', $valeur);
 					$valeur .= '%';
+				}
 				if ($nom_champ == 'masque') {
 					$this->requete_condition[] = ' (dep = '.$this->getBdd()->proteger($valeur)
 						.' OR nccenr LIKE '.$this->getBdd()->proteger($valeur)
 						.' OR region = '.$this->getBdd()->proteger($valeur).')';
 				} else {
 					$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
+				}
+			}
 		}
 	}
 // +-------------------------------------------------------------------------------------------------------------------+
-	public function traiterRessources(&$ressources) {
+	public function traiterRessources() {
-		if (isset($ressources) && !empty($ressources)) {
+		if (isset($this->ressources) && !empty($this->ressources)) {
-			$this->table_ressources = $ressources;
+			$this->table_ressources = $this->ressources;
 			if (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) {
 				//requete = /zone-geo/#id
 				$this->traiterRessourceId();
 				if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
 					//dans le cas /zone-geo/#id/#champ ou /zone-geo/#id/relations
 					$this->traiterRessourceChampOuRelations();
+				}
+			}
+		}
+	}
 	//requete : /zone-geo/#id (ex : /zone-geo/7)
 	public function traiterRessourceId() {
 		if (is_numeric($this->table_ressources[0])) {
 			$this->requete_condition[] = ' dep = '.$this->getBdd()->proteger($this->table_ressources[0]);
 			$this->format_reponse .= '/id';
 		} else {
 			$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->table_ressources[0].
 				' " n\'existe pas.';
 			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r);
+		}
+	}
 	public function traiterRessourceChampOuRelations() {
 		//requete = /zone-geo/#id/relations :
 		if ($this->table_ressources[1] == 'relations') {
 			$this->format_reponse .= '/relations';
 			$this->requete_condition[] = 'region = (SELECT region FROM '.$this->table.' WHERE '
 		//requete = /zone-geo/#id/#champ :
 		} else {
 			$this->format_reponse .= '/champ';
+		}
+	}
 // +-------------------------------------------------------------------------------------------------------------------+
 	public function assemblerLaRequete() {
 		//assemblage de la requete :
 		$requete = ' SELECT '.$this->requete_champ.
 					' FROM '.$this->table
 					.$this->formerRequeteCondition()
 					.$this->formerRequeteLimite();
 		return $requete;
+	}
 	public  function formerRequeteCondition() {
 		$condition = '';
 		if ($this->requete_condition != null) {
 			$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
 		}
 		return $condition;
+	}
 	//ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes
 	// suivantes : /zone-geo et /zone-geo/#id/relations)
 	public function formerRequeteLimite() {
 		if ($this->format_reponse != 'zone-geo' && $this->format_reponse != 'zone-geo/id/relations') {
 			$this->requete_limite = '';
 		} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
 			//cas où la requete presente un navigation.depart supérieur au nb total de resultats.
 			$this->limite_requete['depart'] =
 				(($nb - $this->limite_requete['limite']) < 0) ? 0 : ($nb - $this->limite_requete['limite']);
 			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
 		} else {
 			$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
+		}
 		return $this->requete_limite;
+	}
 	public function recupererTotalResultat() {
 		//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /zone-geo)
 		$requete = 'SELECT count(*) as nombre FROM '
 			.$this->table
 			.$this->formerRequeteCondition();
 		$res = $this->getBdd()->recuperer($requete);
 		if ($res) {
 			$total = $res['nombre'];
 		} else {
 			$t = 'Fonction recupererTotalResultat() : <br/>Données introuvables dans la base';
 			$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $t);
+		}
 		return $total;
+	}
 // +-------------------------------------------------------------------------------------------------------------------+
 	// determine en fct du service appelé (/zone-geo | /zone-geo/#id | /zone-geo/#id/champ |
 	// /zone-geo/#id/relations) le format du tableau à retourner.
 	public function retournerResultatFormate($resultat) {
 		$this->recupererTableConfig('correspondance_champs');
 		switch ($this->format_reponse) {
 			case 'zone-geo'					: $reponse = $this->formaterZoneGeo($resultat);				break;
 			case 'zone-geo/id/relations'	: $reponse = $this->formaterZoneGeoIdRelations($resultat);	break;
 			default							:															break;
+		}
 		return $reponse;
+	}
 	public function formaterZoneGeo($resultat) {
 		//on remplit la table $table_retour_json['entete']
 		$this->table_retour['depart'] = $this->limite_requete['depart'];
 		$this->table_retour['limite'] = $this->limite_requete['limite'];
 		$this->table_retour['total']  = $this->total_resultat;
 		$url = $this->formulerUrl($this->total_resultat, '/zone-geo');
 		if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
 		if ($url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
 		$table_retour_json['entete'] = $this->table_retour;
 		//on remplit la table $table_retour_json['resultat']
 		$this->table_retour = array();
 		if (isset($this->table_param['masque_nom'])) $resultat = $this->trierRechercheFloue($this->table_param['masque_nom'], $resultat, 'nccenr');
 		foreach ($resultat as $tab) {
 			foreach ($tab as $key => $valeur) {
 			$this->table_retour = array();
+		}
 		$table_retour_json['resultat'] = $resultat_json;
 		return $table_retour_json;
+	}
 	public function formaterZoneGeoId($resultat) {
 		foreach ($resultat as $key => $valeur) {
 			if ($valeur != '') {
 				$this->afficherDonnees($key, $valeur);
+			}
+		}
 		unset($this->table_retour['href']);
 		return $this->table_retour;
+	}
 	public function formaterZoneGeoIdRelations($resultat) {
 		if ($resultat == '') {
 			$retour = null;
 		} else {
 			//on remplit la table $table_retour_json['entete']
 			$url = $this->formulerUrl(count($resultat), '/zone-geo');
 			if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
 			if ($url['suivant']   != '') { $this->table_retour['href.suivant']   = $url['suivant']; }
 			$retour['entete'] = $this->table_retour;
 			$this->table_retour = array();
 			//on remplit la table $table_retour_json['resultat']
 			foreach ($resultat as $tab) {
 				foreach ($tab as $key => $valeur) {
 					switch ($key) {
 						case 'dep'		: $num = $valeur; $this->table_retour['code'] = $valeur;	break;
+				}
 				if ($this->retour_format == 'max') $this->table_retour['href'] = $this->ajouterHref('zone-geo', $num);
 				$resultat_json[$num] = $this->table_retour;
 				$this->table_retour = array();
+			}
 			$retour['resultat'] = $resultat_json;
+		}
 		return $retour;
+	}
 	public function formaterZoneGeoIdChamp($resultat) {
 		//on recupère tous les resultats possibles
 		$reponse = $this->formaterZoneGeoId($resultat);
 		$this->table_retour = array();
 		//on recupère les résultats demandés à partir du tableau de résultat complet
 		$this->table_retour['id'] = $reponse['code'];
 		$champs = explode(' ', $this->table_ressources[1]);
 		foreach ($champs as $champ) {
 			if ($this->verifierValiditeChamp($champ)) {
 				if (strrpos($champ, '.*') !== false) {
 					$this->afficherPointEtoile($champ, $reponse);
 				} else {
 					if (isset($reponse[$champ])) {
 						$this->table_retour[$champ] = $reponse[$champ];
 					} else {
 						$this->table_retour[$champ] = null;
+				}
+			}
+		}
 		return $this->table_retour;
+	}
 	public function verifierValiditeChamp($champ) {
 		preg_match('/^([^.]+)(\.([^.]+))?$/', $champ, $match);
 		$champs_possibles = $this->correspondance_champs;
 		$champs_possibles[] = 'nom.*';
 		if (in_array($match[1], $champs_possibles)) {
 			$validite = true;
 		} elseif (in_array($match[0], $champs_possibles)) {
 			$validite = true;
 		} else {
 				'Les champs disponibles sont : <li>'.$champs_possibles.'</li>';
 			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $c);
+		}
 		return $validite;
+	}
 	public function afficherPointEtoile($champ, $reponse) {
 		preg_match('/^([^.]+\.)\*$/', $champ, $match);
 		foreach ($reponse as $chp => $valeur) {
 			if (strrpos($chp, $match[1]) !== false) {
 				if ($valeur != '') {
 				} else {
 					$this->table_retour[$chp] = null;
+				}
+			}
+		}
 	}
 	public function afficherDonnees($champ, $valeur) {
 		if ($this->retour_format == 'max') {
 			if ($champ == 'region' || $champ == 'chef_lieu') {
 				$projet = 'insee-'.substr($champ, 0, 1);
 				$this->table_retour[$champ.'.code'] = $valeur;
+			}
 		} else {
 			$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
+		}
+	}
+}
 ?>

Subversion Repositories eFlore/Projets.eflore-projets

(root)/trunk/services/modules/0.1/insee-d/ZoneGeo.php @ 69 – Rev 6 → 16