Subversion Repositories eFlore/Projets.eflore-projets

Compare Revisions

Ignore whitespace Rev 6 → Rev 15

/trunk/services/modules/0.1/iso-3166-1/ZoneGeo.php
2,19 → 2,19
/**
* Description :
* Classe ZoneGeo.php fournit des informations sur un ensemble de lieux à une échelle donnée.
* 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
* 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 zones (seulement les 100 premières par défaut).
* L'url peut contenir des paramètres optionnels passés après le ? : /zone-geo?param1=val1&param2=val2&...
*
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.region , recherche,
*
* 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 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>
23,117 → 23,91
*/
 
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 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
 
/** 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(
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
* 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)
* - 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.
/** 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);
 
// +-----------------------------------------------------------------------------------------------------+
public function traiterParametres() {
if (isset($this->parametres) && !empty($this->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($this->parametres['recherche']) && $this->parametres['recherche'] != '') {
$this->recherche = $this->parametres['recherche'];
}
if ($this->corps_http == '' && $this->entete_http == '') {
if (isset($res_version)) {
$resultat_formate = json_encode($res_version);
}
}
}
return $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 {
$d = 'Données recherchées introuvables dans la base';
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $d);
Debug::printr($requete);
}
return $res_version;
}
// +-------------------------------------------------------------------------------------------------------------------+
public function traiterParametres($parametres) {
if (isset($parametres) && !empty($parametres)) {
$this->table_param = $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'] != '') {
$this->recherche = $parametres['recherche'];
}
foreach ($parametres as $param => $valeur) {
 
foreach ($this->parametres as $param => $valeur) {
switch ($param) {
case 'masque' : $this->ajouterLeFiltreMasque('masque', $valeur); break;
case 'masque_code' : $this->ajouterLeFiltreMasque('codet', $valeur); break;
case 'masque_nom' : $this->ajouterLeFiltreMasque('nom', $valeur); break;
case 'masque_statut' : $this->ajouterLeFiltreMasque('codet_statut', $valeur); break;
case 'retour_format' : $this->retour_format = $valeur; break;
case 'navigation_depart' : $this->limite_requete['depart'] = $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;
case 'masque' :
$this->ajouterLeFiltreMasque('masque', $valeur);
break;
case 'masque.code' :
$this->ajouterLeFiltreMasque('codet', $valeur);
break;
case 'masque.nom' :
$this->ajouterLeFiltreMasque('nom', $valeur);
break;
case 'masque.statut' :
$this->ajouterLeFiltreMasque('codet_statut', $valeur);
break;
case 'retour.format' :
$this->retour_format = $valeur;
break;
case 'navigation.depart' :
$this->limite_requete['depart'] = $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 == 'codet') {
$this->requete_condition[] .= $nom_champ.' = '.$this->getBdd()->proteger($valeur);
150,7 → 124,7
.')) ';
} elseif ($nom_champ == 'nom') {
$this->requete_condition[] = '(SOUNDEX(nom_francais) = SOUNDEX(\''.$valeur.'\')'
.' OR SOUNDEX(REVERSE(nom_francais)) = SOUNDEX(REVERSE(\''.$valeur.'\'))) OR
.' OR SOUNDEX(REVERSE(nom_francais)) = SOUNDEX(REVERSE(\''.$valeur.'\'))) OR
(SOUNDEX(nom_anglais) = SOUNDEX(\''.$valeur.'\')'
.' OR SOUNDEX(REVERSE(nom_anglais)) = SOUNDEX(REVERSE(\''.$valeur.'\'))) ';
} else {
162,7 → 136,7
$valeur = str_replace(' ','%', $valeur);
$valeur .= '%';
}
 
if ($nom_champ == 'masque') {
$this->requete_condition[] = '(codet = '.$this->getBdd()->proteger($valeur)
.' OR nom_francais LIKE '.$this->getBdd()->proteger($valeur)
177,11 → 151,11
}
}
}
// +-------------------------------------------------------------------------------------------------------------------+
public function traiterRessources(&$ressources) {
if (isset($ressources) && !empty($ressources)) {
$this->table_ressources = $ressources;
 
// +-----------------------------------------------------------------------------------------------------+
public function traiterRessources() {
if (isset($this->ressources) && !empty($this->ressources)) {
$this->table_ressources = $this->ressources;
if (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) {
//requete = /zone-geo/#id
$this->traiterRessourceId();
192,7 → 166,7
}
}
}
 
public function traiterRessourceId() {
//requete : /zone-geo/#id (ex : /zone-geo/7)
if ($this->table_ressources[0]) {
201,11 → 175,11
} 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);
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r);
}
}
 
 
public function traiterRessourceChampOuRelations() {
if ($this->table_ressources[1] == 'relations') {
$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->table_ressources[1].
215,10 → 189,10
$this->format_reponse .= '/champ';
}
}
// +-------------------------------------------------------------------------------------------------------------------+
 
// +-------------------------------------------------------------------------------------------------------------------+
public function assemblerLaRequete() {
//assemblage de la requete :
//assemblage de la requete :
$requete = ' SELECT '.$this->requete_champ.
' FROM '.$this->table
.$this->formerRequeteCondition()
225,15 → 199,15
.$this->formerRequeteLimite();
return $requete;
}
//ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes
 
//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->requete_limite = '';
$this->requete_limite = '';
} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
//cas ou la requete presente un navigation.depart supérieur au nb total de resultats.
$this->limite_requete['depart'] =
//cas ou 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 {
241,15 → 215,15
}
return $this->requete_limite;
}
 
public function formerRequeteCondition() {
$condition = '';
if ($this->requete_condition != null) {
if ($this->requete_condition != null) {
$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
}
}
return $condition;
}
 
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 '
256,7 → 230,7
.$this->table
.$this->formerRequeteCondition();
$res = $this->getBdd()->recuperer($requete);
 
if ($res) {
$total = $res['nombre'];
} else {
265,9 → 239,9
}
return $total;
}
// +-------------------------------------------------------------------------------------------------------------------+
// determine en fct du service appelé (/zone-geo | /zone-geo/#id | /zone-geo/#id/champ |
 
// +-------------------------------------------------------------------------------------------------------------------+
// determine en fct du service appelé (/zone-geo | /zone-geo/#id | /zone-geo/#id/champ |
// /zone-geo/#id/relations) le format du tableau à retourner. Encode en json
public function retournerResultatFormate($resultat) {
$this->recupererTableConfig('correspondance_champs');
279,7 → 253,7
}
return $reponse;
}
 
public function formaterZoneGeo($resultat) {
//on remplit la table $table_retour_json['entete']
$this->table_retour['depart'] = $this->limite_requete['depart'];
286,10 → 260,14
$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']; }
if (isset($url['precedent']) && $url['precedent'] != '') {
$this->table_retour['href.precedent'] = $url['precedent'];
}
if (isset($url['suivant']) && $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, 'nom_francais');
315,17 → 293,17
$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 formaterZoneGeoIdChamp($resultat) {
//on recupère tous les resultats possibles
$reponse = $this->formaterZoneGeoId($resultat);
350,12 → 328,12
}
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)) {
368,7 → 346,7
}
return $validite;
}
 
public function afficherPointEtoile($champ, $reponse) {
preg_match('/^([^.]+\.)\*$/', $champ, $match);
foreach ($reponse as $chp => $valeur) {
381,12 → 359,12
}
}
}
 
public function afficherDonnees($champ, $valeur) {
if ($this->retour_format == 'max') {
if ($champ == 'codet_statut') {
$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
$this->table_retour[$this->correspondance_champs[$champ].'.href'] =
$this->table_retour[$this->correspondance_champs[$champ].'.href'] =
$this->ajouterHref('ontologies', 'masque.nom=Codet '.$valeur, '?');
} else {
$this->table_retour[$this->correspondance_champs[$champ]] = $valeur;
398,10 → 376,10
 
// +-------------------------------------------------------------------------------------------------------------------+
/** Permet de retourner l'url http://tela-botanica.org/service:eflore:0.1/[projet]/[version_projet]/[service]/[ressource]:[valeur]
* @param $service : correspond au nom de la ressource à laquelle on souhaite acceder
* @param $val : correspond au paramètre de la ressource (ex :
* @param $service : correspond au nom de la ressource à laquelle on souhaite acceder
* @param $val : correspond au paramètre de la ressource (ex :
* @param $projet : est remplit dans les cas suivants :
* - si le projet dans lequel se trouve l'information est différent de celui du service appelé
* - si le projet dans lequel se trouve l'information est différent de celui du service appelé
* - si on souhaite rappeler le meme projet avec la meme ressource mais un parametre de ressource différent
*/
public function ajouterHref($service, $val, $separation = '/') {
413,7 → 391,7
}
return $url;
}
 
public function encoderUrl($url) {
$url = str_replace(' ', '%20', $url);
$url = str_replace('?', urlencode('?'), $url);