Subversion Repositories eFlore/Projets.eflore-projets

Compare Revisions

No changes between revisions

Ignore whitespace Rev 973 → Rev 974

/tags/v5.2-alpage/services/modules/0.1/coste/CommunNomsTaxons.php
New file
0,0 → 1,785
<?php
 
abstract class CommunNomsTaxons extends Commun {
protected $table_param = array(); /** Permet de stocker le tableau des parametres (= $parametres) */
protected $table_ressources = array(); /** Permet de stocker le tableau des ressources (= $ressources) */
protected $table_retour; /** Permet de stocker le tableau de résultat (non encodé en json)*/
protected $resultat_req; /** Permet de stocker le résultat de la requete principale. */
/** Permet de stocker sous forme de tableau les composant du nom à ajouter au nom scientifique (fonction du paramètre ns.structure) */
protected $compo_nom;
protected $ordre_masque = array('masque', 'masque_sg', 'masque_gen', 'masque_sp', 'masque_ssp', 'masque_au',
'masque_an', 'masque_bib', 'masque_ad', 'masque_nn', 'masque_rg' );
protected $tab_nom_sci = array('nom_supra_generique', 'genre', 'epithete_infra_generique', 'epithete_sp',
'type_epithete', 'epithete_infra_sp', 'cultivar_groupe', 'cultivar', 'nom_commercial');
protected $retour_format = 'max';
protected $html = 'txt'; /** Valeur du paramètre de requete ns.format */
protected $table_version; /** Stocke les noms des tables de toutes les versions du projet disponibles */
/** Nom de la table dans laquelle on récupèrera les données (remplace Config::get('bdd_table') dans les requetes SQL */
protected $table;
protected $total_resultat = null;
/** Stocke le service appelé correspondant. Est utilisé principalement lors de l'affichage du href d'un synonyme
(ex id=12, basionyme num 25 est un synonyme) dans le service taxon */
protected $service_href = null;
//----------------------------------Fonctions d'analyse des ressources--------------------------------------------------
/** Permet de remplir la variable version_projet et de retirer cette donnée du tableau des ressources */
public function traiterVersionProjet(&$ressources) {
if (isset($ressources) && !empty($ressources)) {
if (preg_match('/(?:[0-9]+(?:_|[.])[0-9]+|[*])/', $ressources[0])) {
$this->version_projet = array_shift($ressources);
$this->version_projet = str_replace('_', '.', $this->version_projet);
} else {
if ($ressources[0] == ' ') array_shift($ressources); //si un + a été ajouté
$this->version_projet = '+';
}
}
//si la liste des noms est demandée pr toutes les versions, on affiche seulement la dernière version pour :
// - la liste des noms et taxons: /noms et /taxons
// - la liste des taxons inferieurs/supérieur : /taxons/relations/inferieurs et /taxons/relations/superieurs
// - la liste des relations : /taxons/relations ou /noms/relations
if ($this->version_projet == '*' && ($ressources == array()
|| (isset($ressources[1]) && $ressources[1] == 'relations' && isset($ressources[2]) && in_array($ressources[2], array('superieurs', 'inferieurs')))
|| (isset($ressources[1]) && $ressources[1] == 'relations' && !isset($ressources[2])) )) {
$this->version_projet = '+';
}
//on recupère les versions du projet disponible dans la table des meta-donnees (utilisation service MetaDonnees)
$table_num_version = $this->recupererVersionDisponible();
//on recupere la liste des noms des tables de la bdd correspondant aux differentes versions du projet en fct de la ou les versions demandées
$this->recupererListeNomTablePrChaqueVersion($table_num_version);
}
public function traiterRessources($ressources) {
$this->table_ressources = $ressources;
if (isset($ressources) && !empty($ressources)) {
if ($this->estUnIdentifiant()) { //l'identifiant peut etre de type /#id ou /nt:#id
$this->traiterRessourcesIdentifiant(); // dans le service noms ou taxons
} elseif ($this->table_ressources[0] == 'stats') { //ressource = noms/stats
$this->traiterRessourcesStats();
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requete </br> Ressources disponibles : <br/>
<li> /'.$this->service.'/#id (id : L\'identifiant du nom rechercher)</li>
<li> /'.$this->service.'/nt:#id (id : Numero du taxon recherche)</li>
<li> /'.$this->service.'/stats </li>' );
}
}
}
public function traiterRessourcesStats() {
$this->format_reponse = $this->service.'/stats';
if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
switch ($this->table_ressources[1]) {
case 'annees' :
$this->traiterRessourceStatsAnnees();
break;
case 'rangs' :
$this->traiterRessourceStatsRangs();
break;
case 'initiales' :
$this->traiterRessourceStatsInitiales();
break;
default :
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requete </br> Ressources disponibles : <br/>
<li> /'.$this->service.'/stats/annees </li>
<li> /'.$this->service.'/stats/rangs </li>
<li> /'.$this->service.'/stats/initiales </li>' );
break;
}
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requete </br> Ressources disponibles : <br/>
<li> /'.$this->service.'/stats/annees </li>
<li> /'.$this->service.'/stats/rangs </li>
<li> /'.$this->service.'/stats/initiales </li>' );
}
}
/** Vérifie si la première valeur de la table de ressource est un identifiant : un numerique ou un numéro
* taxonomique sous la forme nt:xx */
public function estUnIdentifiant() {
return (is_numeric($this->table_ressources[0]) || (strrpos($this->table_ressources[0],'nt:') !== false
&& is_numeric(str_replace('nt:','',$this->table_ressources[0]))));
}
//---------------------------------------------Fonction d'analyse des parametres----------------------------------------
/** Permet de remplir le tableau compo_nom. Il comprendra en fct du paramètre ns.structure les éléments à rajouter
* au nom_sci (annee, auteur, biblio ou addendum).*/
public function remplirTableCompositionNom($valeur) {
$structure_nom = explode(",",$valeur);
foreach ($structure_nom as $structure) {
switch ($structure) {
case 'au' : $this->compo_nom['au'] = 'auteur'; break;
case 'an' : $this->compo_nom['an'] = 'annee'; break;
case 'bib' : $this->compo_nom['bib'] = 'biblio_origine'; break;
case 'ad' : $this->compo_nom['ad'] = 'nom_addendum'; break;
default : $this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur : Le parametre "'.$structure.'" n\'existe pas. <br/><br/>
Les parametres du nom possibles sont : <li> au (auteur)</li><li> an (annee)</li>
<li> bib (bibliographie)</li><li> ad (nom_addendum)</li>');
break;
}
}
}
/** Permet de recupérer le nom scientigfique au format html. Le champ nom_sci de la requete sql est remplacé par
* le champ nom_sci_html */
public function mettreAuFormat() {
if ($this->html == 'htm') {
if (strrpos($this->requete_champ, 'nom_sci_html as nom_sci') === false) {
$this->requete_champ = str_replace('nom_sci', 'nom_sci_html as nom_sci', $this->requete_champ);
}
} elseif ($this->html != 'txt') {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requete </br> ns.format = htm ou txt (par defaut)' );
}
}
 
//--------------------------------fonctions de formatage----------------------------------------------------------
 
/** Fonction permettant de creer la table dont le nom est passé en paramètre (champs_api, champs_bdtfx,
* correspondance_champs...). Les données de chaque table sont présentes dans le fichier de configuration config.ini
* @param String $table : Peut contenir plusieurs nom de table dont on souhaite récupérer les données : table,table,table.
* Ex : recupererTableSignification('champs_api,champs_bdtfx') */
public function recupererTableSignification($table) {
$tables = explode(',', $table);
foreach ($tables as $tab) {
if ($tab == 'champs_comp') {
$champ_bdnff_api = array_keys($this->champs_api); //on recupère le nom des champ ds la bdd
$this->champs_comp = array_diff($this->champs_table, $champ_bdnff_api);
} elseif ($tab == 'champs_api') {
foreach ($this->correspondance_champs as $key => $val) {
preg_match('/(hybride[.]parent_0[12](?:[.]notes)?|nom_sci[.][^.]+|[^.]+)(?:[.](id|code))?/', $val, $match);
$val = $match[1];
$this->champs_api[$key] = $val;
}
} else {
$tableau = explode(',', Config::get($tab));
$tableau = array_map('trim', $tableau);
foreach ($tableau as $champ) {
list($code, $rang) = explode('=', $champ);
$tab_tampon[$code] = $rang;
}
$this->$tab = $tab_tampon;
$tab_tampon = array();
}
}
}
public function formaterEnOss($resultat) {
$res = array();
$table_nom = array();
foreach ($resultat as $version => $res_version) {
$oss = '';
foreach ($res_version as $tab) {
if (isset($tab['nom_sci']) ) {
if (!in_array($tab['nom_sci'], $table_nom)) {
$table_nom[] = $tab['nom_sci'];
$oss [] = $tab['nom_sci'].$this->ajouterCompositionNom($tab);
}
}
}
$masque = $this->ordonnerMasque();
if ($masque == '') $masque = 'Pas de masque';
$table_retour_oss = array($masque, $oss);
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $table_retour_oss, $res);
}
return $res;
}
/** Permet de récupérer le masque de rang superieur parmi les parametres de la requete.
* Sera affiche dans l'entete du fichier json (clé 'masque') et oss.
* @return string le masque de rang supérieur ou '' si aucun masque n'a été mis en parametre de
* requete (la clé masque ne sera alors pas affichée dans l'entete).*/
public function ordonnerMasque() {
$masque = '';
foreach ($this->ordre_masque as $key => $filtre) {
if (isset($this->table_param[$filtre])) {
$masque .= '&'.$filtre.'='.$this->table_param[$filtre];
}
}
$masque = ltrim($masque, '&'); //on enlève le & du début
$masque = str_replace('masque_','',$masque);
return $masque;
}
/** Affiche l'entete du résultat pour le service /noms et /noms/relations. L'entete comprend le rang (s'il est un
* filtre), le départ, la limite, le total des résultats et les urls suivante et precedente. */
public function afficherEnteteRangBorneTotalUrls($resultat, $url_service) {
if (isset($this->table_param['masque_rg'])) $this->afficherDonnees('rang', $this->table_param['masque_rg']);
$this->table_retour['depart'] = $this->limite_requete['depart'];
$this->table_retour['limite'] = $this->limite_requete['limite'];
$this->table_retour['total'] = $this->total_resultat;
//formuler les urls precedentes et suivantes
$url = $this->formulerUrl($this->total_resultat, $url_service);
if ($url['precedent'] != '') { $this->table_retour['href.precedent'] = $url['precedent']; }
if ($url['suivant'] != '') { $this->table_retour['href.suivant'] = $url['suivant']; }
}
//----------------------------Fonction de formatage pour les services /#id/---------------------------------------------
/** Ajout du numero de la version au tableau de résultat à retourner :
* 'bdtfx_v2_00' : {'infos' : 'toto' ...}, 'bdtfx_v3_00' : {'infos' : 'tata' ...}
* @param string $num_version : numéro de version (sous la forme de l'intitulé du nom de la table bdd)
* @param array $tab : tableau contenant le resultat à retourner pour une version donnée
* @param array $res : tableau contenant le resultat à retourner pour toutes les versions disponibles */
public function afficherVersionOuPas($version, &$tab, &$res) {
if (count($this->table_version) > 1) {
$res[$version] = $tab;
$tab = array();
} else {
$res = $tab;
}
return $res;
}
public function formaterId($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
$res_version = $res_version[0];
$this->resultat_req = $res_version;
foreach ($res_version as $key => $valeur) {
if ($valeur != '') {
$this->afficherDonnees($key, $valeur);
}
}
unset($this->table_retour['href']);
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $this->table_retour, $res);
}
return $res;
}
public function formaterIdChamp($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
$res_version = $res_version[0];
$this->resultat_req = $res_version;
$this->table_retour['id'] = $res_version['num_nom'];
//on récupère les champs (le + est transformé en espace par le navigateur)
$tab_ress = explode(' ', $this->table_ressources[1]);
foreach ($tab_ress as $nom_champ_api) {
if ($this->verifierValiditeChamp($nom_champ_api)) {
switch ($nom_champ_api) {
case 'nom_sci' : $this->afficherNomSci($res_version); break;
case 'nom_sci.*' : $this->afficherNomSciPointEpithete($res_version); break;
case 'hybride.*' :
$this->afficherChamps('hybride.parent_01.*', $res_version['hybride_parent_01']);
$this->afficherChamps('hybride.parent_02.*', $res_version['hybride_parent_02']); break;
default :
$this->afficherChamps($nom_champ_api,
$res_version[$this->trouverChampBddCorrespondant($nom_champ_api)]); break;
}
}
}
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $this->table_retour, $res);
}
return $res;
}
/** Les champs passés dans l'url lors de la requete /noms|taxons/#id/#champ+#champ son sous la forme de l'api.
* Les noms de l'api ne st pas les meme que ceux des champs de la base de données.
* Cette fct permet de récupérer le nom du champs de la base de données */
public function trouverChampBddCorrespondant($champ) {
$radical_champ = $champ;
if ($this->estUnPoint($champ) && strrpos($champ, '.notes') === false) {
preg_match('/^(?:([^.]+\.parent_0[12]|[^.]+))(?:\.(.+))?$/', $champ, $match);
$radical_champ = $match[1];
}
// - Soit un champ de l'api est recherché (pour les champs du référentiel : les noms des champs ont été modifiés),
// - Soit un champ complementaire de la bdnff (les noms de ces champs complementaire sont les memes que ds la base)
if ($this->estChampApi($radical_champ)) {
$champ_bdd = array_search($radical_champ, $this->champs_api);
} elseif ($this->estDansBdnff($radical_champ)) {
$champ_bdd = $radical_champ;
} else {
$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Fct trouverChampBddCorrespondant : Le parametre "'.$radical_champ.'" n\'existe pas. <br/><br/>');
}
return $champ_bdd;
}
/** Permet d'afficher des informations précisées des données liées. Utilisé par le service id/champ
* lors de l'appel d'un champ tel que : champ.id, champ.code, champ.*, champ.href. */
public function afficherChamps($champ, $valeur) {
$reponse = $this->table_retour;
$this->table_retour = array();
if ($valeur == '') {
$this->table_retour[$champ] = null;
} else {
preg_match('/^(?:([^.]+\.parent_0[12]|[^.]+))(?:\.(.+))?$/', $champ, $match);
//si on a un point etoile
if (isset($match[2]) && $match[2] == '*') {
$this->afficherPointEtoile($match[1], $valeur);
//si le champ comprend plusieurs identifiants : pour le champ proparte (liste ou .details recherché, pas de .href)
} elseif ($this->presentePlusieursId($match[1], $valeur)) {
if (isset($match[2]) && $match[2] != 'id') {
$this->afficherInfosPrecises($match[1], $match[2], $valeur);
} else {
$this->table_retour[str_replace('.id', '', $champ)] = $valeur;
}
//si on est en présence d'une donnée liée (la donnée représente un identifiant ou un code)
} elseif ($this->correspondAUnId($match[1]) || $champ == 'id' || $this->correspondAUnCode($match[1])) {
if (isset($match[2])) { //si un .id, un .code ou un .href est demandé :
$this->afficherInfosPrecises($match[1], $match[2], $valeur);
} else {
$this->afficherInfosPrecises($match[1], 'signification', $valeur);
}
//sinon on affiche tel quel
} else {
$this->table_retour[$champ] = $valeur;
}
}
$this->table_retour = array_merge($reponse, $this->table_retour);
}
 
