2,19 → 2,19 |
/** |
* Description : |
* Classe NomsVernaculaires.php fournit une liste de noms vernaculaires et leur liaison à la bdtfx |
* 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 langue 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 langue et |
* une relation avec un taxon de la bdtfx. |
* Si l'url finit par /noms-vernaculaires on retourne une liste de noms (seulement les 100 premières par défaut). |
* L'url peut contenir des paramètres optionnels passés après le ? : /observations?param1=val1¶m2=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> |
21,127 → 21,92 |
* @version 1.0 |
* @copyright 1999-${year} Tela Botanica (accueil@tela-botanica.org) |
*/ |
|
class NomsVernaculaires extends Commun { |
protected $champ_infos = array( |
'taxon' => array('service' => 'taxons', 'ressource' => 'nt:', 'projet' => 'bdtfx', 'nom' => 'nom_sci'), |
'conseil_emploi' => array('service' => 'ontologies', 'ressource' => 'numStatut:', 'projet' => 'nvjfl', 'nom' => 'nom'), |
'genre' => array('service' => 'ontologies', 'ressource' => 'genreNombre:', 'projet' => 'nvjfl', 'nom' => 'nom')); |
|
|
protected $service = 'noms-vernaculaires'; |
|
|
/** |
* Permet de stocker la requete formulée : /noms-vernaculaires | /noms-vernaculaires/#id | |
* /noms-vernaculaires/#id/champ | /noms-vernaculaires/#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 = 'noms-vernaculaires'; |
|
/** Variables constituant les parametres de la requete SQL (champ, condition, limit) remplie |
protected $format_reponse = 'noms-vernaculaires'; |
|
/** Variables constituant les parametres de la requete SQL (champ, condition, limit) remplie |
* selon ressources et paramètres */ |
protected $requete_champ = array(' * '); |
protected $requete_condition = ''; |
protected $limite_requete = array( |
'depart' => 0, |
'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) */ |
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; |
|
// +-------------------------------------------------------------------------------------------------------------------+ |
// fonction principale qui permet de construire la requête à partir de l'analyse des paramétres et ressources |
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); |
} |
} |
} |
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 { |
if ($this->format_reponse == 'noms-vernaculaires/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; |
} |
|
// +-------------------------------------------------------------------------------------------------------------------+ |
|
//+------------------------------------------------------------------------------------------------------+ |
// créer une condition en fonction du paramétre |
public function traiterParametres($parametres) { |
if (isset($parametres) && !empty($parametres)) { |
$this->table_param = $parametres; |
|
if (isset($parametres['recherche']) && $parametres['recherche'] != '') { |
$this->recherche = $parametres['recherche']; |
public function traiterParametres() { |
if (isset($this->parametres) && !empty($this->parametres)) { |
|
if (isset($this->parametres['recherche']) && $this->parametres['recherche'] != '') { |
$this->recherche = $this->parametres['recherche']; |
} |
foreach ($parametres as $param => $valeur) { |
foreach ($this->parametres as $param => $valeur) { |
switch ($param) { |
case 'masque' : $this->ajouterLeFiltreMasque('nom_vernaculaire', $valeur);break; |
case 'masque_nt' : $this->ajouterLeFiltreMasque('num_taxon', $valeur); break; |
case 'masque_nv' : $this->ajouterLeFiltreMasque('nom_vernaculaire', $valeur);break; |
case 'masque_lg' : $this->ajouterLeFiltreMasque('code_langue', $valeur); break; |
case 'masque_cce' : $this->ajouterLeFiltreMasque('num_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('nom_vernaculaire', $valeur); |
break; |
case 'masque.nt' : |
$this->ajouterLeFiltreMasque('num_taxon', $valeur); |
break; |
case 'masque.nv' : |
$this->ajouterLeFiltreMasque('nom_vernaculaire', $valeur); |
break; |
case 'masque.lg' : |
$this->ajouterLeFiltreMasque('code_langue', $valeur); |
break; |
case 'masque.cce' : |
$this->ajouterLeFiltreMasque('num_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); |
} |
} |
} |
} |
|
|
public function ajouterLeFiltreMasque($nom_champ, $valeur) { |
if ($nom_champ == 'num_taxon') { // si il s'agit d'un chiffre |
$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur); |
158,16 → 123,14 |
} |
} |
} |
|
|
// +-------------------------------------------------------------------------------------------------------------------+ |
//+------------------------------------------------------------------------------------------------------+ |
// en fonction de la présence des ressources modifie requete_champ et requete_condition |
public function traiterRessources(&$ressources) { |
if (isset($ressources) && !empty($ressources)) { |
$this->table_ressources = $ressources; |
if (isset($this->table_ressources[0]) && !empty($this->table_ressources[0])) { |
public function traiterRessources() { |
if (isset($this->ressources) && !empty($this->ressources)) { |
if (isset($this->ressources[0]) && !empty($this->ressources[0])) { |
$this->traiterRessourceId(); // ajoute condition id=#valeur |
if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) { |
if (isset($this->ressources[1]) && !empty($this->ressources[1])) { |
$this->traiterRessourceChampOuRelations(); //modifie requete_champ ou requete_condition |
} |
} |
175,23 → 138,23 |
$this->requete_champ = array('distinct(id)', 'nom_vernaculaire '); |
} |
} |
|
|
//requete : /noms-vernaculaires/#id (ex : /noms-vernaculaires/7) |
public function traiterRessourceId() { |
if (is_numeric($this->table_ressources[0])) { |
$this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->table_ressources[0]); |
if (is_numeric($this->ressources[0])) { |
$this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->ressources[0]); |
$this->format_reponse .= '/id'; |
} else { |
$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->table_ressources[0]. |
$r = 'Erreur dans les ressources de votre requête : </br> La ressource " '.$this->ressources[0]. |
' " n\'existe pas.'; |
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r); |
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $r); |
} |
} |
|
|
|
|
public function traiterRessourceChampOuRelations() { |
//requete = /noms-vernaculaires/#id/relations : |
if ($this->table_ressources[1] == 'relations') { |
if ($this->ressources[1] == 'relations') { |
$this->format_reponse .= '/relations'; |
$this->requete_condition[] = 'num_taxon = (SELECT region FROM '.$this->table.' WHERE ' |
.implode(' AND ', $this->requete_condition).')'; |
201,11 → 164,11 |
$this->analyserChamp(); |
} |
} |
|
|
public function analyserChamp() { |
$this->requete_champ = array(); |
$this->recupererTableConfig('champs_possibles');// s'il y a plusieurs champs correspondant au champ demandé ils sont séparé par des | |
$champs = explode(' ', $this->table_ressources[1]); |
$champs = explode(' ', $this->ressources[1]); |
foreach ($champs as $champ) { |
preg_match('/^([^.]+)(\.([^.]+))?$/', $champ, $match); |
if (isset($this->champs_possibles[$match[1]])) { |
220,8 → 183,8 |
} |
} |
} |
|
// +-------------------------------------------------------------------------------------------------------------------+ |
|
//+------------------------------------------------------------------------------------------------------+ |
public function assemblerLaRequete() { |
$requete = ' SELECT '.$this->formerRequeteChamp(). |
' FROM '.$this->table |
229,7 → 192,7 |
.$this->formerRequeteLimite(); |
return $requete; |
} |
|
|
public function formerRequeteChamp() { |
if (in_array('*', $this->requete_champ)) { |
$champ = ' * '; |
238,30 → 201,30 |
} |
return $champ; |
} |
|
|
public function formerRequeteCondition() { |
$condition = ''; |
if ($this->requete_condition != null) { |
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 |
|
//ajout d'une limite seulement pour les listes (pas plus de 100 resultats retournés pr les requetes |
// suivantes : /noms-vernaculaires et /noms-vernaculaires/#id/relations) |
public function formerRequeteLimite() { |
if (in_array($this->format_reponse , array($this->service.'/id', $this->service.'/id/champs'))) { |
$this->requete_limite = ''; |
$this->requete_limite = ''; |
} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) { |
$this->limite_requete['depart'] = |
$this->limite_requete['depart'] = |
(($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']); |
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$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']; |
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite']; |
} |
return $this->requete_limite; |
} |
|
|
//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /noms-vernaculaires) |
public function recupererTotalResultat() { |
$requete = 'SELECT count(distinct(id)) as nombre FROM ' |
268,7 → 231,7 |
.$this->table |
.$this->formerRequeteCondition(); |
$res = $this->getBdd()->recuperer($requete); |
|
|
if ($res) { |
$total = $res['nombre']; |
} else { |
277,9 → 240,9 |
} |
return $total; |
} |
|
// +-------------------------------------------------------------------------------------------------------------------+ |
// determine en fct du service appelé (/noms-vernaculaires | /noms-vernaculaires/#id | /noms-vernaculaires/#id/champ | |
|
//+------------------------------------------------------------------------------------------------------+ |
// determine en fct du service appelé (/noms-vernaculaires | /noms-vernaculaires/#id | /noms-vernaculaires/#id/champ | |
// /noms-vernaculaires/#id/relations) le format du tableau à retourner. |
public function retournerResultatFormate($resultat) { |
$this->recupererTableConfig('correspondance_champs'); |
291,7 → 254,7 |
} |
return $reponse; |
} |
|
|
public function formaterNomsVernaculaires($resultat) { |
//on remplit la table $table_retour_json['entete'] |
$table_retour_json['entete']['depart'] = $this->limite_requete['depart']; |
298,12 → 261,12 |
$table_retour_json['entete']['limite'] = $this->limite_requete['limite']; |
$table_retour_json['entete']['total'] = $this->total_resultat; |
$url = $this->formulerUrl($this->total_resultat, '/noms-vernaculaires'); |
if ($url['precedent'] != '') { $table_retour_json['entete']['href.precedent'] = $url['precedent']; } |
if ($url['suivant'] != '') { $table_retour_json['entete']['href.suivant'] = $url['suivant']; } |
|
//on remplit la table $table_retour_json['resultat'] |
if (isset($this->table_param['masque_nv'])) { |
$resultat = $this->trierRechercheFloue($this->table_param['masque_nv'], $resultat, 'nom_vernaculaire'); |
if (isset($url['precedent']) && $url['precedent'] != '') { $table_retour_json['entete']['href.precedent'] = $url['precedent']; } |
if (isset($url['suivant']) && $url['suivant'] != '') { $table_retour_json['entete']['href.suivant'] = $url['suivant']; } |
|
//on remplit la table $table_retour_json['resultat'] |
if (isset($this->parametres['masque_nv'])) { |
$resultat = $this->trierRechercheFloue($this->parametres['masque_nv'], $resultat, 'nom_vernaculaire'); |
} |
foreach ($resultat as $tab) { |
foreach ($tab as $key => $valeur) { |
319,11 → 282,11 |
$resultat_json[$num] = $this->table_retour; |
$this->table_retour = array(); |
} |
|
|
$table_retour_json['resultat'] = $resultat_json; |
return $table_retour_json; |
} |
|
|
// formatage de la reponse /id ss la forme |
// id, nom_vernaculaire, attributions |
// langue |
335,7 → 298,7 |
unset($taxon['num_nom_vernaculaire']); |
$langue = $taxon['code_langue']; |
unset($taxon['code_langue']); |
|
|
foreach ($this->correspondance_champs as $key => $correspondance) { // ordonne les infos pour affichage |
if (isset($taxon[$key]) && $taxon[$key] != "") { |
$this->afficherDonnees($correspondance, $taxon[$key], $langue, $num_nom); |
352,7 → 315,7 |
unset($this->table_retour['href']); |
return $this->table_retour; |
} |
|
|
public function afficherDonnees($champ, $valeur, $langue = '', $num_nom = '') { |
if ($champ == 'id' || $champ == 'nom_vernaculaire') { |
$this->table_retour[$champ] = $valeur; |
360,13 → 323,13 |
switch ($match[1]) { |
case 'taxon' : if ($this->retour_format == 'max') {$this->taxons[$num_nom] = $valeur;} |
$this->afficherPointCode($match[1], $langue, $num_nom, $valeur); break; |
case 'langue' : //$this->afficherPointCode($match[1], 'iso-639-3', 'langues', $valeur); |
case 'langue' : //$this->afficherPointCode($match[1], 'iso-639-3', 'langues', $valeur); |
break; |
case 'genre' : $this->afficherPointCode($match[1], $langue, $num_nom, $valeur); break; |
case 'conseil_emploi' : $this->afficherPointCode($match[1], $langue, $num_nom, $valeur); break; |
default : break; |
} |
|
|
} elseif ($langue != '') { |
$this->table_retour['attributions'][$langue][$num_nom][$champ] = $valeur; |
} else { |
373,17 → 336,17 |
$this->table_retour[$champ] = $valeur; |
} |
} |
|
|
public function afficherPointCode($nomChamp, $langue, $num_nom, $valeur) { |
if (isset($this->champ_infos[$nomChamp])) { |
extract($this->champ_infos[$nomChamp]); |
} |
|
|
if ($this->retour_format == 'max') { |
$url = $this->ajouterHrefAutreProjet($service, $ressource, $valeur, $projet); |
if ($service == 'taxons') { |
$code_valeur = ''; |
} else { |
} else { |
$code_valeur = $this->chercherSignificationCode($url, $nom); |
} |
if ($projet != '') $projet .= '.'; |
395,7 → 358,7 |
$this->table_retour['attributions'][$langue][$num_nom][$nomChamp.'.code'] = $projet.$ressource.$valeur; |
} |
} |
|
|
public function chercherSignificationCode($url, $nom) { |
if (isset($this->signification_code[$url])) { |
$valeur = $this->signification_code[$url]; |
406,7 → 369,7 |
} |
return $valeur; |
} |
|
|
public function afficherTaxons() { |
$url = Config::get('url_service_base').'bdtfx/taxons?navigation.limite=500&masque.nt='.$this->getBdd()->proteger(implode(',', $this->taxons)); |
$res = $this->consulterHref($url); |
423,12 → 386,9 |
} |
} |
|
|
|
|
public function formaterNomsVernaculairesIdChamp($resultat) { |
$this->table_retour['id'] = $this->table_ressources[0]; |
$champs = explode(' ', $this->table_ressources[1]); |
$this->table_retour['id'] = $this->ressources[0]; |
$champs = explode(' ', $this->ressources[1]); |
if (in_array('attributions', $champs) != false) { |
$this->formaterNomsVernaculairesId($resultat); |
unset($this->table_retour['nom_vernaculaire']); |
450,7 → 410,7 |
} |
return $this->table_retour; |
} |
|
|
public function afficherPoint($champ, $valeur, $langue, $num_nom) { |
preg_match('/^(.*)\.code$/', $champ, $match); |
$champ = $match[1]; |
459,18 → 419,18 |
$url = $this->ajouterHrefAutreProjet($service, $ressource, $valeur, $projet); |
$projet .= '.'; |
} |
|
$champs = explode(' ', $this->table_ressources[1]); |
|
$champs = explode(' ', $this->ressources[1]); |
if (in_array($champ.'.*', $champs) !== false && isset($projet)) { |
$this->table_retour['attributions'][$langue][$num_nom][$champ.'.code'] = $projet.$ressource.$valeur; |
$this->table_retour['attributions'][$langue][$num_nom][$champ.'.href'] = $url; |
} |
} |
if (in_array($champ.'.code', $champs) !== false && isset($projet)) { |
$this->table_retour['attributions'][$langue][$num_nom][$champ.'.code'] = $projet.$ressource.$valeur; |
} |
} |
if (in_array($champ.'.href', $champs) !== false && isset($projet)) { |
$this->table_retour['attributions'][$langue][$num_nom][$champ.'.href'] = $url; |
} |
} |
if (in_array($champ, $champs) !== false) { |
if (isset($url)) { |
$this->table_retour['attributions'][$langue][$num_nom][$champ] = $this->chercherSignificationCode($url, $nom); |
477,10 → 437,9 |
} else { |
$this->table_retour['attributions'][$langue][$champ] = $valeur; |
} |
} |
} |
} |
|
|
public function afficherLangue($nomChamp, $projet, $service, $valeur, $ressource = '', $nom = 'nom') { |
if ($this->retour_format == 'max') { |
$this->table_retour['attributions'][$nomChamp] = $nom; |
490,13 → 449,13 |
$this->table_retour['attributions'][$nomChamp.'.code'] = $projet.$ressource.$valeur; |
} |
} |
|
|
public function chargerBiblio($num_nom, $langue) { |
list($table, $version) = explode('_v',$this->table); |
$requete = "SELECT b.*, lb.notes FROM nvjfl_lien_biblio_v$version lb, nvjfl_biblio_v$version b ". |
"WHERE b.num_ref = lb.num_ref AND lb.num_nom = '$num_nom' ;"; |
$resultat = $this->getBdd()->recupererTous($requete); //Debug::printr($resultat); |
|
|
if ($resultat == '') { //cas ou la requete comporte des erreurs |
$r = 'La requête SQL formée comporte une erreur !!'; |
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $r); |
511,6 → 470,6 |
} |
} |
} |
|
|
} |
?> |