/**Vérifie la validité d'un champ passé dans la requete /#id/#champ+#champ */
public function verifierValiditeChamp($champ) {
preg_match('/^(?:([^.]+\.parent_0[12]|[^.]+))(?:\.(.+))?$/', $champ, $match);
$radical_champ = $match[1];
$validite_ressource = true;
//on verifie si le nom du champ existe bien
if (!$this->estChampApi($radical_champ) && !$this->estDansBdnff($radical_champ)) {
$validite_ressource = false;
$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Fct verifierValiditeChamp : Le parametre "'.$radical_champ.'" n\'existe pas. <br/><br/>');
} elseif ($this->estUnPoint($champ)) {
$suffixe = $match[2];
//On verifie les suffixes pour les identifiants
if ($this->correspondAUnId($radical_champ) || $radical_champ == 'id') {
$this->verificationSuffixesIdentifiant($suffixe, $radical_champ, $validite_ressource);
//On verifie les suffixes pour les codes
} elseif ($this->correspondAUnCode($radical_champ)) {
$this->verficationSuffixesCodes($suffixe, $radical_champ, $validite_ressource);
} elseif ($radical_champ == 'nom_sci' && $suffixe != '*') {
$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur : Le suffixe demand&eacute; n\'existe pas pour le champ "'.$radical_champ.'".<br/>
Les suffixes possibles sont les suivants : <li> * </li>');
} else {
$validite_ressource = false;
$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur : Le parametre "'.$radical_champ.'" ne peut pas pr&eacute;senter de suffixe. <br/><br/>');
}
}
return $validite_ressource;
}
public function verficationSuffixesCodes(&$suffixe, &$radical_champ, &$validite_ressource ) {
if (!in_array($suffixe, array('*', 'code', 'href', 'details'))) {
$validite_ressource = false;
$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur : Le suffixe demand&eacute; n\'existe pas pour le champ "'.$radical_champ.'.<br/>
Les suffixes possibles sont les suivants :
<li> .* </li><li> .code </li><li> .href </li><li> .details </li>');
}
}
public function verificationSuffixesIdentifiant(&$suffixe, &$radical_champ, &$validite_ressource) {
if ((strrpos($radical_champ, 'parent') !== false && !in_array($suffixe, array('*', 'id', 'href', 'details', 'notes')))
|| !in_array($suffixe, array('*', 'id', 'href', 'details')) && strrpos($radical_champ, 'parent') === false) {
$validite_ressource = false;
$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur : Le suffixe demand&eacute; n\'existe pas pour le champ "'.$radical_champ.'".<br/>
Les suffixes possibles sont les suivants :
<li> .* </li><li> .id </li><li> .href </li><li> .details </li><li> .notes (seulement pour les hybride.parent)');
}
}
//------------------------------fonction de formatage pour les services /stats/-----------------------------------------
public function formaterStatsAnnee($resultat) {
$res = array();
foreach ($resultat as $version => $res_version) {
foreach ($res_version as $cle_annee) {
foreach ($cle_annee as $key => $val) {
switch($key) {
case 'annee' : $annee = ($val != '') ? $val : 'N.D.'; break;
case 'nombre': $nb = $val; break;
default : break;
}
}
$retour_stats_annee[$annee] = $nb;
}
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $retour_stats_annee, $res);
}
return $res;
}
public function formaterStatsRang($resultat) {
$res = array();
foreach ($resultat as $version => $res_version) {
foreach ($res_version as $rangs) {
if ($rangs['rang'] != 0) {
foreach ($rangs as $key => $val) {
switch ($key) {
case 'rang' : $rang = $val; break;
case 'nombre' : $nombre = $val; break;
default : break;
}
}
$retour_rang[$rang] = array(
'rang' => $this->ajouterSignificationCode('rang', $rang),
'nombre' => $nombre
);
}
}
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $retour_rang, $res);
}
return $res;
}
public function formaterStatsInitiales($resultat) {
$res = array();
$table_rang = array();
foreach ($resultat as $version => $res_version) {
foreach ($res_version as $tuple) {
if ($tuple['rang'] != 0) {
if (!isset($table_rang[$tuple['rang']])) {
$rang = $this->ajouterSignificationCode('rang', $tuple['rang']);
$table_rang[$tuple['rang']] = $rang;
} else {
$rang = $table_rang[$tuple['rang']];
}
if ($tuple['lettre'] == 'x ') {
if (isset($this->table_retour[$rang]['hyb'])) {
$this->table_retour[$rang]['hybride'] += floatval($tuple['nb']);
} else {
$this->table_retour[$rang]['hybride'] = floatval($tuple['nb']);
}
} elseif ($tuple['lettre'] == '+ ') {
if (isset($this->table_retour[$rang]['chimère'])) {
$this->table_retour[$rang]['chimère'] += floatval($tuple['nb']);
} else {
$this->table_retour[$rang]['chimère'] = floatval($tuple['nb']);
}
} else {
$l = substr($tuple['lettre'], 0, 1);
if (isset($this->table_retour[$rang][$l])) {
$this->table_retour[$rang][substr($tuple['lettre'], 0, 1)] += floatval($tuple['nb']);
} else {
$this->table_retour[$rang][substr($tuple['lettre'], 0, 1)] = floatval($tuple['nb']);
}
}
}
}
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $this->table_retour, $res);
}
return $res;
}
//-----------------------------Fonctions d'affichage utiliser dans les fonctions de formatage---------------------------
/** Affiche les résultats en fonction du paramètre retour_format. */
public function afficherDonnees($key, $valeur) {
//on souhaite afficher le nom au format de l'api
if ($this->retour_format == 'min') {
if ($this->correspondAChampApi($key)) { //on affiche l'intitulé selon decrit dans l'api
if ($key == 'nom_sci') $valeur = $valeur.$this->ajouterCompositionNom($this->resultat_req);
$this->table_retour[$this->correspondance_champs[$key]] = $valeur;
} else {
$this->table_retour[$key] = $valeur;
}
} else {
if ($this->correspondAChampApi($key)) {
$nom_champ_api = $this->correspondance_champs[$key]; //on récupere le nom comme définit ds l'api
$this->afficherToutesLesInfos($nom_champ_api, $valeur);
} elseif ($this->estDansBdnff($key)) {
$this->table_retour[$key] = $valeur;
}
}
}
public function afficherToutesLesInfos($nom_champ_api, $valeur) {
if ($this->presentePlusieursId($nom_champ_api, $valeur)) {
preg_match('/^([^.]+\.parent_0[12]|[^.]+)(?:\.id)?$/', $nom_champ_api, $match);
$this->afficherInfosPrecises($match[1], 'details', $valeur);
$this->table_retour[$nom_champ_api] = $valeur;
} elseif (strrpos($nom_champ_api, 'parent') !== false && strrpos($nom_champ_api, 'notes') !== false) {
$this->table_retour[$nom_champ_api] = $valeur;
} elseif (($this->correspondAUnId($nom_champ_api) || $nom_champ_api == 'id') && $valeur != '0') {
preg_match('/^([^.]+\.parent_0[12]|[^.]+)(?:\.id)?$/', $nom_champ_api, $match);
$this->afficherInfosPrecises($match[1], 'id,signification,href', $valeur);
} elseif ($this->correspondAUnCode($nom_champ_api)) {
preg_match('/^([^.]+)(?:\.code)?$/', $nom_champ_api, $match);
$this->afficherInfosPrecises($match[1], 'code,signification,href', $valeur);
}
}
public function presentePlusieursId($ressource, $valeur = null) {
if ($valeur) {
$presente = strrpos($ressource, 'proparte') !== false && strrpos($valeur, ',') !== false;
} else { //pour la vérification du champ, on ignore alors la valeur de la ressource
$presente = strrpos($ressource, 'proparte') !== false;
}
return $presente;
}
public function afficherTableDetails($nom_champ_api, $valeur) {
$tab_id = explode(',',$valeur);
$tab_res = $this->table_retour;
$this->table_retour = array();
foreach ($tab_id as $id) {
$this->afficherInfosPrecises($nom_champ_api, 'id,signification,href', $id);
$tab_res[$nom_champ_api.'.details'][] = $this->table_retour;
$this->table_retour = array();
}
$this->table_retour = $tab_res;
}
public function afficherPointEtoile($champ, $valeur) {
if ($this->presentePlusieursId($champ, $valeur)) {
$this->afficherInfosPrecises($champ, 'details', $valeur);
$this->table_retour[$champ] = $valeur;
} elseif (strrpos($champ, 'parent') !== false) {
$this->afficherInfosPrecises($champ, 'id,href,notes', $valeur);
} elseif ($this->correspondAUnId($champ) || $champ == 'id') {
$this->afficherInfosPrecises($champ, 'id,href', $valeur);
} elseif ($this->correspondAUnCode($champ)) {
$this->afficherInfosPrecises($champ, 'code,href', $valeur);
}
}
public function afficherInfosPrecises($champ, $suffixe, $valeur) {
$suffixes = explode(',', $suffixe);
//on initialise au service appelé. Sera potentiellement modifié dans la fonction afficherSignification()
$this->service_href = $this->service;
foreach ($suffixes as $suff) {
switch ($suff) {
case 'id' :
$this->table_retour[str_replace('id.id', 'id', $champ.'.id')] = $valeur;
break;
case 'details' :
$this->afficherTableDetails($champ, $valeur);
break;
case 'signification' :
$this->afficherSignification($champ, $valeur);
break;
case 'href' :
if ($this->correspondAUnId($champ) || $champ == 'id') {
$service = $this->service_href;
$url = $this->ajouterHref($service, $valeur);
} else {
$service = 'ontologies';
$champ_url = $champ;
$url = $this->ajouterHrefAutreProjet($service, $val, $champ_url);
}
$this->table_retour[str_replace('id.href', 'href', $champ.'.href')] = $url;
break;
case 'code' :
$val = ( $champ == 'rang' ) ? 'bdnt.rangTaxo:'.$valeur : 'bdnt.'.rtrim($champ, '_Ga,_Co').':'.$valeur;
$this->table_retour[$champ.'.code'] = $val;
break;
case 'notes' :
$this->table_retour[$champ.'.notes'] = $this->resultat_req[str_replace('.', '_', $champ).'_notes'];
break;
default :
break;
}
}
}
public function afficherSignification($champ, $valeur) {
if ($champ == 'id' && isset($this->resultat_req['nom_sci']) && $this->resultat_req['num_nom'] == $valeur) {
//si le nom_sci du num_nom que l'on veut afficher est déjà dans la table de résultat :
$this->table_retour['nom_sci'] = $this->resultat_req['nom_sci'].$this->ajouterCompositionNom($this->resultat_req);
} elseif ($this->correspondAUnId($champ) || $champ == 'id') {
$nom = $this->recupererNomSci($valeur);
$champ = ($champ == 'id') ? 'nom_sci' : $champ;
if ($nom != array()) {
$this->table_retour[$champ] = $nom['nom_sci'];
$this->service_href = $nom['service'];
}
} elseif ($this->correspondAUnCode($champ)) {
$this->table_retour[$champ] = $this->ajouterSignificationCode($champ, $valeur);
}
}
/** Permet d'afficher les élements nomenclatural du nom_sci lors de l'appel dans le service noms/id/champ du champ^nom_sci.*/
public function afficherNomSciPointEpithete($resultat) {
foreach ($this->tab_nom_sci as $compo_nom) {
if (isset($resultat[$compo_nom]) && !empty($resultat[$compo_nom])) {
$this->table_retour['nom_sci.'.$compo_nom] = $resultat[$compo_nom];
}
}
}
/** utilisé dans le formatage de /noms/id et de /noms/id/champ seulement */
public function afficherNomSci($resultat) {
if ($this->html == 'htm') {
$this->table_retour['nom_sci'] = $resultat['nom_sci_html'].$this->ajouterCompositionNom($resultat);
} else {
$this->table_retour['nom_sci'] = $resultat['nom_sci'].$this->ajouterCompositionNom($resultat);
}
}
/** Permet d'afficher la signification d'un code pour le rang, la présence, et les differents statuts */
public function ajouterSignificationCode($champ, $valeur) {
$champ = ($champ == 'rang') ? 'rangTaxo' : rtrim($champ, '_Co,_Ga');
if (preg_match('/^([^_-]+)(?:_|-)([^_-]+)$/', $champ, $match)) {
$champ = $match[1].ucfirst($match[2]);
}
$url = Config::get('url_ontologie').$champ.':'.$valeur.'/nom';
$res = $this->consulterHref($url); //dans commun.php
$nom_code = $res->nom;
return $nom_code;
}
/** Recupere le nom_scientifique (formaté ou non en fonction du parametre ns.format) à partir du num_nom */
public function recupererNomSci($id) {
$nom = array();
if ($id != 0) {
if ($this->compo_nom == null) {
$req = 'SELECT nom_sci, num_nom_retenu FROM '.$this->table.' WHERE num_nom = '.$id;
} else { //on ajoute à la requete sql, les champs de ns.structure
$req = 'SELECT nom_sci, num_nom_retenu, '.implode(', ', $this->compo_nom)
.' FROM '.$this->table
.' WHERE num_nom = '.$id;
}
if ($this->html == 'htm') {
$req = str_replace('nom_sci', 'nom_sci_html as nom_sci', $req);
}
$res = $this->getBdd()->recuperer($req);
if ($res) {
$nom['nom_sci'] = $res['nom_sci'].$this->ajouterCompositionNom($res);
$nom['service'] = ($res['num_nom_retenu'] == $id && $this->service == 'taxons') ? 'taxons' : 'noms';
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Fct recupererNomSci() : Donnees introuvables dans la base pour l\'id '.$id);
}
}
return $nom;
}
 
/** Permet de retourner une chaine de caractère composée des parametres du nom (ns.structure : annnée, auteur,
* bibilio et addendum). A ajouter au nom scientifique */
public function ajouterCompositionNom($tab_res) {
$nom_complet = ' ';
$this->ajouterAuteur($tab_res, $nom_complet);
$this->ajouterAnneeEtBiblio($tab_res, $nom_complet);
$this->ajouterAnneeSansBilio($tab_res, $nom_complet);
$this->ajouterBiblioSansAnnee($tab_res, $nom_complet);
$this->ajouterAddendum($tab_res, $nom_complet);
return rtrim($nom_complet);
}
public function ajouterAuteur($tab_res, &$nom_complet) {
if (isset($this->compo_nom['au']) && isset($tab_res['auteur']) && $tab_res['auteur'] != '') {
if ($this->html == 'htm') {
$nom_complet .= '<span class="auteur">'.$tab_res['auteur'].'</span> ';
} else {
$nom_complet .= $tab_res['auteur'].' ';
}
}
}
public function ajouterAnneeEtBiblio($tab_res, &$nom_complet) {
if (isset($this->compo_nom['an']) && isset($this->compo_nom['bib'])
&& isset($tab_res['annee']) && ($tab_res['annee'] != '')
&& isset($tab_res['biblio_origine']) && ($tab_res['biblio_origine'] != '')) {
if ($this->html == 'htm') {
$nom_complet .= '[<span class="annee">'.$tab_res['annee'].'</span>, <span class="biblio">'
.$tab_res['biblio_origine'].'</span>]';
} else {
$nom_complet .= '['.$tab_res['annee'].', '.$tab_res['biblio_origine'].']';
}
}
}
 
public function ajouterAnneeSansBilio($tab_res, &$nom_complet) {
if (isset($this->compo_nom['an']) && !isset($this->compo_nom['bib'])
&& isset($tab_res['annee']) && ($tab_res['annee'] != '')) {
if ($this->html == 'htm') {
$nom_complet .= '[<span class="annee">'.$tab_res['annee'].'</span>]';
} else {
$nom_complet .= '['.$tab_res['annee'].']';
}
}
}
public function ajouterBiblioSansAnnee($tab_res, &$nom_complet) {
if (!isset($this->compo_nom['an']) && isset($this->compo_nom['bib']) && ($tab_res['biblio_origine'] != '')) {
if ($this->html == 'htm') {
$nom_complet .= '[<span class="biblio">'.$tab_res['biblio_origine'].'</span>]';
} else {
$nom_complet .= '['.$tab_res['biblio_origine'].']';
}
}
}
public function ajouterAddendum($tab_res, &$nom_complet) {
if (isset($this->compo_nom['ad']) && ($tab_res['nom_addendum'] != '')) {
if ($this->html == 'htm') {
$nom_complet .= '[<span class="adendum">'.$tab_res['nom_addendum'].'</span>]';
} else {
$nom_complet .= '['.$tab_res['nom_addendum'].']';
}
}
}
public function correspondAUnCode($key) {
return (strrpos($key, '.code') !== false) || (in_array($key.'.code', $this->correspondance_champs));
}
public function correspondAUnId($key) {
return (strrpos($key, '.id') !== false) || (in_array($key.'.id', $this->correspondance_champs));
}
public function estChampApi($champ) {
return (in_array($champ, $this->champs_api) || in_array($champ, $this->correspondance_champs));
}
public function correspondAChampApi($champ_bdd) {
return (array_key_exists($champ_bdd, $this->champs_api) || array_key_exists($champ_bdd, $this->correspondance_champs));
}
public function estDansBdnff($champ) {
return (in_array($champ, $this->champs_comp));
}
public function estUnPoint($key) {
if (strrpos($key, 'hybride.parent') !== false) {
$key = str_replace('hybride.parent', 'hybride_parent', $key);
}
return (strrpos($key, '.') !== false);
}
}
 
?>
Property changes:
Added: svn:executable
+*
\ No newline at end of property
/tags/v5.2-alpage/services/modules/0.1/coste/Noms.php
New file
0,0 → 1,711
<?php
 
 
/**
* Description :
* Classe Noms.php permettant de fournir des informations sur les noms scientifiques.
* Si l'url finit par /noms on retourne une liste de noms latin et leurs identifiants (seulement les 100 premeiers noms par défaut).
* L'url peut contenir des paramètres optionnels passés après le ? : /noms?param1=val1&param2=val2&...
*
* Les paramètres de requête disponibles sont : masque, masque.gen (nom de genre), masque.sp (épithète d'espèce), masque.ssp (épithète infra-spécifique),
* masque.au (auteur du nom), masque.an (année de publication du nom), masque.bib (réf biblio de la publi d'origine du nom), masque.ad (nomen addendum),
* masque.nn (identifiant du nom), recherche, rang, distinct, retour.format, nl.format, nl.structure, navigation.depart et navigation.limite.
*
* Encodage en entrée : utf8
* Encodage en sortie : utf8
* @package framework-v3
* @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 Noms extends CommunNomsTaxons {
/** Permet de stocker la requete formulée :
* - noms | noms/#id | noms/#id/#champ+#champ
* - noms/#id/relations | noms/#id/relations/synonymie | noms/#id/relations/homonymie | noms/#id/relations/flores
* - noms/stats/rangs | noms/stats/annees | noms/stats/initiales */
protected $format_reponse = 'noms';
protected $service = 'noms';
/** Valeur du paramètre de requete recherche : stricte etendue floue */
protected $recherche = false;
/** Valeur du paramètre de requete distinct (=0|1) */
protected $distinct = null;
/** Représente la première partie de la requete SQL (entre le SELECT et le WHERE) */
protected $requete_champ = 'num_nom, nom_sci, num_nom_retenu';
/** Représente la partie de la requete SQL ajoutant une condition (WHERE ...) */
protected $requete_condition = '';
/** Représente la partie GROUP BY de la requete SQL (GROUP BY ...) */
protected $requete_group_by = '';
/** Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés).*/
protected $limite_requete = array(
'depart' => 0,
'limite' => 100
);
public function consulter($ressources, $parametres) {
$resultat_formate = '';
$res_version = '';
$this->initialiserRestClient(); //création d'un objet RestClient
$this->traiterParametres($parametres);
//On récupère les différentes versions existantes ds la table des meta-données (WS metaDonnees) et on traite la version demandée :
$this->traiterVersionProjet($ressources);
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
$this->recupererNomChamp($this->table); //on récupère les noms des champs disponibles (Ds Commun.php)
$this->traiterRessources($ressources); //dans CommunNomsTaxons.php
$requete = $this->assemblerLaRequete();
$resultat = $this->getBdd()->recupererTous($requete);
if ($resultat == '') { //cas ou la requete comporte des erreurs
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'La requ&ecirc;te SQL form&eacute;e comporte une erreur !!');
} elseif ($resultat) {
$res_version[$version] = $resultat;
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Les donn&eacute;es recherch&eacute;es sont introuvables dans la version '.$version);
}
}
}
if ($this->corps_http == '' && $this->entete_http == '') {
$resultat_formate = $this->retournerResultatFormate($res_version);
}
$this->formerReponseHTTP($resultat_formate);
}
//-----------------FONCTION D'ANALYSE DES PARAMETRES--------------------------------------------------------------------
 
/**
*
* Permet d'analyser les paramètres
* @param array $parametres
*/
public function traiterParametres($parametres) {
$this->table_param = $parametres;
if (isset($parametres) && !empty($parametres)) {
//définition de $recherche permettant d'ajouter les % ds la requete sql (cas recherche étendue) utilisé dans la fct ajouterLeFiltreMasque()
if (isset($parametres['recherche']) && $parametres['recherche'] != '') {
$this->recherche = $parametres['recherche'];
}
foreach ($parametres as $param => $val) {
switch ($param) {
case 'ns_format' : $this->html = $val; break;
case 'ns_structure' : $this->remplirTableCompositionNom($val); //ds CommunNomsTaxons.php
$this->requete_champ .= ' ,'.implode(', ',$this->compo_nom); break;
case 'masque' : $this->ajouterLeFiltreMasque('nom_sci', $val); break;
case 'masque_sg' : $this->ajouterLeFiltreMasque('nom_supra_generique', $val); break;
case 'masque_gen' : $this->ajouterLeFiltreMasque('genre', $val); break;
case 'masque_sp' : $this->ajouterLeFiltreMasque('epithete_sp', $val); break;
case 'masque_ssp' : $this->ajouterLeFiltreMasque('epithete_infra_sp',$val); break;
case 'masque_au' : $this->ajouterLeFiltreMasque('auteur', $val); break;
case 'masque_an' : $this->ajouterLeFiltreMasque('annee', $val); break;
case 'masque_bib' : $this->ajouterLeFiltreMasque('biblio_origine',$val); break;
case 'masque_ad' : $this->ajouterLeFiltreMasque('nom_addendum', $val); break;
case 'masque_nn' : $this->requete_condition .= ' AND num_nom IN ('.$val.')'; break;
case 'masque_rg' : $this->ajouterLeFiltreMasque('rang', $val); break;
case 'navigation_depart': $this->limite_requete['depart'] = $val; break;
case 'navigation_limite': $this->limite_requete['limite'] = $val; break;
case 'retour_format' : $this->retour_format = $val; break;
case 'distinct' : $this->distinct = $val; break;
case 'recherche' : break;
default : $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans les parametres de recherche de votre requ&ecirc;te :
</br> Le parametre " '.$param.' " n\'existe pas.'); break;
}
}
$this->ajouterNomDistinct();
if ($this->recherche == 'floue') {
$this->rechercheFloue();
}
}
}
/**
*
* fonction d'ajout dans la requete SQL des conditions (WHERE ...) en fonctions des parametres demandés
* @param $nom_champ
* @param $valeur
* @param $masque
*/
public function ajouterLeFiltreMasque($nom_champ, $valeur) {
if ($nom_champ == 'annee' || $nom_champ == 'rang') {
$this->requete_condition .= ' AND '.$nom_champ.' = '.$this->getBdd()->proteger($valeur);
} else {
if ($this->recherche == 'etendue') {
$valeur = str_replace(' ','%', $valeur);
$valeur .= '%';
}
$this->requete_condition .= ' AND '.$nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
}
}
/**
* Permet de rajouter à la requete sql le parametre distinct. N'est utilisé qu'avec le format oss
*/
public function ajouterNomDistinct() {
if (isset($this->distinct)) {
if (($this->distinct == 1) && ($this->retour_format == 'oss')) {
if ($this->compo_nom == '') {
$this->requete_champ = ' DISTINCT nom_sci ';
} else {
$this->requete_champ = ' DISTINCT nom_sci, '.implode(', ',$this->compo_nom);
}
} elseif (($this->distinct == 1) && ($this->retour_format != 'oss')) {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,'Erreur dans votre requ&ecirc;te </br>
L\'utilisation du parametre distinct ne se fait que sous le format oss');
}
}
}
/**
*
* Permet d'ajouter à notre requete une condition de recherche floue à l'aide de l'alhorithme soundex.
* On remplace ainsi les filtres exceptés le masque année et le filtre rang
*/
public function rechercheFloue() {
foreach ($this->ordre_masque as $masque) {
if (array_key_exists($masque, $this->table_param)) {
$radical = $this->table_param[$masque];
switch ($masque) {
case 'masque' : $this->ajoutSoundex('nom_sci', $radical); break;
case 'masque_sg' : $this->ajoutSoundex('nom_supra_generique', $radical); break;
case 'masque_gen' : $this->ajoutSoundex('genre', $radical); break;
case 'masque_sp' : $this->ajoutSoundex('epithete_sp', $radical); break;
case 'masque_ssp' : $this->ajoutSoundex('epithete_infra_sp', $radical); break;
case 'masque_au' : $this->ajoutSoundex('auteur', $radical); break;
default : break;
}
}
}
}
/** Ajoute à la requete SQL l'expression pour la recherche floue en fonction du masque demandé */
public function ajoutSoundex($champ, $radical) {
$this->requete_condition = str_replace(' AND '.$champ.' LIKE \''.$radical.'\'',
' AND (SOUNDEX('.$champ.') = SOUNDEX(\''.$radical.'\')'.
' OR SOUNDEX(REVERSE('.$champ.')) = SOUNDEX(REVERSE(\''.$radical.'\'))) ',
$this->requete_condition
);
}
//-----------------FONCTION D'ANALYSE DES RESSOURCES--------------------------------------------------------------------
 
 
public function traiterRessourcesIdentifiant() {
//on initialise la condition de la requete sql et le format de réponse
$this->requete_condition = ' num_nom = '.$this->getBdd()->proteger($this->table_ressources[0]);
$this->format_reponse = $this->service.'/id';
if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
// requete de type noms/#id/#champ+#champ
if (($this->table_ressources[1] != 'relations')) {
$this->requete_champ = ' *, nom_sci ';
$this->format_reponse .= '/champ';
// requete de type noms/#id/relations/#relations
} elseif ($this->table_ressources[1] == 'relations') {
$this->traiterRessourceIdRelations();
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requ&ecirc;te </br> Ressources disponibles : <br/>
<li> noms/#id/relations </li> <li> noms/#id/#champ+#champ </li>
<li> noms/#id/relations/synonymie </li> <li> noms/#id/relations/flores </li>
<li> noms/#id/relations/homonymie </li>');
}
} else {
// requete de type noms/#id : rajout du nom_sci pour récupérer le format html par la fct mettreAuFormat()
// SELECT *, nom_sci FROM bdtfx_v2_00 WHERE num_nom = X;
$this->requete_champ = ' *, nom_sci ';
}
}
public function traiterRessourceIdRelations() {
$this->format_reponse .= '/relations';
if (isset($this->table_ressources[2]) && !empty($this->table_ressources[2])) {
// requete de type noms/#id/relations/#relation
switch ($this->table_ressources[2]) {
case 'synonymie' : $this->traiterRessourceIdSynonymie(); break;
case 'flores' : $this->traiterRessourceIdFlores(); break;
case 'homonymie' : $this->traiterRessourceIdHomonymie(); break;
default : $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requ&ecirc;te </br> Ressources disponibles : <br/>
<li> noms/#id/relations </li> <li> noms/#id/relations/synonymie </li>
<li> noms/#id/relations/flores </li> <li> noms/#id/relations/homonymie </li>'); break;
}
}
}
public function traiterRessourceIdSynonymie() {
// SELECT num_nom, nom_sci, num_nom_retenu, basionyme FROM bdtfx_v2_00 WHERE num_nom = X LIMIT 0,100;
$this->format_reponse .= '/synonymie';
if (strrpos($this->requete_champ, ', basionyme') === false) $this->requete_champ .= ', basionyme ';
$this->requete_condition = ' num_nom_retenu = (SELECT num_nom_retenu FROM '.$this->table
.' WHERE '.$this->requete_condition.')';
}
public function traiterRessourceIdHomonymie() {
// SELECT num_nom, nom_sci, num_nom_retenu FROM bdtfx_v2_00 WHERE nom_sci =
// (SELECT nom_sci FROM bdtfx_v2_00 WHERE num_nom = X);
$this->format_reponse .= '/homonymie';
$this->requete_condition = 'nom_sci = (SELECT nom_sci FROM '.$this->table
.' WHERE '.$this->requete_condition.')';
}
public function traiterRessourceIdFlores() {
$champ_flores = '';
foreach ($this->champs_table as $champ) {
if (preg_match('/^flore_.*$/', $champ)) {
$champ_flores .= ', '.$champ;
}
}
$this->format_reponse .= '/flores';
$this->requete_champ = 'num_nom'.$champ_flores;
}
public function traiterRessourceStatsRangs() {
// SELECT count(*) as nombre, rang FROM bdtfx_v2_00 [WHERE rang = 290] GROUP BY rang ORDER BY rang;
$this->format_reponse .= '/rangs';
$this->requete_champ = 'count(*) as nombre, rang ';
$this->requete_group_by = ' GROUP BY rang ORDER BY rang ';
}
public function traiterRessourceStatsAnnees() {
// SELECT count(*) as nombre, annee FROM bdtfx_v2_00 GROUP BY annee ORDER BY annee;
$this->format_reponse .= '/annees';
$this->requete_champ = 'count(*) as nombre, annee ';
$this->requete_condition = '';
$this->requete_group_by = ' GROUP BY annee ORDER BY annee ';
}
public function traiterRessourceStatsInitiales() {
// SELECT count(left( nom_sci, 2 )) as nb, rang, left(nom_sci, 2) as lettre GROUP BY rang, left(nom_sci, 2);
$this->format_reponse .= '/initiales';
$this->requete_condition = '';
$this->requete_champ = 'count(left( nom_sci, 2 )) as nb, rang, left(nom_sci, 2) as lettre ';
$this->requete_group_by = ' GROUP BY rang, left(nom_sci, 2)';
}
//-----------------------------FONCTIONS DASSEMBLAGE DE LA REQUETE-----------------------------------------------------
public function assemblerLaRequete() {
if ( strrpos($this->format_reponse, 'noms/stats/') === false ) {
$this->mettreAuFormat(); //Ds CommunNomsTaxons.php
}
if ($this->requete_condition != '') {
$this->requete_condition = ltrim($this->requete_condition, ' AND, WHERE');
$this->requete_condition = ' WHERE '.$this->requete_condition;
}
if ($this->format_reponse != 'noms' && $this->format_reponse != 'noms/id/relations/synonymie' && $this->format_reponse != 'noms/id/relations/homonymie') {
$this->requete_limite = '';
} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
$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'];
} else {
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
}
$requete = ' SELECT '.$this->requete_champ.
' FROM '.$this->table
.$this->requete_condition
.$this->requete_group_by
.$this->requete_limite;
return $requete;
}
 
/**
* Recupere le nombre total de résultat d'une requete lancée.
* Est utilisée lors de l'affichage du total dans le résultat retourné et pr déterminer les limites et départ
* @return nombre total de résultat
*/
public function recupererTotalResultat() {
$total = null;
$requete = 'SELECT count(*) as nombre FROM '.$this->table.$this->requete_condition.$this->requete_group_by;
$res = $this->getBdd()->recuperer($requete);
if ($res) {
$total = $res['nombre'];
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Fct recupererTotalResultat() : <br/>Donn&eacute;es introuvables dans la base');
}
return $total;
}
//-------------------FONCTIONS POUR LE FORMATAGE EN JSON----------------------------------------------------------------
/**
* Permet de récupérer le résultat à retourner propre à chaque requete et de l'encoder en json
* @param array $resultat
* @param array $ressources
* @return le résultat encoder en json
*/
public function retournerResultatFormate($resultat) {
switch ($this->format_reponse) {
case 'noms/id' : $reponse = $this->formaterId($resultat); break; //ds CommunNomsTaxons
case 'noms/id/champ' : $reponse = $this->formaterIdChamp($resultat); break; //ds CommunNomsTaxons
case 'noms/id/relations' : $reponse = $this->formaterIdRelations($resultat); break;
case 'noms/id/relations/synonymie' : $reponse = $this->formaterIdSynonymie($resultat); break;
case 'noms/id/relations/homonymie' : $reponse = $this->formaterIdHomonymie($resultat); break;
case 'noms/id/relations/flores' : $reponse = $this->formaterIdFlores($resultat); break; //ds CommunsNomsTaxons
case 'noms/stats/annees' : $reponse = $this->formaterStatsAnnee($resultat); break; //ds CommunNomsTaxons
case 'noms/stats/rangs' : $reponse = $this->formaterStatsRang($resultat); break; //ds CommunNomsTaxons
case 'noms/stats/initiales' : $reponse = $this->formaterStatsInitiales($resultat); break; //ds CommunNomsTaxons
case 'noms' : $reponse = $this->formaterNoms($resultat); break;
default : break;
}
return json_encode($reponse);
}
//----------------------concerne les resultats pour des requetes de type noms/id----------------------------------------
/**
* Formate et retourne toutes les relations correpondant au nom recherché : les flores, les synonyme et les homonymes
* @param array $resultat
*/
public function formaterIdRelations($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
$res_version = $res_version[0];
$this->resultat_req = $res_version;
$retour_id_rel = array ('entete' => array()); //on initialise pr que l'entete apparaisse en premier lors de l'affichage
//on recupère le resultat de chaque relation (appel du WS correspondant)
$flores = $this->ajouterRelations('flores', $version);
if (isset($flores)) $retour_id_rel['resultat']['flores'] = $flores;
$homonymes = $this->ajouterRelations('homonymie', $version);
if (isset($homonymes)) $retour_id_rel['resultat']['homonymes'] = $homonymes;
$synonymes = $this->ajouterRelations('synonymie', $version);
if (isset($synonymes)) $retour_id_rel['resultat']['synonyme'] = $synonymes;
//on renvoit un tableau null si il n'existe aucune relations (on efface l'entete en premier lieu)
if (!isset($retour_id_rel['resultat'])) {
$retour_id_rel = null;
//on rajoute l'entete si des relations existent
} else {
$this->afficherDonnees('num_nom', $this->table_ressources[0]);
$retour_id_rel['entete'] = $this->table_retour;
$this->table_retour = array();
}
//recuperation du resultat de chaque version
$res = $this->afficherVersionOuPas($version, $retour_id_rel, $res);
}
return $res;
}
/**
* Recupere les relations (type de la relation passée en paramètres :[type_relation] = synonymie, homonymie ou
* flores) par l'appel du web service [version]/noms/#id/relations/[type_relation]
* @param String $relation
* @param String $version (numéro de la version)
*/
public function ajouterRelations($relation, $version) {
$version = str_replace(Config::get('bdd_table').'_v', '', $version);
$res = null;
$parametres_url = '';
if ($this->table_param != array()) $parametres_url = '?'.http_build_query($this->table_param, '', '&');
$url = Config::get('url_service').'/'.$version.'/'.$this->service.'/'.$this->table_ressources[0].'/relations/'
.$relation.$parametres_url;
$relation = $this->rest_client->consulter($url);
$entete = $this->rest_client->getReponseEntetes();
//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
if (isset($entete['wrapper_data'])) {
$relation = json_decode($relation);
if (isset($relation->resultat)) {
$res = $relation->resultat;
}
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Le service '.$this->service.' de ce projet comporte des erreurs. url lancée : '.$url);
}
return $res;
}
/**
* Formate et retourne toutes les synonymes correpondants au nom recherché
* @param array $resultat
*/
public function formaterIdSynonymie($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
$retour_id_syn = array();
if ($res_version[0]['num_nom_retenu'] == '') {
$retour_id_syn[] = 'nom_retenu N.D.';
} elseif (count($res_version) != 1) {
//on remplit d'abord l'entete du resultat
$this->table_retour['id'] = $this->table_ressources[0];
$this->afficherEnteteRangBorneTotalUrls($res_version, '/'.$this->service.'/'.$this->table_ressources[0].'/relations/synonymie');
$retour_id_syn['entete'] = $this->table_retour;
$this->table_retour = array();
//on remplit ensuite les resultats
foreach ($res_version as $tab) {
//pour chaque basionyme, on recupère le résultat : num_nom, nom_sci, basionyme et num_nom_retenu :
$this->resultat_req = $tab;
foreach ($tab as $key => $val) {
if ($val != '') {
switch ($key) {
case 'num_nom_retenu' : $retenu = ($val == $num) ? 'true' : 'false';
$this->table_retour['retenu'] = $retenu; break;
case 'basionyme' : $this->afficherDonnees($key, $val); break;
case 'num_nom' : $num = $val;
$this->afficherDonnees($key, $val);
unset($this->table_retour['id']); break;
default : break;
}
}
}
$retour_id_syn['resultat'][$num] = $this->table_retour;
$this->table_retour = array();
}
}
if (!isset($retour_id_syn['resultat']) && !in_array('nom_retenu N.D.', $retour_id_syn)) {
$retour_id_syn = null; //on initialise le resultat à null
}
$res = $this->afficherVersionOuPas($version, $retour_id_syn, $res);
}
return $res;
}
/**
* Formate et retourne toutes les homonymes correpondants au nom recherché
* @param array $resultat
*/
public function formaterIdHomonymie($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
if (count($res_version) != 1) {
$this->table_retour['id'] = $this->table_ressources[0];
$this->afficherEnteteRangBorneTotalUrls($res_version, '/'.$this->service.'/'.$this->table_ressources[0].'/relations/homonymie');
$retour_id_hom['entete'] = $this->table_retour;
$this->table_retour = array();
foreach ($res_version as $homonyme) {
$this->resultat_req = $homonyme;
$id = $homonyme['num_nom'];
$this->afficherDonnees('num_nom', $id);
if ($homonyme['num_nom_retenu'] != '') {
$retenu = ($id == $homonyme['num_nom_retenu']) ? 'true' : 'false';
$this->table_retour['retenu'] = $retenu;
}
$retour_id_hom['resultat'][$id] = $this->table_retour;
unset($retour_id_hom['resultat'][$id]['id']);
$this->table_retour = array();
}
} else {
$retour_id_hom = null;
}
$res = $this->afficherVersionOuPas($version, $retour_id_hom, $res);
}
return $res;
}
public function formaterIdFlores($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp,noms_projets');
$res = array();
foreach ($resultat as $version => $res_version) {
$res_version = $res_version[0];
$this->resultat_req = $res_version;
$id = array_shift($res_version);
//-----formatage de l'entete du résultat
$reponse['entete']['id'] = $id;
//-----formatage du résultat
$total = 0;
foreach ($res_version as $flores => $valeur) {
if ($valeur != '' && $valeur != '0') {
$this->afficherInfosFlore($res_version, $flores, $valeur);
$total++;
}
}
$reponse['entete']['total'] = $total;
if ($this->table_retour != array()) {
$reponse['resultat'] = $this->table_retour;
$this->table_retour = array();
} else {
$reponse = null;
}
//Si les infos de plrs versions sont renvoyés, on ajoute au tableau de resultat le numéro de la version
$res = $this->afficherVersionOuPas($version, $reponse, $res);
}
return $res;
}
public function afficherInfosFlore(&$resultat, $flores, $valeur) {
$flore = substr($flores,0,strrpos($flores, '_'));
if (strrpos($flores, 'num') !== false) {
$projet = $this->noms_projets[$flore];
if (preg_match('/^([0-9]+)(?:[.]syn[^a-z]*|(.*))?$/', $valeur, $match)) {
$this->table_retour[$flore]['id'] = $match[1];
$this->table_retour[$flore]['href'] = $this->ajouterHrefAutreProjet('noms', $match[1], $projet);
if (isset($match[2]) && $match[2] != '') $this->table_retour[$flore]['cle'] = $match[2];
}
if (isset($resultat[$flore.'_rem']) && !empty($resultat[$flore.'_rem'])) {
$this->table_retour[$flore]['remarque'] = $resultat[$flore.'_rem'];
unset($resultat[$flore.'_rem']);
}
} elseif (strrpos($flores,'belge') !== false) {
$projet = $this->noms_projets[$flore];
if (preg_match('/^([0-9]+) (R|S)?$/', $valeur, $match)) {
if (isset($match[2])) $type = ($match[2] == 'R') ? 'taxons' : 'synonyme';
$this->table_retour[$flore]['page'] = $match[1];
$this->table_retour[$flore]['type'] = $type;
//$this->table_retour[$flore]['href'] = $this->ajouterHrefAutreProjet('noms', $match[1], $projet);
}
}
}
//----------------------concerne les resultats pour des requetes de type /noms avec ou sans paramètres------------------
 
/**
*
* Est utilisée pour les requetes de type /noms avec ou sans parametres. Détermine le format json ou oss.
* @param retourne le résultat sous forme de tableau, à encoder en json.
*/
public function formaterNoms($resultat) {
if ($this->retour_format == 'oss') {
$reponse = $this->formaterEnOss($resultat); //Ds CommunNomsTaxons.php
} else {
$reponse = $this->formaterEnJsonMax($resultat);
}
return $reponse;
}
 
/**
*
* Permet de créer un tableau ($table_retour_json) au format defaut puis de l'encoder en json (json_encode).
* Le format comprend deux parties, une partie entete (contenu dans le tableau $entete_json) et une partie
* resultat (contenu dans le tableau $resultat_json).
* @param string $resultat : résultat de la requete (liste des noms et leur identifiant)
* @return une chaine encodé json (format par default)
*/
public function formaterEnJsonMax($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
//on remplit la table $table_retour_json['entete']
$masque = $this->ordonnerMasque();
if ($masque != '') $this->table_retour['masque'] = $masque;
$this->afficherEnteteRangBorneTotalUrls($res_version, '/'.$this->service);
$table_retour_json['entete'] = $this->table_retour;
$this->table_retour = array();
//on remplit la table $table_retour_json['resultat']
foreach ($res_version as $tab) {
$this->resultat_req = $tab;
foreach ($tab as $key => $val) {
if ($val != '') {
switch ($key) {
case 'num_nom' : $num = $val;
$this->afficherDonnees($key, $val); break;
case 'nom_sci' : if ($this->retour_format == 'min') {
// sinon est affiché ds afficherDonnees(num_nom, $val) ci-dessus
$this->table_retour[$key] = $val.$this->ajouterCompositionNom($tab);
} break;
case 'num_nom_retenu' :
$retenu = ($val == $num) ? 'true' : 'false';
$this->table_retour['retenu'] = $retenu; break;
default : break;
}
unset($this->table_retour['id']);
}
}
$resultat_json[$num] = $this->table_retour;
$this->table_retour = array();
}
$table_retour_json['resultat'] = $resultat_json;
$res = $this->afficherVersionOuPas($version, $table_retour_json, $res);
}
return $res;
}
 
}
?>
Property changes:
Added: svn:executable
+*
\ No newline at end of property
/tags/v5.2-alpage/services/modules/0.1/coste/Taxons.php
New file
0,0 → 1,732
<?php
 
// declare(encoding='UTF-8');// ou ISO-8859-15
/**
* Description :
* Classe Taxons.php permettant de fournir des informations sur les noms scientifiques retenu.
* Si l'url finit par /taxons on retourne une liste de noms latin et leurs identifiants (seulement les 100 premeiers noms par défaut).
* L'url peut contenir des paramètres optionnels passés après le ? : /taxons?param1=val1&param2=val2&...
*
* Les paramètres de requête disponibles sont : masque, recherche, rang, distinct, retour.format, nl.format,
* nl.structure, navigation.depart et navigation.limite.
*
* Encodage en entrée : utf8
* Encodage en sortie : utf8
* @package framework-v3
* @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 Taxons extends CommunNomsTaxons {
/**
* Valeur du paramètre de requete recherche stricte, etendue, floue */
protected $recherche = false;
/** Permet de stocker la requete formulée :
* - taxons | taxons/#id | taxons/#id/#champ+#champ
* - taxons/#id/relations | taxons/#id/relations/synonymie | taxons/#id/relations/homonymie
* | taxons/#id/relations/flores | taxons/#id/relations/superieurs | taxons/#id/relations/inferieurs
* - taxons/stats/rangs | taxons/stats/annees | taxons/stats/initiales */
protected $format_reponse = 'taxons';
/** Représente la première partie de la requete SQL (entre le SELECT et le WHERE)*/
protected $requete_champ = 'num_nom, nom_sci, num_nom_retenu, num_tax ';
/** Représente la partie de la requete SQL ajoutant une condition (WHERE ...)*/
protected $requete_condition = 'num_nom = num_nom_retenu ';
/** Représente la partie GROUP BY de la requete SQL (GROUP BY ...) */
protected $requete_group_by = ' ';
/** Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés). */
protected $limite_requete = array('depart' => 0, 'limite' => 100);
/** Stocke le num_nom du nom retenu du num_nom recherché */
protected $num_nom_taxon;
protected $service = 'taxons';
protected $presence_num_tax = true;
public function consulter($ressources, $parametres) {
$resultat_formate = '';
$this->initialiserRestClient(); //création d'un objet RestClient
$this->traiterParametres($parametres);
$this->traiterVersionProjet($ressources) ;
if ($this->corps_http == '' && $this->entete_http == '') {
foreach ($this->table_version as $version) {
$this->table = $version; //on stocke ici la table correspondant à la version du projet analysée
$this->recupererNomChamp($this->table);
$this->gererNumTax();
$this->traiterRessources($ressources);
if ($this->corps_http == '' && $this->entete_http == '') {
$requete = $this->assemblerLaRequete();
$resultat = $this->getBdd()->recupererTous($requete);
if ($resultat == '') { //cas ou la requete comporte des erreurs
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Fct consulter() : La requete form&eacute;e comporte une erreur !!');
} elseif ($resultat) {
$res_version[$version] = $resultat;
} else { //cas ou la requete renvoi un tableau vide
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Donn&eacute;es introuvables dans la base '.$version.' <br/>
L\'identifiant demande n\'est pas un taxon et aucun taxon ne lui a ete attribue');
}
}
}
}
if ($this->corps_http == '' && $this->entete_http == '') {
$resultat_formate = $this->retournerResultatFormate($res_version);
}
$this->formerReponseHTTP($resultat_formate);
}
 
 
/**
*
* Permet d'analyser les paramètres
* @param array $parametres
*/
public function traiterParametres($parametres) {
$this->table_param = $parametres;
if (isset($parametres) && ($parametres)) {
if (isset($parametres['recherche']) && $parametres['recherche'] != '') {
$this->recherche = $parametres['recherche'];
}
foreach ($parametres as $param => $val) {
switch ($param) {
case 'ns_format' : $this->html = $val; break;
case 'ns_structure' : $this->remplirTableCompositionNom($val);
$this->requete_champ .= ' ,'.implode(', ',$this->compo_nom); break;
case 'masque' : $this->ajouterFiltreMasque($val); break;
case 'masque_nt' : $this->ajouterFiltreMasqueNt($val); break;
case 'masque_rg' : $this->requete_condition .= ' AND rang = '.$this->getBdd()->proteger($val); break;
case 'navigation_depart': $this->limite_requete['depart'] = $val; break;
case 'navigation_limite': $this->limite_requete['limite'] = $val; break;
case 'retour_format' : $this->retour_format = $val; break;
case 'recherche' : break;
default : $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans les parametres de recherche de votre
requete : </br> Le parametre " '.$param.' " n\'existe pas.');
break;
}
}
}
}
public function ajouterFiltreMasque($val) {
if ($this->recherche == 'etendue') {
$val = str_replace(' ','%', $val);
$val .= '%';
$this->requete_condition .= ' AND nom_sci LIKE '.$this->getBdd()->proteger($val);
} elseif ($this->recherche == 'floue') {
$this->requete_condition .= ' AND (SOUNDEX(nom_sci) = SOUNDEX(\''.$val.'\')'
.' OR SOUNDEX(REVERSE(nom_sci)) = SOUNDEX(REVERSE(\''
.$val.'\'))) ';
} else {
$this->requete_condition .= ' AND nom_sci LIKE '.$this->getBdd()->proteger($val);
}
}
public function ajouterFiltreMasqueNt($val) {
if (strrpos($val, ',') !== false) {
$ids_taxon = explode(",", $val);
} else {
$ids_taxon[] = $val;
}
foreach ($ids_taxon as $id) {
$this->requete_condition .= ' OR num_tax = '.$this->getBdd()->proteger($id);
}
$this->requete_condition = str_replace('num_nom = num_nom_retenu OR ',
'num_nom = num_nom_retenu AND (' , $this->requete_condition).')';
}
/**
* Permet d'ajouter à la requete_champ les parametres demandés qui composeront le nom_sci.
* Permet de remplir le tableau compo_nom qui regroupe les parametres demandés qui composeront le nom_sci.
* (parametres à ajouter aux nom_sci sous la forme : Auteur [annee, biblio] [addendum])
* @param la valeur du parametre nl.structure
*/
public function recupererParametreNom($valeur) {
$structure_nom = explode(",",$valeur);
foreach ($structure_nom as $structure) {
switch ($structure) {
case 'au' : $this->compo_nom['au'] = 'auteur'; break;
case 'an' : $this->compo_nom['an'] = 'annee'; break;
case 'bib' : $this->compo_nom['bib'] = 'biblio_origine'; break;
case 'ad' : $this->compo_nom['ad'] = 'nom_addendum'; break;
default : $this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur : Le parametre "'.$structure.'" n\'existe pas. <br/><br/>
Les parametres du nom possibles sont :
<li> au (auteur)</li><li> an (annee)</li>
<li> bib (bibliographie)</li><li> ad (nom_addendum)</li>');
break;
}
}
if (isset($this->compo_nom)) {
$this->requete_champ .= ' ,'.implode(', ',$this->compo_nom);
}
}
//------------------------------------------Fonction ressources---------------------------------------------------------------------
public function gererNumTax() {
if (!in_array('num_tax', $this->champs_table)) {
$this->presence_num_tax = false;
$this->requete_champ = str_replace(', num_tax ', '', $this->requete_champ);
} else {
$this->presence_num_tax = true;
}
}
public function traiterRessourcesIdentifiant() {
$this->format_reponse = 'taxons/id';
$this->num_nom_taxon = $this->recupererNumNomTaxon(); //on recupere le taxon correspondant au num_nom recherché
if ($this->entete_http == '') {
$this->requete_condition = ' num_nom = '.$this->num_nom_taxon;
if (isset($this->table_ressources[1]) && !empty($this->table_ressources[1])) {
//---------------- requete de type taxons/#id/#champ+#champ--------------------------------------
if ($this->table_ressources[1] != 'relations') {
// SELECT *, nom_sci FROM bftfx_v2_00 WHERE num_nom = X;
$this->requete_champ = ' *, nom_sci ';
$this->format_reponse .= '/champ';
//---------------- requete de type taxons/#id/relations/#relation--------------------------------
} elseif ($this->table_ressources[1] == 'relations') {
$this->traiterRessourceIdRelations();
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requete </br> Ressources disponibles : <br/>
<li> #id/relations </li> <li> #id/#champ+#champ </li> <li> #id/relations </li>
<li> #id/relations/inferieurs </li> <li> #id/relations/superieurs </li>');
}
} else {
//--------------- requete de type taxons/#id-----------------------------------------------------
$this->requete_champ = ' *, nom_sci ';
}
}
}
/**
* Permet de récupérer le num_nom du taxon recherché. Soit le numéro taxonomique est demandé (avec nt: )
* soit un num_nom dont on recherche le num_nom_retenu
*/
public function recupererNumNomTaxon() {
$identifiant = '';
if (strrpos($this->table_ressources[0], 'nt:') !== false) {
if ($this->presence_num_tax) {
// SELECT num_nom FROM bdtfx_v2_00 WHERE num_nom = num_nom_retenu AND num_tax = X;
$this->requete_condition = ' num_nom = num_nom_retenu AND num_tax = '
.str_replace('nt:', '', $this->table_ressources[0]).' ';
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requete : </br> Le numero taxonomique n\'existe pas dans ce projet' );
}
} else {
// SELECT num_nom FROM bdtfx_v2_00 WHERE num_nom = (SELECT num_nom_retenu FROM bdtfx_v2_00 WHERE num_nom = X);
$this->requete_condition = ' num_nom = (SELECT num_nom_retenu FROM '
.$this->table.' WHERE num_nom = '.$this->table_ressources[0].')';
}
if ($this->entete_http == '') {
//on récupere l'identifiant du taxon correspondant au num_nom ou num_tax demandé pour pouvoir l'afficher
$res = '';
$req_tax = 'SELECT num_nom FROM '.$this->table.' WHERE '.$this->requete_condition;
$res_tax = $this->getBdd()->recuperer($req_tax);
//on recherche ensuite les identifiants des taxons supérieurs ou inférieurs
if ($res_tax == '') {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Le numéro de taxon ou l\'identifiant de nom correspondant au num_nom '
.$this->table_ressources[0].' n\'existe pas dans la table '.$this->table);
} elseif ($res_tax) {
$identifiant = $res_tax['num_nom'];
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Le numéro de taxon ou l\'identifiant de nom correspondant au num_nom '
.$this->table_ressources[0].' n\'existe pas dans la table '.$this->table);
}
}
return $identifiant;
}
public function traiterRessourceIdRelations() {
//----------------- requete de type taxons/#id/relations-------------------------------------------
// SELECT *, nom_sci FROM bftfx_v2_00 WHERE num_nom = X;
$this->format_reponse .= '/relations';
if (isset($this->table_ressources[2])) {
//------------- requete de type taxons/#id/relations/#relation--------------------------------
switch ($this->table_ressources[2]) {
case 'superieurs' : $rel = 'recupererIdSup';
$this->format_reponse .= '/superieurs';
$this->traiterRessourceIdRelationInfSup($rel); break;
case 'inferieurs' : $rel = 'recupererIdInf';
$this->format_reponse .= '/inferieurs';
$this->traiterRessourceIdRelationInfSup($rel); break;
default : $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,
'Erreur dans votre requ&ecirc;te </br> Ressources disponibles : <br/>
<li> taxons/#id/relations </li> <li> taxons/#id/relations/flores </li>
<li> taxons/#id/relations/homonymie </li> <li> #id/relations/inferieurs </li>
<li> #id/relations/superieurs </li>'); break;
}
}
}
 
 
public function traiterRessourceIdRelationInfSup($rel) {
//Appel de la fct récupérerIdSup ou recupererIdInf : retourne les num_nom des noms inferieurs ou superieurs
$res_relation = $this->$rel();
//analyse du résultat retourné par la requete de recherche des identifiants correspondant aux taxons inf|sup :
if ($res_relation == '') { //dans le cas ou la requete comporte des erreurs
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Fct traiterRessourceIdHomonymie : La requete forme comporte une erreur !!');
} elseif ($res_relation) {
//dans le cas ou une ou plusieurs relations est retournée, on récupère les identifiants ss la forme (id, id, id)
foreach ($res_relation as $ligne) $res[] = $ligne['num_nom'];
$res = implode(',',$res);
$this->requete_condition = ' num_nom IN ('.$res.')';
$this->requete_champ .= ', rang, num_tax_sup ';
} else { //dans le cas ou aucune relation n'existe
$res = array($this->num_nom_taxon => null);
$this->corps_http = json_encode($res);
$this->entete_http = RestServeur::HTTP_CODE_OK;
}
}
public function recupererIdInf() {
//SELECT num_nom FROM bfdtx_v2_00 WHERE num_tax_sup = (SELECT num_nom FROM bdtfx_v2_00 WHERE num_nom = X);
$req_relation = 'SELECT num_nom FROM '.$this->table
.' WHERE num_tax_sup = (SELECT num_nom FROM '
.$this->table
.' WHERE '.$this->requete_condition.')';
$res_relation = $this->getBdd()->recupererTous($req_relation);
return $res_relation;
}
public function recupererIdSup() {
//SELECT num_nom FROM bfdtx_v2_00 WHERE num_nom = (SELECT num_tax_sup FROM bdtfx_v2_00 WHERE num_nom = X);
$req_relation = 'SELECT num_nom FROM '.$this->table
.' WHERE num_nom = (SELECT num_tax_sup FROM '
.$this->table
.' WHERE '.$this->requete_condition.')';
$res_relation = $this->getBdd()->recupererTous($req_relation);
return $res_relation;
}
 
public function traiterRessourceStatsInitiales() {
// SELECT count(nom_sci) as nb, rang, left(nom_sci, 2) as lettre FROM bdtfx_v2_00 GROUP BY rang, left(nom_sci, 2);
$this->format_reponse = 'taxons/stats/initiales';
$this->requete_champ = 'count(nom_sci) as nb, rang, left(nom_sci, 2) as lettre ';
$this->requete_group_by = ' GROUP BY rang, left(nom_sci, 2) ';
}
public function traiterRessourceStatsRangs() {
// SELECT count(*) as nombre, rang FROM bdtfx_v2_00 [WHERE rang = 290] GROUP BY rang ORDER BY rang;
$this->format_reponse = 'taxons/stats/rangs';
$this->requete_champ = 'count(*) as nombre, rang ';
$this->requete_group_by = ' GROUP BY rang ORDER BY rang ';
}
public function traiterRessourceStatsAnnees() {
// SELECT count(*) as nombre, annee FROM bdtfx_v2_00 GROUP BY annee ORDER BY annee;
$this->format_reponse = 'taxons/stats/annees';
$this->requete_champ = 'count(*) as nombre, annee ';
$this->requete_group_by = ' GROUP BY annee ORDER BY annee ';
}
//-----------------------------FONCTIONS DASSEMBLAGE DE LA REQUETE-----------------------------------------------------
public function assemblerLaRequete() {
if ($this->format_reponse != 'taxons/stats/initiales') {
$this->mettreAuFormat(); //on remplace les nom_sci par les nom_sci_html
}
if ($this->requete_condition != '') {
$this->requete_condition = ltrim($this->requete_condition, ' AND, WHERE');
$this->requete_condition = ' WHERE '.$this->requete_condition;
}
if ($this->format_reponse != 'taxons' && $this->format_reponse != 'taxons/id/relations/homonymie') {
$this->requete_limite = '';
} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat = $this->recupererTotalResultat())) {
$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'];
} else {
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
}
$requete = ' SELECT '.$this->requete_champ.
' FROM '.$this->table
.$this->requete_condition
.$this->requete_group_by
.$this->requete_limite;
return $requete;
}
/**
* Recupere le nombre total de résultat d'une requete lancée.
* Est utilisée lors de l'affichage du total dans le résultat retourné
* @return Le nombre total de résultat
*/
public function recupererTotalResultat() {
$requete = 'SELECT count(*) as nombre FROM '.$this->table.$this->requete_condition.$this->requete_group_by;
$res = $this->getBdd()->recuperer($requete);
if ($res) {
$total = $res['nombre'];
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Fct recupererTotalResultat() : <br/>Donn&eacute;es introuvables dans la base');
}
return $total;
}
 
//-------------------------FONCTIONS DE FORMATION DU RESULTAT-----------------------------------------------------------
/**
* Permet de récupérer le résultat à retourner propre à chaque requete et de l'encoder en json
* @param array $resultat
* @param array $ressources
* @return le résultat encoder en json
*/
public function retournerResultatFormate($resultat) {
switch ($this->format_reponse) {
case 'taxons/id' : $reponse = $this->formaterId($resultat); break; //ds CommunNomsTaxons
case 'taxons/id/champ' : $reponse = $this->formaterIdChamp($resultat); break; //ds CommunNomsTaxons
case 'taxons/id/relations' : $reponse = $this->formaterIdRelations($resultat); break;
case 'taxons/id/relations/superieurs' : $reponse = $this->formaterIdSuperieur($resultat); break;
case 'taxons/id/relations/inferieurs' : $reponse = $this->formaterIdInferieur($resultat); break;
case 'taxons/stats/annees' : $reponse = $this->formaterStatsAnnee($resultat); break; //ds CommunNomsTaxons
case 'taxons/stats/rangs' : $reponse = $this->formaterStatsRang($resultat); break; //ds CommunNomsTaxons
case 'taxons/stats/initiales' : $reponse = $this->formaterStatsInitiales($resultat); break; //ds CommunNomsTaxons
case 'taxons' : $reponse = $this->formatertaxons($resultat); break;
default : break;
}
return json_encode($reponse);
}
//----------------------concerne les resultats pour des requetes de type /noms avec ou sans paramètres--------------
/**
*
* Est utilisée pour les requetes de type /noms avec ou sans parametres. Détermine le format json ou oss.
* @param retourne le résultat sous forme de tableau, à encoder en json.
*/
public function formaterTaxons($resultat) {
if ($this->retour_format == 'oss') {
$reponse = $this->formaterEnOss($resultat);
} else {
$reponse = $this->formaterEnJsonMax($resultat);
}
return $reponse;
}
/**
*
* Permet de créer un tableau ($table_retour_json) au format defaut puis de l'encoder en json (json_encode).
* Le format comprend deux parties, une partie entete (contenu dans le tableau $entete_json) et une partie
* resultat (contenu dans le tableau $resultat_json).
* @param string $resultat : résultat de la requete (liste des noms et leur identifiant)
* @return une chaine encodé json (format par default)
*/
public function formaterEnJsonMax($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
//on remplit la table $table_retour_json['entete']
if (isset($this->table_param['masque'])) $this->afficherDonnees('masque', $this->table_param['masque']);
if (isset($this->table_param['masque_nt'])) $this->afficherDonnees('masque.nt', $this->table_param['masque_nt']);
$this->afficherEnteteRangBorneTotalUrls($res_version, '/'.$this->service);
$table_retour_json['entete'] = $this->table_retour;
$this->table_retour = array();
//on remplit la table $table_retour_json['resultat']
$tab_tax_inf = $this->recupererListeTaxonInf($res_version);
foreach ($res_version as $tab) {
$this->resultat_req = $tab;
if (isset($this->table_param['masque_nt'])) $this->afficherDonnees('num_tax', $tab['num_tax']);
foreach ($tab as $key => $val) {
if ($val != '') {
switch ($key) {
case 'num_nom' : $num = $val;
$this->afficherDonnees($key, $val); break;
case 'num_nom_retenu' : $retenu = ($val == $num) ? 'true' : 'false';
$this->table_retour['retenu'] = $retenu; break;
default : break;
}
}
}
$this->afficherTaxonInfNb($num, $tab_tax_inf);
unset($this->table_retour['id']);
$resultat_json[$num] = $this->table_retour;
$this->table_retour = array(); //on vide le tableau table_retour
}
$table_retour_json['resultat'] = $resultat_json;
$res = $this->afficherVersionOuPas($version, $table_retour_json, $res);
}
return $res;
}
//--------------------concerne les resultats pour des requetes de type noms/id----------------------------------------
 
public function formaterIdRelations($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
$this->resultat_req = $res_version;
$retour_id_rel = array ('entete' => array()); //on initialise pr que l'entete apparaisse en premier
//on affiche le resultat
$superieurs = $this->ajouterRelations('superieurs', $version);
if (isset($superieurs)) $retour_id_rel['resultat']['superieurs'] = $superieurs;
$inferieurs = $this->ajouterRelations('inferieurs', $version);
if (isset($inferieurs)) $retour_id_rel['resultat']['inferieurs'] = $inferieurs;
//on renvoit un tableau null si il n'existe aucune relations
if (!isset($retour_id_rel['resultat'])) {
$retour_id_rel = null;
 
//on rajoute l'entete si des relations existent
} else {
$this->afficherDonnees('num_nom', $this->num_nom_taxon); //$this->afficherEnteteRangBorneTotalUrls($resultat, '/'.$this->service.'/'.$this->table_ressources[0].'/relations/synonymie');
$retour_id_rel['entete'] = $this->table_retour;
$this->table_retour = array();
}
//recuperation du resultat de chaque version
$res = $this->afficherVersionOuPas($version, $retour_id_rel, $res);
}
return $res;
}
public function ajouterRelations($relation, $version) {
$version = str_replace(Config::get('bdd_table').'_v', '', $version);
$res = null;
$taxon = $this->num_nom_taxon;
$parametres_url = '';
if ($this->table_param != array()) $parametres_url = '?'.http_build_query($this->table_param, '', '&');
$url = Config::get('url_service').'/'.$version.'/'
.$this->service.'/'.$this->table_ressources[0].'/relations/'
.$relation.$parametres_url;
$relation = $this->rest_client->consulter($url);
$entete = $this->rest_client->getReponseEntetes();
//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
if (isset($entete['wrapper_data'])) {
$relation = json_decode($relation);
if (isset($relation->resultat)) {
$res = $relation->resultat;
} elseif (isset($relation->$taxon)) { //pour les relations inf et sup
$res = $relation->$taxon;
}
} else {
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE,
'Le service '.$this->service.' de ce projet comporte des erreurs. url lancée : '.$url);
}
return $res;
}
 
public function formaterIdSuperieur($resultat) {
$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
$res = array();
foreach ($resultat as $version => $res_version) {
//on remplit le tableau de formatage
if (($res_version) != '' ) {
//on recupere d'abord les rangs supérieurs
$sup = $res_version[0];
do {
$sup = $this->recupererIdSuperieur($sup['num_tax_sup'], $version);
if ($sup['rang'] == '0') $sup['rang'] = '10'; //erreur dans la base
if (isset($sup)) $res_version[] = $sup;
} while ($sup != null);
krsort($res_version);
//on les affiche ensuite
foreach ($res_version as $tab) {
$this->resultat_req = $tab;
foreach ($tab as $key => $val) {
if ($val != '') {
switch ($key) {
case 'num_nom' : $num = $val;
$this->afficherDonnees($key, $num); break;
case 'num_nom_retenu' : $retenu = ($val == $num) ? 'true' : 'false';
$this->table_retour['retenu'] = $retenu; break;
case 'rang' : $this->afficherDonnees($key, $val); break;
default : break;
}
}
}
unset($this->table_retour['id']);
$tab_inf[$num] = $this->table_retour;
$this->table_retour = array();
}
$tab_relation[$this->num_nom_taxon] = $tab_inf;
} else { //si il n'existe aucune relation
$tab_relation = null;
}
//recuperation du resultat de chaque version
$res = $this->afficherVersionOuPas($version, $tab_relation, $res);
}
return $res;
}
public function recupererIdSuperieur($id, $version) {
$req = 'SELECT num_nom, num_nom_retenu, num_tax_sup, rang FROM '
.$version.' WHERE num_nom = '.$this->getBdd()->proteger($id);
$res = $this->getBdd()->recupererTous($req);
if ($res) {
$resultat = $res[0];
} else {
$resultat = null; //on return null si il n'y a pas de taxon superieur
}
return $resultat;
}
public function formaterIdInferieur($resultat) {
$this->recupererTableSignification('champs_api,champs_comp,correspondance_champs');
$res = array();
foreach ($resultat as $version => $res_version) {
//on veut récupérer pour chacun des taxons inférieur le nb de taxons inf :
$tab_tax_inf = $this->recupererListeTaxonInf($res_version);
//on commence le formatage
if (($res_version) != '' ) {
foreach ($res_version as $tab) {
$this->resultat_req = $tab;
foreach ($tab as $key => $val) {
if ($val != '') {
switch ($key) {
case 'num_nom' : $num = $val;
$this->afficherDonnees($key, $num); break;
case 'num_nom_retenu' : $retenu = ($val == $num) ? 'true' : 'false';
$this->table_retour['retenu'] = $retenu; break;
default : break;
}
}
}
$this->afficherTaxonInfNb($num, $tab_tax_inf);
unset($this->table_retour['id']);
$tab_inf[$num] = $this->table_retour;
$this->table_retour = array(); //on vide le tableau table_retour
}
$tab_relation[$this->num_nom_taxon] = $tab_inf;
} else {
$tab_relation = null;
}
//recuperation du resultat de chaque version
$res = $this->afficherVersionOuPas($version, $tab_relation, $res);
}
return $res;
}
public function afficherTaxonInfNb($num, $tab_tax_inf) {
foreach ($tab_tax_inf as $taxNb) {
if ($taxNb['num_tax_sup'] == $num) {
$this->table_retour['taxon_inferieur_nbre'] = $taxNb['nb'];
}
}
if (!isset($this->table_retour['taxon_inferieur_nbre'])) {
$this->table_retour['taxon_inferieur_nbre'] = '0';
}
}
public function recupererListeTaxonInf($resultat) {
// SELECT num_tax_sup, count(*) as nb FROM bdtfx_v2_00 WHERE num_tax_sup IN (id, id, id) AND num_nom = num_nom_retenu GROUP BY num_tax_sup';
foreach ($resultat as $tab) {
$tab_num[] = $tab['num_nom']; //on regroupe ici les id des taxons dont on cherche le nb de taxon inf
}
$req = 'SELECT num_tax_sup, count(*) as nb FROM '.$this->table
.' WHERE num_tax_sup IN ('.implode(',',$tab_num)
.') AND num_nom = num_nom_retenu GROUP BY num_tax_sup';
$res = $this->getBdd()->recupererTous($req);
if ($res) {
$resultat = $res;
} else {
$resultat = array(); //on return un tableau vide s'il n'y a pas de taxon inférieurs
}
return $resultat;
}
}
 
?>
/tags/v5.2-alpage/services/modules/0.1/coste/Textes.php
New file
0,0 → 1,511
<?php
/*
* @copyright 2013 Tela Botanica (accueil@tela-botanica.org)
* @author Raphaël Droz <raphael@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>
*
* pattern: /service:eflore:0.1/coste/textes/bdtfx.nn:182,631
* params: txt.format=(htm|txt) , retour.champs=(titre,texte,...) , retour.format=(min|max), ...
*
* Ce webservice est censé pouvoir:
* 1) retourner des informations (choisies) à propos d'un ou plusieurs taxon(s) donné(s)
* (à partir de son numéro nomenclatural
* 2) retourner des informations (choisies) à propos de taxons recherchés
* (à partir de divers critères)
*
* TODO: masque.titre => masque.tag
* TODO: clarifier l'attribut "tag" retourné (tag de la description ou des clefs de détermination)
*
*/
 
// affecte le nombre d'ids autorisés dans le dernier segment d'URL
// *et* la valeur maximale autorisée pour navigation.limite.
define('_COSTE_TEXTE_MAX_RESULT_LIMIT', 500);
 
// simplifie et accélère la sanitization de l'input:
// SELECT MAX(num_nom) FROM coste_v2_00;
define('_COSTE_TEXTE_MAX_COSTE_NN', 7015 + 1000);
// SELECT MAX(page) FROM coste_v2_00;
define('_COSTE_TEXTE_MAX_COSTE_PAGE', 4126);
// SELECT MAX(tome) FROM coste_v2_00;
define('_COSTE_TEXTE_MAX_COSTE_TOME', 3);
// SELECT MAX(num_taxonomique) FROM coste_v2_00;
define('_COSTE_TEXTE_MAX_BDTFX_NT', 37809);
// SELECT MAX(num_nom) FROM bdtfx_v2_00;
define('_COSTE_TEXTE_MAX_BDTFX_NN', 120816 + 100000);
 
/* restore_error_handler();
error_reporting(E_ALL); */
class Textes {
// paramètres autorisés
static $allow_params = array(
'txt.format', 'retour.format', 'retour.champs', 'retour.indexBy',
'recherche',
'masque.ns', 'masque.txt', 'masque.page', 'masque.tome', 'masque.famille', 'masque.nt',
'masque.titre', // masque sur titre de la page wiki correspondante (page "clef" OR page "description")
'navigation.depart', 'navigation.limite');
// et valeurs par défaut
static $default_params = array('txt.format' => 'txt', 'retour.format' => 'max', 'retour.indexBy' => 'coste',
'recherche' => 'stricte',
'retour.champs' => 'titre,texte,determination,tag',
'navigation.depart' => 0, 'navigation.limite' => 50);
 
// les champs de base de coste_v2_00
// mysql -N tb_eflore<<<"SHOW FIELDS FROM coste_v2_00"|egrep -v 'page_'|awk '{print $1}'|xargs -i -n1 printf "'%s' => 'c.%s',\n" {} {}
static $allow_champs = array(
'coste:nn' => 'c.num_nom',
'bdtfx:nn' => 'IF(c.flore_bdtfx_nn = "",NULL,c.flore_bdtfx_nn)',
'bdtfx:nt' => 'c.flore_bdtfx_nt',
'num_nom' => 'c.num_nom',
'num_nom_retenu' => 'c.num_nom_retenu',
'num_tax_sup' => 'c.num_tax_sup',
'rang' => 'c.rang',
'nom_sci' => 'c.nom_sci',
'nom_supra_generique' => 'c.nom_supra_generique',
'genre' => 'c.genre',
'epithete_infra_generique' => 'c.epithete_infra_generique',
'epithete_sp' => 'c.epithete_sp',
'type_epithete' => 'c.type_epithete',
'epithete_infra_sp' => 'c.epithete_infra_sp',
'cultivar_groupe' => 'c.cultivar_groupe',
'cultivar' => 'c.cultivar',
'nom_commercial' => 'c.nom_commercial',
'auteur' => 'c.auteur',
'annee' => 'c.annee',
'biblio_origine' => 'c.biblio_origine',
'notes' => 'c.notes',
'nom_addendum' => 'c.nom_addendum',
'nom_francais' => 'c.nom_francais',
'nom_coste' => 'c.nom_coste',
'auteur_coste' => 'c.auteur_coste',
'biblio_coste' => 'c.biblio_coste',
'num_nom_coste' => 'c.num_nom_coste',
'num_nom_retenu_coste' => 'c.num_nom_retenu_coste',
'num_tax_sup_coste' => 'c.num_tax_sup_coste',
'synonymie_coste' => 'c.synonymie_coste',
'tome' => 'c.tome',
'page' => 'c.page',
'nbre_taxons' => 'c.nbre_taxons',
'flore_bdtfx_nn' => 'c.flore_bdtfx_nn',
'flore_bdtfx_nt' => 'c.flore_bdtfx_nt',
'image' => 'c.image',
'image_auteur' => 'c.image_auteur',
'nom_sci_html' => 'c.nom_sci_html',
 
// handly duplicate (redirigé vers nom_sci ou nom_sci_html selon que txt.format vaut "txt" ou "htm"
'titre' => 'c.nom_sci',
 
// champs spécifiques (et étrangères)
'texte' => 'dsc.body',
'determination' => 'cle.body',
'tag' => 'dsc.tag',
'famille' => 'b.famille', // cf sqlAddJoins()
'*' => 'XXX' // spécial
);
 
// les champs suivants disparaissent de la liste utilisée pour former la requête SQL
// (ils sont exclue lorsque '*' est utilisée, ce sont généralement des synonymes)
static $special_champs = array('nom_sci_html', 'nom_sci', '*', 'flore_bdtfx_nn', 'flore_bdtfx_nt', 'num_nom');
 
// ces champs sont toujours dans les résultats (cf sqlSelectFields()
static $champs_obligatoires = array('coste:nn', 'bdtfx:nn');
 
 
// le pattern utilisé pour la recherche dite "floue"
static $soundex_scheme = '(%1$s LIKE %2$s OR SOUNDEX(%1$s) = SOUNDEX(%2$s) OR SOUNDEX(REVERSE(%1$s)) = SOUNDEX(REVERSE(%2$s)))';
 
// contrainte du point d'entrée d'API webservice Tela lors d'un GET
public function consulter($ressources, $parametres, $db = NULL) {
if (!$db) {
// http_response_code(500);
throw new Exception('no DB', 500);
}
 
// parser la requête et filtrer les paramètres valides
// en cas d'accès HTTP
if (array_key_exists('QUERY_STRING', $_SERVER)) {
self::requestParse($uri, $params);
} else {// en cas d'accès phpunit
$uri = $ressources;
}
 
// renvoie du plain/text d'aide (cf fin de programme)
if (count($uri) == 1 && $uri[0] == 'aide') {
die(self::aide());
}
 
if (is_null($parametres)) {
$parametres = Array();
}
$params = self::requestFilterParams($parametres);
// les contraintes liées aux ids (passés comme composants d'URL)
// sont ajoutées aux params [sans être accepté comme paramètre d'URL]
$params['_ids'] = self::requestFilterIds($uri);
 
// XXX: temporaires, passage de $db aux fonctions
// de toolkits
$req = self::getCosteInfo($params, $db);
 
$res = $db->recupererTous($req);
$err = mysql_error();
if (!$res && $err) {
// http_response_code(400);
// if(defined('DEBUG') && DEBUG) header("X-Debug: $req");
throw new Exception('not found', 400);
}
 
// rapide formatage des résultats:
$matches = 0;
 
if ($res) {
// nombre de matches (sans LIMIT) utilisé pour l'en-tête
$matches = $db->recuperer('SELECT FOUND_ROWS() AS total');
$matches = intval($matches['total']);
}
 
// reformate les résultats pour les indexer par coste:nn par défaut
// cependant le paramètre retour.indexBy permet de choisir une indexation par num_nom de bdtfx
$clef_index = $params['retour.indexBy'] == 'coste' ? 'coste:nn' : 'bdtfx:nn';
$res2 = array();
foreach ($res as $v) {
if (!$v[$clef_index]) {
throw new Exception('format error: index NULL, use retour.indexBy=coste', 409);
}
$res2[$v[$clef_index]] = $v;
}
 
// l'appelant s'occupera du json_encode()
// même si ça démange d'exit'er ici
if(strpos($_SERVER['SCRIPT_NAME'], 'phpunit') === FALSE) header("Content-Type: application/json; charset=utf-8");
return array('entete' => array(
'depart' => $params['navigation.depart'],
'limite' => $params['navigation.limite'],
'total' => count($res2),
'match' => $matches),
'resultats' => $res2);
}
 
 
// la fonction centrale: récupère les infos à partir de paramètres
// et une optionnelle contrainte sur coste:nn ou bdtfx:nn
static function getCosteInfo(array $params, $db) {
// contraintes (WHERE):
$constraints = self::sqlAddConstraint($params, $db);
// XXX: que faire en l'absence de contrainte ? pour l'instant : "WHERE 1"
 
// champs:
$champs_valides_non_formattes = NULL;
$champs_valides = self::sqlSelectFields($params, $champs_valides_non_formattes);
 
// joins:
$other_join = self::sqlAddJoins($params, $champs_valides_non_formattes);
$requete_tpl = "SELECT SQL_CALC_FOUND_ROWS %s".
"FROM tb_eflore.coste_v2_00 c ".
" LEFT JOIN tela_prod_wikini.florecoste_pages dsc ON c.page_wiki_dsc = dsc.tag AND dsc.latest = 'Y' ".
" LEFT JOIN tela_prod_wikini.florecoste_pages cle ON c.page_wiki_cle = cle.tag AND cle.latest = 'Y' ".
" %s ".
"WHERE %s ORDER BY c.num_nom LIMIT %u, %u -- %s ";
$req = sprintf($requete_tpl,
$champs_valides, // dans le SELECT (parmi champs coste_v2_00)
// autre join, si nécessaire
$other_join ? $other_join : '',
 
// where
$constraints ? implode(' AND ', $constraints) : '1',
 
// limit
$params['navigation.depart'],
$params['navigation.limite'],
__FILE__ . ':' . __LINE__);
 
return $req;
}
 
// SQL helpers
// le préfix de coste_v2_00 est "c"
// le préfix de florecoste_pages sur la description est est "dsc"
// le préfix de florecoste_pages sur la clef de détermination est est "cle"
static function sqlAddConstraint($params, $db) {
$stack = array();
if (!empty($params['masque.ns'])) {
if ($params['recherche'] == 'etendue') {
$stack[] = 'c.nom_sci LIKE '.$db->proteger('%' . trim($params['masque.ns']).'%');
} elseif($params['recherche'] == 'floue') {
$stack[] = sprintf(self::$soundex_scheme,
'c.nom_sci',
$db->proteger('%'.trim($params['masque.ns']).'%'));
} else {
$stack[] = 'c.nom_sci = '.$db->proteger(trim($params['masque.ns']));
}
}
 
// le masque sur texte est toujours un LIKE() "étendue", sauf si "floue" spécifié
if(!empty($params['masque.txt'])) {
if($params['recherche'] == 'floue') {
$stack[] = sprintf(self::$soundex_scheme,
'dsc.body',
$db->proteger('%'.trim($params['masque.txt']).'%'));
}
else {
$stack[] = 'dsc.body LIKE '.$db->proteger('%'.trim($params['masque.txt']).'%');
}
}
 
if(!empty($params['masque.titre'])) {
if($params['recherche'] == 'stricte') {
$stack[] = sprintf('(dsc.tag = %1$s OR cle.tag = %1$s)',
$db->proteger(trim($params['masque.titre'])));
}
else {
$stack[] = sprintf('(dsc.tag LIKE %1$s OR cle.tag LIKE %1$s)',
$db->proteger('%'.trim($params['masque.titre']).'%'));
}
}
 
if(array_key_exists('masque.famille', $params)) {
$stack[] = 'b.famille LIKE '.$db->proteger(trim($params['masque.famille']));
}
 
if(array_key_exists('masque.page', $params)) {
$stack[] = 'c.page = '.intval($params['masque.page']);
}
 
if(array_key_exists('masque.tome', $params)) {
$stack[] = 'c.tome = '.intval($params['masque.tome']);
}
 
if(array_key_exists('masque.nt', $params)) {
$stack[] = 'c.flore_bdtfx_nt = '.intval($params['masque.nt']);
}
 
// ajout de la contrainte sur coste:nn ou bdtfx:nn si un composant d'URL supplémentaire
// comportant un #id existe, cf self::requestFilterIds()
$o_stack = array();
if (array_key_exists('_ids', $params) && $params['_ids']) {
if ($params['_ids']['coste']) {
$o_stack[] = sprintf("c.num_nom IN (%s)", implode(',', $params['_ids']['coste']));
}
if ($params['_ids']['bdtfx']) {
$o_stack[] = sprintf("c.flore_bdtfx_nn IN (%s)", implode(',', $params['_ids']['bdtfx']));
}
}
if ($o_stack) {
$stack[] = '(' . implode(' OR ', $o_stack) . ')';
}
 
return $stack;
}
 
 
// $unmerged contient la même liste de champs que celle renvoyée
// à la différence que celle-ci n'est pas reformatée et s'avère donc
// utilisable plus aisément dans sqlAddJoins() qui peut en avoir besoin
static function sqlSelectFields($params, &$unmerged) {
$champs = $params['retour.champs'];
// champs coste_v2_00
$c = self::addSQLToFieldSynonym(explode(',', $champs));
if (isset($c['*'])) {
$t = array_diff_key(self::$allow_champs, array_flip(self::$special_champs));
} else {
// just loop below
$t = $c;
}
 
// si aucun des champs fournis n'est valide
// on se rappelle nous-même après avoir réinitialisé retour.champs
// avec les champs par défaut
if(!$t) {
$params['retour.champs'] = self::$default_params['retour.champs'];
return self::sqlSelectFields($params);
}
 
if(array_key_exists('titre', $t))
$t['titre'] = $params['txt.format'] == 'txt' ? 'c.nom_sci' : 'c.nom_sci_html';
 
// champs obligatoires:
$t = array_merge($t, self::addSQLToFieldSynonym(self::$champs_obligatoires));
$unmerged = $t;
 
// XXX: PHP-5.3
$ret = array();
foreach($t as $k => $v) {
if (strpos($k, ':') !== FALSE) {
$ret[] = "$v AS \"$k\"";
} else {
$ret[] = "$v AS $k";
}
}
return implode(',',$ret);
}
 
static function sqlAddJoins($params, $champs) {
$j = '';
// ces tests doivent correspondre aux champs générés par sqlSelectFields()
// ou contraintes générées par sqlAddConstraint()
if(array_key_exists('masque.famille', $params) ||
array_key_exists('famille', $champs)) {
$j .= 'LEFT JOIN tb_eflore.bdtfx_v2_00 b ON c.flore_bdtfx_nn = b.num_nom';
}
 
return $j;
}
 
// d'un tableau de type array("coste:nn", "type_epithete")
// retourne
// un tableau de type array("coste:nn" => "c.num_nom", "type_epithete" => "c.type_epithete")
// basé sur self::$allow_champs
static function addSQLToFieldSynonym(Array $syno) {
return array_intersect_key(self::$allow_champs, array_flip($syno));
}
 
// request handler
static function requestParse(&$ressource, &$params) {
$uri = explode('/', $_SERVER['REDIRECT_URL']);
if(!empty($_SERVER['QUERY_STRING']))
parse_str($_SERVER['REDIRECT_QUERY_STRING'], $params);
$ressource = array_slice($uri, array_search('textes', $uri) + 1, 3);
}
 
// supprime l'index du tableau des paramètres si sa valeur ne correspond pas
// au spectre passé par $values.
static function unsetIfInvalid(&$var, $index, $values) {
if(array_key_exists($index, $var) && !in_array($var[$index], $values))
unset($var[$index]);
}
 
static function requestFilterParams(Array $params) {
$p = array_intersect_key($params, array_flip(self::$allow_params));
self::unsetIfInvalid($p, 'txt.format', array('txt', 'htm'));
self::unsetIfInvalid($p, 'retour.format', array('min','max'));
self::unsetIfInvalid($p, 'retour.indexBy', array('coste', 'bdtfx'));
self::unsetIfInvalid($p, 'recherche', array('stricte','etendue','floue'));
 
if(isset($params['masque.ns'])) $p['masque.ns'] = trim($params['masque.ns']);
if(isset($params['masque.texte'])) $p['masque.texte'] = trim($params['masque.texte']);
 
if(isset($params['masque.famille'])) {
// mysql -N<<<"SELECT DISTINCT famille FROM bdtfx_v2_00;"|sed -r "s/(.)/\1\n/g"|sort -u|tr -d "\n"
$p['masque.famille'] = preg_replace('/[^a-zA-Z %_]/', '', iconv("UTF-8",
"ASCII//TRANSLIT",
$params['masque.famille']));
}
 
// TODO: use filter_input(INPUT_GET);
// renvoie FALSE ou NULL si absent ou invalide
$p['navigation.limite'] = filter_var(@$params['navigation.limite'],
FILTER_VALIDATE_INT,
array('options' => array(
'default' => NULL,
'min_range' => 1,
'max_range' => _COSTE_TEXTE_MAX_RESULT_LIMIT)));
$p['navigation.depart'] = filter_var(@$params['navigation.depart'],
FILTER_VALIDATE_INT,
array('options' => array(
'default' => NULL,
'min_range' => 0,
'max_range' => _COSTE_TEXTE_MAX_COSTE_NN)));
$p['masque.page'] = filter_var(@$params['masque.page'],
FILTER_VALIDATE_INT,
array('options' => array(
'default' => NULL,
'min_range' => 0,
'max_range' => _COSTE_TEXTE_MAX_COSTE_PAGE)));
$p['masque.tome'] = filter_var(@$params['masque.tome'],
FILTER_VALIDATE_INT,
array('options' => array(
'default' => NULL,
'min_range' => 0,
'max_range' => _COSTE_TEXTE_MAX_COSTE_TOME)));
$p['masque.nt'] = filter_var(@$params['masque.nt'],
FILTER_VALIDATE_INT,
array('options' => array(
'default' => NULL,
'min_range' => 0,
'max_range' => _COSTE_TEXTE_MAX_BDTFX_NT)));
 
// on filtre les NULL, FALSE et '', mais pas les 0, d'où le callback()
// TODO: PHP-5.3
$p = array_filter($p, create_function('$a','return !in_array($a, array("",false,null),true);'));
$p = array_merge(self::$default_params, $p);
 
return $p;
}
 
static function requestFilterIds($uri) {
if(count($uri) != 1) return NULL;
 
// getNN* renvoient le num_nom passé comme segment d'URI:
// - soit un id selon coste (num_nom dans coste_v2_00)
// - soit un id selon bdtfx (num_nom dans bdtfx_v2_00)
// ou bien l'extrait du pattern bdtfx.nn:(#id)
$ids_coste = array_filter(array_map(array(__CLASS__, 'getNNCoste'), explode(',', $uri[0])));
$ids_bdtfx = array_filter(array_map(array(__CLASS__, 'getNNBdtfx'), explode(',', $uri[0])));
 
// en cas d'échec (tous les id sont invalides), bail-out
if(!$ids_bdtfx && !$ids_coste) {
// http_response_code(500);
throw new Exception('not supported', 500);
}
 
return array(
'coste' => array_slice($ids_coste, 0, intval(_COSTE_TEXTE_MAX_RESULT_LIMIT / 2) ),
'bdtfx' => array_slice($ids_bdtfx, 0, intval(_COSTE_TEXTE_MAX_RESULT_LIMIT / 2) )
);
}
 
static function aide() {
header("Content-Type: text/plain; charset=utf-8");
return sprintf("Service coste/textes:
 
Retourne des informations (choisies) à propos d'un taxon donné (à partir de son numéro nomenclatural
Retourne des informations (choisies) à propos de taxons recherchés (à partir de divers critères)
Les résultats sont indexés. La clef par défaut est le num_nom d'après coste (attribut \"coste:nn\")
Usage: coste/textes[/<liste-num_nom>]?<params>
 
* le paramètre \"retour.indexBy\" affecte le mode d'indexation (\"bdtfx\" ou \"coste\" (defaut))
* <liste-num_nom> étant une liste de numéros nomenclaturaux de taxons séparés par des virgules au format:
- <#id>: un numéro nomenclatural dans la base coste
- <bdtfx.nn:#id>: un numéro nomenclatural dans la base bdtfx
* retour.champs une liste de champs séparés par des virgules parmi *,%s
* les paramètres acceptés sont les suivants: %s
* les champs retournés par défaut sont les suivants: %s
* le paramètre \"recherche\" affecte les masques \"ns\" et \"texte\"
* le paramètre \"famille\" est traité via LIKE et accepte les caractères '_' et '%%'
* le paramètre \"retour.format\" est inutilisé pour l'instant.
 
Exemples:
/service:eflore:0.1/coste/textes/bdtfx.nn:182?retour.champs=titre
# retourne l'Acer monspessulanum
/service:eflore:0.1/coste/textes/182?retour.champs=titre
# retourne la Roemeria violacea (bdtfx:nn = 56272)
/service:eflore:0.1/coste/textes/182,bdtfx.nn:182?retour.champs=titre
# retourne les deux précédents
/service:eflore:0.1/coste/textes?masque.titre=Cla001Thalamiflores&retour.champs=titre
# retourne la section de Coste relatives aux Thalamiflores
/service:eflore:0.1/coste/textes?masque.titre=Thalamiflores&recherche=floue&retour.champs=titre
# idem, en utilisant une recherche floue
/service:eflore:0.1/coste/textes?masque.titre=Cla001Thalamiflores&retour.champs=titre&retour.indexBy=bdtfx
# retourne une erreur de format car cette section de coste n'est associée à aucun taxon de la BDTFX
",
implode(',', array_keys(self::$allow_champs)),
implode(',', self::$allow_params),
self::$default_params['retour.champs']
);
}
 
static function getNNCoste($refnn) {
if (is_numeric($refnn)) {
$t = intval($refnn);
if ($t >= 1 && $t < _COSTE_TEXTE_MAX_COSTE_NN) return $t;
}
return FALSE;
}
 
static function getNNBdtfx($refnn) {
if(strpos($refnn, 'bdtfx.nn:') !== 0) return FALSE;
$t = intval(str_replace('bdtfx.nn:', '', $refnn));
if($t >= 1 && $t < _COSTE_TEXTE_MAX_BDTFX_NN) return $t;
return FALSE;
}
}
/tags/v5.2-alpage/services/modules/0.1/coste/A_LIRE.txt
New file
0,0 → 1,6
 
!!!Attention à vérifier dans le config.ini de eflore-consultation que cette ligne existe bien avec le paramètre
num_taxonomique : ( utile pour le web service Images )!!!
 
nomsRechercheDeterminationTpl = "{ref:nomsTpl}?masque={valeur}&recherche={type}
&ns.format=txt&retour.champs=nom_retenu,nom_retenu.*,num_taxonomique&navigation.limite=3000"
Property changes:
Added: svn:eol-style
+native
\ No newline at end of property
Added: svn:executable
+*
\ No newline at end of property
/tags/v5.2-alpage/services/modules/0.1/coste/Images.php
New file
0,0 → 1,213
<?php
 
/**
* classe pour web service qui affiche les images de Coste.
* il n'existe qu'une seule version pour les images de Coste : 2.00
* retour en application/json
*
* exemple d'appel du service :
* .../service:eflore:0.1/coste/images?masque.nt=1053
* .../service:eflore:0.1/coste/images?masque.nn=39594,39601
* .../service:eflore:0.1/coste/images
*
* paramètres disponibles : navigation.depart, navigation.limite, masque.nn, masque.nt
*
* @package eFlore/services
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
* @author Mathilde Salthun-Lassalle <mathilde@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-2011 Tela Botanica (accueil@tela-botanica.org)
*/
 
class Images extends Commun {
protected $table ;
private $requete_condition = array(" image != '' ");
private $champs_recherches = " num_nom, image, flore_bdtfx_nn, flore_bdtfx_nt ";
private $total_resultat;
protected $limite_requete = array('depart' => 0, 'limite' => 100);
private $masque = array();
 
public function consulter($ressources, $parametres) {
$this->ressources = $ressources;
$this->parametres = $parametres;
$this->traiterRessources();
$this->traiterParametres();
$this->table = config::get('bdd_table').'_v2_00';
$requete = $this->assemblerLaRequete();
$resultat = $this->getBdd()->recupererTous($requete);
$resultats = $this->formaterResultat($resultat);
return $resultats;
}
//+-----------------------------------traitement ressources et paramètres --------------------------------+
public function traiterRessources() {
if (empty($this->ressources) ) {
if (isset($this->parametres['masque.nn']) == false
&& isset($this->parametres['masque.nt']) == false) {
$this->requete_condition[] = " flore_bdtfx_nt != '' AND flore_bdtfx_nn != '' ";
}
} else {
$e = "La ressource {$this->ressources[0]} n'existe pas.";
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,$e);
}
}
public function traiterParametres() {
foreach ($this->parametres as $param => $val ) {
switch ($param) {
case 'masque.nt' :
$this->analyserMasque($val,'nt');
break;
case 'masque.nn' :
$this->analyserMasque($val,'nn');
break;
case 'referentiel' :
// ce paramètre est ignoré dans le cas de coste
// car seul le cel le prend en compte pour le moment
// on l'indique ici dans le switch car ce sont les mêmes url
// qui sont appelées pour le cel et coste (à retirer donc si ça change)
break;
case 'navigation.depart' :
$this->limite_requete['depart'] = $val;
break;
case 'navigation.limite' :
$this->limite_requete['limite'] = $val;
break;
default :
$e = 'Erreur dans les paramètres de recherche de votre requête : </br> Le parametre " '
.$param.' " n\'existe pas.';
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,$e);
break;
}
}
}
 
private function analyserMasque($valeur, $type_masque) {
$this->masque[] = "$type_masque=$valeur";
if (!$valeur) {
$e = 'renseignez une valeur pour masque.nn';
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE,$e);
}
$arr = array_filter(array_map('intval', explode(',', $valeur)));
if(!$arr) $this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, "valeur incorrecte pour masque.".$type_masque);
$this->requete_condition[] = sprintf(" flore_bdtfx_%s IN (%s)", $type_masque, implode(',', array_unique($arr)));
}
 
//+-------------------------------------------formatage résultats---------------------------------------------+
 
public function formaterResultat($resultat) {
$versionResultat['entete'] = $this->formaterEnteteResultat();;
if ($resultat == '') {
$message = 'La requête SQL formée comporte une erreur!';
$code = RestServeur::HTTP_CODE_MAUVAISE_REQUETE;
throw new Exception($message, $code);
} elseif ($resultat) {
$versionResultat = $this->retournerResultatFormate($resultat);
} else {
$versionResultat['resultats'] = array();
}
return $versionResultat;
}
public function retournerResultatFormate($resultat) {
$resultat_json = array();
foreach ($resultat as $tab) {
$num_coste = $tab['num_nom'];
unset($tab['num_nom']);
$resultat_json['resultats'][$num_coste]['num_nomenclatural'] = $tab['flore_bdtfx_nn'];
$resultat_json['resultats'][$num_coste]['num_taxonomique'] = $tab['flore_bdtfx_nt'];
$resultat_json['resultats'][$num_coste]['binaire.href'] = $this->formaterUrlImage($tab['image']);
$resultat_json['resultats'][$num_coste]['mime'] = "images/png";
}
return $resultat_json;
}
public function formaterUrlImage($fichier) {
$chemin = config::get('donnees')."2.00/img/$fichier";
return $chemin;
}
 
public function formaterEnteteResultat() {
$entete['depart'] = $this->limite_requete['depart'];
$entete['limite'] = $this->limite_requete['limite'];
$entete['total'] = $this->total_resultat;
$entete['masque'] = empty($this->masque) ? 'aucun' : implode('&', $this->masque);
$url = $this->formulerUrl($this->total_resultat, '/images');
if (isset($url['precedent']) && $url['precedent'] != '') {
$entete['href.precedent'] = $url['precedent'];
}
if (isset($url['suivant']) && $url['suivant'] != '') {
$entete['href.suivant'] = $url['suivant'];
}
return $entete;
}
//+--------------------------FONCTIONS D'ASSEMBLAGE DE LA REQUETE-------------------------------------------+
public function assemblerLaRequete() {
$requete = ' SELECT '.$this->champs_recherches.' FROM '.$this->table.' '
.$this->retournerRequeteCondition().' '
.$this->delimiterResultatsRequete();
return $requete;
}
 
public function retournerRequeteCondition() {
$condition = '';
if (empty($this->requete_condition) == false) {
$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
}
return $condition;
}
 
public function calculerTotalResultat() {
$requete = 'SELECT count(*) as nombre FROM '.$this->table.' '
.$this->retournerRequeteCondition();
$res = $this->getBdd()->recuperer($requete);
if ($res) {
$this->total_resultat = $res['nombre'];
} else {
$this->total_resultat = 0;
$e = 'Données introuvables dans la base';
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
}
}
public function delimiterResultatsRequete() {
$this->calculerTotalResultat();
$requete_limite = '';
if ((count($this->ressources)) == 0) {
if (($this->limite_requete['depart'] < $this->total_resultat) &&
(($this->limite_requete['limite'] + $this->limite_requete['depart'] )
< $this->total_resultat )) {
$requete_limite = 'LIMIT '.$this->limite_requete['depart'].', '
.$this->limite_requete['limite'];
}
}
return $requete_limite;
}
}
?>