WebSVN – eFlore/Projets.eflore-projets – Diff – /trunk/services/modules/0.1/bdtfx/CommunNomsTaxons.php


<?php
// declare(encoding='UTF-8');
/**
* Description :
* Classe CommunNomsTaxons.php
* 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-2011 Tela Botanica (accueil@tela-botanica.org)
*/
 
 
abstract class CommunNomsTaxons extends Commun {
 
	/** Tableau de correspondance entre les noms des champs et les codes de l'ontologie.*/
	private $relationsChampsCodesOntologie = null;
	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.
	protected $compo_nom = null; //Stocke sous forme de tableau les composant du nom à ajouter au nom scientifique
	protected $table;// Nom de la table dans laquelle on récupèrera les données dans les requetes SQL
	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;
	protected $erreursParametres = null;
	protected $sans_nom_sci = array('gen','sp','ssp','fam','au_ss','bib_ss');
	private $bib_traitees = array();
	private $ontologie = array();
 
//+------------------------------- PARAMÈTRES ---------------------------------------------------------------+
 
	public function traiterParametres() {
		$this->definirParametresParDefaut();
		$this->verifierParametres();
 
		if (isset($this->parametres) && count($this->parametres) > 0) {
			foreach ($this->parametres as $param => $val) {
				switch ($param) {
					case 'ns.structure' :
						$this->remplirTableCompositionNom($val);
						if (in_array($val,$this->sans_nom_sci)){
							$this->requete_champ = implode(', ',$this->compo_nom);
						}else {
							$this->requete_champ .= ' ,'.implode(', ',$this->compo_nom);
						}
						break;
					case 'navigation.depart' :
							$this->limite_requete['depart'] = $val;
						break;
					case 'navigation.limite' :
							$this->limite_requete['limite'] = $val;
						break;
				}
			}
			$this->traiterParametresSpecifiques();
		}
	}
 
	protected function definirParametresParDefaut() {
		if (empty($this->parametres['recherche'])) {
			$this->parametres['recherche'] = 'stricte';
		}
		if (empty($this->parametres['ns.format'])) {
			$this->parametres['ns.format'] =  'txt';
		}
		if (empty($this->parametres['retour.format'])) {
			$this->parametres['retour.format'] = 'max';
		}
		if (empty($this->parametres['ns.structure']) &&
			$this->parametres['retour.format'] != 'oss') {
			$this->parametres['ns.structure'] = 'au,an,bib';
		}
	}
 
 
	public function verifierParametres() {
		//$this->verifierParametresAPI();
 
		$this->verifierParametre('recherche', 'stricte|floue|etendue|complete');
		$this->verifierParametre('ns.format', 'htm|txt');
		$this->verifierParametre('retour.format', 'min|max|oss|perso');
		$this->verifierParametreAvecValeurMultipe('ns.structure', 'an|au|bib|ad|gen|sp|ssp|fam|au_ss|bib_ss');
 
		/*if (count($this->erreursParametres) > 0) {
			$m = 'Erreur dans votre requête : '.implode('<br/>', $this->erreursParametres);
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $m);
		}*/
	}
 
	public function verifierParametresAPI() {
		$parametresApi = $this->recupererTableauConfig('parametresAPI');
		while (!is_null($parametre = key($this->parametres))) {
			if (!in_array($parametre, $parametresApi)) {
				$this->erreursParametres[] = "Le paramètre '$parametre' n'est pas pris en compte par cette version de l'API.";
			}
			next($this->parametres);
		}
	}
 
	public function verifierParametre($parametre, $valeursPermises) {
		if (isset($this->parametres[$parametre]) && !empty($this->parametres[$parametre])) {
			$valeur = $this->parametres[$parametre];
			$this->verifierValeursPermises($parametre, $valeur, $valeursPermises);
		}
	}
 
	public function verifierParametreAvecValeurMultipe($parametre, $valeursPermises) {
		if (isset($this->parametres[$parametre]) && !empty($this->parametres[$parametre])) {
			$valeursConcatenees = $this->parametres[$parametre];
			$valeurs = explode(',', $valeursConcatenees);
			foreach ($valeurs as $valeur) {
				$this->verifierValeursPermises($parametre, $valeur, $valeursPermises);
			}
		}
	}
 
	private function verifierValeursPermises($parametre, $valeur, $valeursPermises) {
		if (!in_array($valeur, explode('|', $valeursPermises))) {
			$this->erreursParametres[] = "Le paramètre '$parametre' ne peut pas prendre la valeur '$valeur'. Valeurs permises : $valeursPermises";
		}
	}
 
	public function traiterParametresCommuns() {
 
	}
 
	public function ajouterFiltreMasque($nom_champ, $valeur) {
		$orig_val = $valeur;
		$valeur = explode(',',$valeur);
		$conditions = array();
		if ($nom_champ == 'annee' || $nom_champ == 'rang') {
			foreach ($valeur as $val) {
				 $conditions[] = "$nom_champ = ".$this->getBdd()->proteger($val);
			}
		} else {
			if ($this->parametres['recherche'] == 'etendue') {
				foreach ($valeur as $val) {
					$val = $this->modifierValeur($val);
					$conditions[] = "$nom_champ LIKE ".$this->getBdd()->proteger($val);
				}
 
			} elseif ($this->parametres['recherche'] == 'floue') {
				foreach ($valeur as $val) {
					$val = $this->getBdd()->proteger($val);
					$conditions[] = "( SOUNDEX($nom_champ) = SOUNDEX($val))".
											" OR ( SOUNDEX(REVERSE($nom_champ)) = SOUNDEX(REVERSE($val)))";
				}
				// utile pour la détermination à partir d'un nom retenu (concat(nom_sci,auteur)) lors
				// d'un import depuis le CEL
			} elseif ($this->parametres['recherche'] == 'concat' && $nom_champ == 'nom_sci') {
				$conditions[] = "CONCAT(nom_sci, ' ', auteur) = " . $this->getBdd()->proteger($orig_val);
 
			} else {
				foreach ($valeur as $val) {
					$conditions[] = "$nom_champ LIKE ".$this->getBdd()->proteger($val);
				}
			}
		}
		$this->requete_condition[]= '('.implode(' OR ', $conditions ).')';
		$this->masque[$nom_champ] = $nom_champ.'='.implode(',',$valeur);
	}
 
	private function modifierValeur($valeur) {
		$valeur = $this->remplacerCaractereHybrideEtChimere($valeur);
		$valeur = $this->preparerChainePourRechercheEtendue($valeur);
		return $valeur;
	}
 
	private function remplacerCaractereHybrideEtChimere($valeur) {
		$caracteres = array('×', '%D7', '+', '%2B');
		$remplacements = array('x ','x ', '+', '+');
		$valeur = str_replace($caracteres, $remplacements, $valeur);
		return $valeur;
	}
 
	private function preparerChainePourRechercheEtendue($valeur) {
		$valeur = str_replace(' ', '% ', trim($valeur));
		$valeur = $valeur.'%';
		return $valeur;
	}
 
	//+-------------------------------Fonctions d'analyse des ressources-------------------------------------+
 
	private function etreRessourceId() {
		$ok = false;
		if ($this->estUnIdentifiant() && count($this->ressources) == 1) {
			$ok = true;
		}
		return $ok;
	}
 
	public function traiterRessources() {
		if (isset($this->ressources) && count($this->ressources) > 0) {
			if ($this->ressources[0] == 'relations') {
				$this->traiterRessourceRelations();
			} elseif ($this->estUnIdentifiant()) { //l'identifiant peut etre de type /#id ou /nt:#id
				$this->traiterRessourcesIdentifiant(); // dans le service noms ou taxons
			} elseif ($this->ressources[0] == 'stats') { //ressource = noms/stats
				$this->traiterRessourcesStats();
			} else {
				$e = '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>';
				$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
			}
		}
	}
 
	public function traiterRessourcesStats() {
		$this->format_reponse = $this->service.'/stats';
 
		$e = "Erreur dans votre requête </br> Ressources disponibles : $this->service/stats/[annees|rangs|initiales]";
		if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
			switch ($this->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, $e);
					break;
			}
		} else {
			$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
		}
	}
 
	/** 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->ressources[0]) || (strrpos($this->ressources[0],'nt:') !== false
				&& is_numeric(str_replace('nt:','',$this->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) {
			$structure = trim($structure);
			$patterns = array('/^an$/', '/^au$/', '/^bib$/', '/^ad$/', '/^sp$/', '/^gen$/', '/^ssp$/','/^fam$/',
				'/^au_ss$/','/^bib_ss$/');
			$champs = array('annee', 'auteur', 'biblio_origine', 'nom_addendum', 'epithete_sp', 'genre',
				'epithete_infra_sp','famille','auteur', 'biblio_origine');
 
			// avec str_replace() 'sp' est inclu dans 'ssp', et la conversion pour 'ssp' est mauvaise
			$this->compo_nom[$structure] = preg_replace($patterns, $champs, $structure);
		}
	}
 
	public function mettreAuFormat() {
		if ($this->parametres['ns.format'] == '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);
			}
		}
	}
 
	//+------------------------------------------------------------------------------------------------------+
	// 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. */
	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 {
				$this->$tab = $this->recupererTableauConfig($tab);
			}
		}
	}
 
	public function formaterEnOss($resultat) {
		$table_nom = array();
		$oss = '';
		foreach ($resultat 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);
				}
			}else {
				$res = $this->ajouterCompositionNom($tab);
				if($res) {
					$oss[] = $res;
				}
			}
 
		}
 
		if (isset($this->masque)) $masque = implode('&', $this->masque);
		else $masque = 'Pas de masque';
		$table_retour_oss = array($masque, $oss);
		return $table_retour_oss;
	}
 
	public function afficherEnteteResultat($url_service) {
        $arr = array(
            'depart' => $this->limite_requete['depart'],
            'limite' => $this->limite_requete['limite'],
            'total'  => $this->total_resultat);
 
		if (isset($this->masque))
            $arr['masque'] = implode('&', $this->masque);
 
		$url = $this->formulerUrl($this->total_resultat, $url_service);
		if (isset($url['precedent']) && $url['precedent'] != '') {
			$arr['href.precedent'] = $url['precedent'];
		}
		if (isset($url['suivant']) && $url['suivant']   != '') {
			$arr['href.suivant']   = $url['suivant'];
		}
        return $arr;
	}
 
	public function afficherNomHrefRetenu($tab, $num) {
		$this->resultat_req = $tab;
		$this->afficherDonnees('num_nom', $num);
		if ($this->parametres['retour.format'] == 'min') { // sinon est affiché ds afficherDonnees(num_nom, $val) ci-dessus
			 $this->table_retour['nom_sci'] = $tab['nom_sci'];
			 $this->table_retour['nom_sci_complet'] = $tab['nom_sci'].' '.$this->ajouterCompositionNom($tab);
		}
		if ($tab['num_nom_retenu'] != '') {
			$retenu = ($tab['num_nom_retenu'] == $num) ? 'true' : 'false';
		} else {
			$retenu = 'absent';
		}
		$this->table_retour['retenu'] = $retenu;
		// Pourquoi ce unset ? JPM - 28-03-2013
		unset($this->table_retour['id']);
	}
 
 
	//+------------------------------------------------------------------------------------------------------+
	// Fonction de formatage pour les services /#id/
 
	public function formaterId($resultat) {
		$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
		$this->resultat_req = $resultat;
 
		foreach ($resultat as $cle => $valeur) {
			if ($valeur != '') {
				$this->afficherDonnees($cle, $valeur);
			}
		}
		if (isset($this->parametres['retour.champs']) && $this->format_reponse == 'noms/id') {
			$retour = $this->table_retour;
			$this->table_retour = array();
			$champs = explode(',', $this->parametres['retour.champs']);
			$this->ajouterChampsPersonnalises($champs, $retour);
		}
		unset($this->table_retour['href']);
		return $this->table_retour;
	}
 
	public function formaterIdChamp($resultat) {
		$this->recupererTableSignification('correspondance_champs,champs_api,champs_comp');
		$reponse_id = $this->formaterId($resultat);
		$this->table_retour = array();
		$champs = explode(' ', $this->ressources[1]);
		$this->ajouterChampsPersonnalises($champs, $reponse_id);
		return $this->table_retour;
	}
 
	protected function ajouterChampsPersonnalises($champs, $reponse_id) {
		$champs_a_libeller = array('nom_retenu', 'rang', 'basionyme', 'hybride', 'hybride.parent_01',
			 'hybride.parent_02', 'presence', 'tax_sup', 'statut_origine', 'statut_culture', 'statut_introduction');
		if (! is_null($champs) && is_array($champs) && count($champs) > 0) {
			foreach ($champs as $champ) {
				if ($this->verifierValiditeChamp($champ)) {
					if (strrpos($champ, '.*') !== false) {
						$this->afficherPointEtoile($champ, $reponse_id);
					} elseif (in_array($champ, $champs_a_libeller)) {
						$this->table_retour[$champ.'.libelle'] =
							(isset($reponse_id[$champ.'.libelle'])) ? $reponse_id[$champ.'.libelle'] : null;
					} else {
						$champ = $this->trouverChampBddCorrespondant($champ);
						$this->table_retour[$champ] = (isset($reponse_id[$champ])) ? $reponse_id[$champ] : null;
					}
				}
			}
		}
	}
 
	public function afficherPointEtoile($champ, $reponse) {
		preg_match('/^([^.]+\.)\*$/', $champ, $match);
		if ($match[1] == 'nom_sci') {
			$this->afficherNomSciPointEpithete($this->resultat_req);
		} else {
			foreach ($reponse as $chp => $valeur) {
				if (strrpos($chp, $match[1]) !== false) {
					if ($valeur != '') {
						$this->table_retour[$chp] = $valeur;
					} else {
						$this->table_retour[$chp] = null;
					}
				}
			}
		}
	}
 
	public function decomposerNomChamp($champ) {
		$decomposition = false;
		if (preg_match('/^(?:([^.]+\.parent_0[12]|[^.]+))(?:\.(.+))?$/', $champ, $match)) {
			$radical_champ = $match[1];
			$suffixe = (isset($match[2])) ? $match[2] : "";
			$decomposition = array($radical_champ, $suffixe);
		}
		return $decomposition;
	}
 
	public function verifierValiditeChamp($champ) {
		$decomposition = $this->decomposerNomChamp($champ);
		$validite_ressource = true;
		if ($decomposition) {
			list($radical, $suffixe) = $decomposition;
			$champs_complementaire = array('nom_retenu_complet', 'basionyme_complet');
			// on verifie si le nom du champ existe bien
			if (!$this->estChampApi($radical) && !$this->estChampComplementaire($radical)) {
				if (!in_array($radical, $champs_complementaire)) {
					$validite_ressource = false;
					$e = 'Le champ "'.$radical.'" n\'existe pas dans la base. <br/><br/>';
					$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
				}
			} elseif ($this->estUnPoint($champ)) {
				$validite_ressource = $this->verifierValiditeSuffixe($suffixe, $radical);
			}
		}
		return $validite_ressource;
	}
 
	public function estChampApi($radical_champ) {
		$champ_api_ok = false;
		if (in_array($radical_champ, $this->champs_api) || in_array($radical_champ, $this->correspondance_champs)) {
			$champ_api_ok = true;
		}
		return $champ_api_ok;
	}
 
	public function estChampComplementaire($radical_champ) {
		$champ_complementaire_ok = in_array($radical_champ, $this->champs_comp) ? true : false;
		return	$champ_complementaire_ok;
	}
 
	public function verifierValiditeSuffixe($suffixe, $radical_champ) {
		$validite_ressource = true;
		if ($this->correspondAUnId($radical_champ) || $radical_champ == 'id') {
			$this->verificationSuffixesIdentifiant($suffixe, $radical_champ, $validite_ressource);
		} elseif ($this->correspondAUnCode($radical_champ)) {
			$this->verificationSuffixesCodes($suffixe, $radical_champ, $validite_ressource);
		} elseif ($radical_champ == 'nom_sci') {
			if ($suffixe != '*') {
				$validite_ressource = false;
				$m = 'Erreur : Le suffixe demandé n\'existe pas pour le champ "'.$radical_champ.'".<br/>
					Les suffixes possibles sont les suivants : <li> * </li>';
				$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $m);
			}
		} else {
			$validite_ressource = false;
			$m = 'Erreur : Le paramètre "'.$radical_champ.'" ne peut pas présenter de suffixe. <br/><br/>';
			$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $m);
		}
		return $validite_ressource;
	}
 
	public function verificationSuffixesCodes(&$suffixe, &$radical_champ, &$validite_ressource ) {
		if (!in_array($suffixe, array('*', 'code', 'href', 'details'))) {
			$validite_ressource = false;
			$e = 'Erreur : Le suffixe demandé 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>';
			$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
		}
	}
 
	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;
			$e = 'Erreur : Le suffixe demandé 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)';
			$this->renvoyerErreur( RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
		}
	}
 
 
//------------------------------fonction de formatage pour les services /stats/-----------------------------------------
 
	public function formaterStatsAnnee($resultat) {
		foreach ($resultat as $cle_annee) {
			$annee = ($cle_annee['annee'] != '') ? $cle_annee['annee'] : 'ND';
			$nb = $cle_annee['nombre'];
			$retour_stats_annee[$annee] = $nb;
		}
		return $retour_stats_annee;
	}
 
	public function formaterStatsRang($resultat) {
		foreach ($resultat as $rangs) {
			if ($rangs['rang'] != 0) {
				$rang = $rangs['rang'];
				if ($this->parametres['retour.format'] == 'max') {
					$retour_rang[$rang]['rang'] = $this->ajouterSignificationCode('rang',$rang);
				}
				$nombre = $rangs['nombre'];
				$retour_rang[$rang]['nombre'] = $nombre;
			}
		}
		return $retour_rang;
	}
 
	public function formaterStatsInitiales($resultat) {
		$rang = null;
		$table_rang = array();
		foreach ($resultat as $tuple) {
			if ($tuple['rang'] != 0) {
				$this->memoriserRang($table_rang, $tuple, $rang);
				if ($tuple['lettre'] == 'x ') {
					$this->ajouterHybrideChimere('hybride', $rang, $tuple);
				} elseif ($tuple['lettre'] == '+ ') {
					$this->ajouterHybrideChimere('chimere', $rang, $tuple);
				} 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']);
					}
				}
			}
		}
		return $this->table_retour;
	}
 
	public function memoriserRang(&$table_rang, $tuple, &$rang) {
		if (is_array($table_rang)) {
			if (!in_array($tuple['rang'], $table_rang)) {
				$rang = $tuple['rang'];
				$table_rang[] = $rang;
				if ($this->parametres['retour.format'] == 'max') {
					$rang = $this->ajouterSignificationCode('rang', $rang);
				}
			}
		}
	}
 
	public function ajouterHybrideChimere($groupe, &$rang, &$tuple) {
		if (isset($this->table_retour[$rang][str_replace('hybride', 'hyb', $groupe)])) {
			$this->table_retour[$rang][$groupe] += floatval($tuple['nb']);
		} else {
			$this->table_retour[$rang][$groupe] = floatval($tuple['nb']);
		}
	}
 
	//-----------------------------Fonctions d'affichage utiliser dans les fonctions de formatage---------------------------
 
	public function afficherDonnees($champApi, $valeur) {
		$champBdd = $this->trouverChampBddCorrespondant($champApi);
 
		if ($this->parametres['retour.format'] == 'min') {
			if ($champApi == 'nom_sci') {
				$valeur = $valeur.' '.$this->ajouterCompositionNom($this->resultat_req);
			}
			if ($champApi == 'nom_sci_html') {
				$valeur = $valeur.' '.$this->ajouterCompositionNom($this->resultat_req, 'htm');
			}
			$this->table_retour[$champBdd] = $valeur;
			// on essaye de permettre l'obtention du nom_sci_complet, y compris en retour.format == 'min',
			// tout en évitant les appels aux ontologies
			/*if ($this->correspondAUnId($champBdd) || $champBdd == 'id' && $valeur != '0') {
				preg_match('/^([^.]+\.parent_0[12]|[^.]+)(?:\.id)?$/', $champBdd, $match);
				if(strpos($this->parametres['retour.format'], $match[1]) !== false) $this->afficherSignification($match[1], $valeur);
				}*/
		} else {
			$this->afficherToutesLesInfos($champBdd, $valeur);
		}
	}
 
	public function trouverChampBddCorrespondant($champApi) {
		if (array_key_exists($champApi, $this->champs_api)) {
			$champBdd = $this->correspondance_champs[$champApi];
		} else {
			$champBdd = $champApi;
		}
		return $champBdd;
	}
 
	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);
 
		} elseif ($nom_champ_api == 'nom_sci_html') {
			$this->table_retour['nom_sci_html'] = $valeur;
			$this->table_retour['nom_sci_html_complet'] = $valeur.' '.$this->ajouterCompositionNom($this->resultat_req, 'htm');
		}elseif ($nom_champ_api != 'nom_sci') {
			$this->table_retour[$nom_champ_api] = $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 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 $suffixe) {
			switch ($suffixe) {
				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' 		 :
					$url = $this->creerUrl($champ, $valeur);
					$this->table_retour[str_replace('id.href', 'href', $champ.'.href')] = $url;
					break;
				case 'code' 		 :
					$this->table_retour[$champ.'.code'] = $this->obtenirCode($champ, $valeur);
					break;
				case 'notes' 		 :
					$this->table_retour[$champ.'.notes'] = $this->resultat_req[str_replace('.', '_', $champ).'_notes'];
					break;
				default : break;
			}
		}
	}
 
	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;
	}
 
	private function obtenirCode($champ, $valeur) {
		$code = $this->transformerChampEnCode($champ);
		return "bdnt.$code:$valeur";
	}
 
	private function transformerChampEnCode($champ) {
		if (is_null($this->relationsChampsCodesOntologie)) {
			$this->relationsChampsCodesOntologie = Outils::recupererTableauConfig('ChampsCodesOntologie');
		}
 
		$code = $champ;
		if (array_key_exists($champ, $this->relationsChampsCodesOntologie)) {
			$code = $this->relationsChampsCodesOntologie[$champ];
		}
		return $code;
	}
 
	public function creerUrl($champ, $valeur) {
		if ($this->correspondAUnId($champ) || $champ == 'id') {
			$service = $this->service_href;
			$url = $this->ajouterHref($service, $valeur);
		} else {
			$code = $this->transformerChampEnCode($champ);
			$url = $this->ajouterHrefAutreProjet('ontologies', "$code:", $valeur, 'bdnt');
		}
		return $url;
	}
 
	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->table_retour['nom_sci_complet'] = $this->resultat_req['nom_sci'] . (($suff = $this->ajouterCompositionNom($this->resultat_req)) ? ' ' . $suff : '');
		} elseif ($this->correspondAUnId($champ) || $champ == 'id') {
			$nom = $this->recupererNomSci($valeur);
			if ($nom != array()) {
				$this->table_retour[$champ.'.libelle'] = $nom['nom_sci'];
				$this->table_retour[$champ.'_html'] = $nom['nom_sci_html'];
				$this->table_retour[$champ.'_complet'] = $nom['nom_sci_complet'];
				$this->table_retour[$champ.'_html_complet'] = $nom['nom_sci_complet_html'];
				$this->service_href = $nom['service'];
			}
		} elseif ($this->correspondAUnCode($champ)) {
			$this->table_retour[$champ.'.libelle'] = $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) {
		$tab_nom_sci   = array('nom_supra_generique', 'genre', 'epithete_infra_generique', 'epithete_sp',
		'type_epithete', 'epithete_infra_sp', 'cultivar_groupe', 'cultivar', 'nom_commercial');
		foreach ($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];
			}
		}
	}
 
	public function ajouterSignificationCode($champ, $valeur) {
		if($this->termeOntologieEstEnCache($champ, $valeur)) {
			$nom_code = $this->obtenirTermeOntologieParCache($champ, $valeur);
		} else {
			$code = $this->transformerChampEnCode($champ);
			if (preg_match('/^([^_-]+)(?:_|-)([^_-]+)$/', $code, $match)) {
				$code = $match[1].ucfirst($match[2]);
			}
			$requete = sprintf('SELECT * FROM %s WHERE id IN (SELECT id FROM %s WHERE code = "%s" AND classe_id = (SELECT id FROM %s WHERE code = "%s")) LIMIT 0, 100 -- %s:%s', Config::get('bdd_table_ontologies'), Config::get('bdd_table_ontologies'), $valeur, Config::get('bdd_table_ontologies'), $code, __FILE__,  __LINE__);
			$res = $this->getBdd()->recuperer($requete);
			$nom_code = $valeur;
			if (is_array($res)) {
				$nom_code = $res['nom'];
			}
			$this->mettreEnCacheOntologie($champ, $valeur, $nom_code);
		}
		return $nom_code;
	}
 
	public function recupererNomSci($id) {
		$nom = array();
		if ($id != 0) {
			if ($this->compo_nom == null) {
				$req = 'SELECT nom_sci, num_nom_retenu, nom_sci_html FROM '.$this->table.' WHERE num_nom = '.$id;
			} else { //on ajoute à la requete sql, les champs de ns.structure
				//print_r($this->compo_nom);
				$req = 'SELECT nom_sci, num_nom_retenu, nom_sci_html, '.implode(', ', $this->compo_nom)
						.' FROM '.$this->table
						.' WHERE num_nom = '.$id;
			}
			if ($this->parametres['ns.format'] == 'htm') {
				$req = str_replace('nom_sci', 'nom_sci_html as nom_sci', $req);
			}
			$res = $this->getBdd()->recuperer($req . ' -- ' . __FILE__ . ':' . __LINE__);
			if ($res) {
				$nom['nom_sci']	= $res['nom_sci'];
				$nom['nom_sci_html'] = $res['nom_sci_html'];
				$nom['nom_sci_complet'] = $res['nom_sci'].' '.$this->ajouterCompositionNom($res);
				$nom['nom_sci_complet_html'] = $res['nom_sci_html'].' '.$this->ajouterCompositionNom($res, 'htm');
				$nom['service'] = ($res['num_nom_retenu'] == $id && $this->service == 'taxons') ? 'taxons' : 'noms';
			}
		}
		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, $format = '') {
		$format = ($format == '') ? $this->parametres['ns.format'] : $format;
 
		$nom = '';
		if (isset($this->compo_nom)) {
			if ($format == 'htm') {
				$format = array(
					'au' => '<span class="auteur">%s</span>',
					'an' => '[<span class="annee">%s</span>]',
					'an_bib' => '[<span class="annee">%s</span>, <span class="biblio">%s</span>]',
					'bib' => '[<span class="biblio">%s</span>]',
					'ad' => '[<span class="adendum">%s</span>]');
			} else {
				$format = array(
					'au' => '%s',
					'an' => '[%s]',
					'an_bib' => '[%s, %s]',
					'bib' => '[%s]',
					'ad' => '[%s]',
					'gen' => '%s',
					'sp' => '%s',
					'ssp' => '%s',
					'fam' => '%s',
					'au_ss' => '%s',
					'bib_ss' => '%s');
			}
			$compo_nom = array();
 
			foreach ($this->compo_nom as $key => $champ) {
				if (isset($tab_res[$champ]) && !empty($tab_res[$champ])) {
					$compo_nom[$key] = $tab_res[$champ];
				}
			}
			$nom_complet = $this->formerNomComplet($compo_nom, $format);
			$nom = implode(' ', $nom_complet);
		}
		return rtrim($nom, ' ');
	}
 
 
	public function formerNomComplet($compo_nom, $format) {
		$nom_complet = array();
		extract($compo_nom);
		if (isset($au)) $nom_complet[] = sprintf($format['au'], $au);
		if (isset($an)) {
			if (isset($bib)) {
				$nom_complet[] = sprintf($format['an_bib'], $an, $bib);
			} else {
				$nom_complet[] = sprintf($format['an'], $an);
			}
		} elseif (isset($bib)) {
			$nom_complet[] = sprintf($format['bib'], $bib);
		}
		if (isset($ad)) $nom_complet[] = sprintf($format['ad'], $ad);
		if (isset($gen)) $nom_complet[] = sprintf($format['gen'], $gen);
		if (isset($ssp)) $nom_complet[] = sprintf($format['ssp'], $ssp);
		if (isset($sp)) $nom_complet[] = sprintf($format['sp'], $sp);
		if (isset($fam)) $nom_complet[] = sprintf($format['fam'], $fam);
		if (isset($au_ss)) $nom_complet[] = sprintf($format['au_ss'], $au_ss);
		if (isset($bib_ss)) {
			$bibl = $this->tronquerBiblio($bib_ss);
			//simule un 'select distinct' sur les biblio tronquées
			if (!isset($this->bib_traitees[$bibl])) {
				$nom_complet[] = sprintf($format['bib_ss'],$bibl );
				$this->bib_traitees[$bibl] = 1;
			}
		}
		return $nom_complet;
	}
 
	public function tronquerBiblio($valeur){
		$bib = '';
		if(strpos($valeur,',') !== false) {
			$bib = explode(',',$valeur);
		}
		if(strpos($bib[0],';') !== false) {
 
			$bib[0] = strstr($bib[0],';');
			$bib[0] = str_replace('; ','',$bib[0]);
		}
		return $bib[0];
	}
 
 
 
	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 estUnPoint($key) {
		if (strrpos($key, 'hybride.parent') !== false) {
			$key = str_replace('hybride.parent', 'hybride_parent', $key);
		}
		return (strrpos($key, '.') !== false);
	}
 
	public function recupererMasquePrincipal() {
		$masque = null;
		$tab_masque   = array(
			'masque' => 'nom_sci',
			'masque_sg' => 'nom_supra_generique',
			'masque_gen' => 'genre',
			'masque_sp' => 'epithete_sp',
			'masque_ssp' => 'epithete_infra_sp',
			'masque_au' => 'auteur',
			'masque_an' => 'annee',
			'masque_bib' => 'biblio_origine',
			'masque_ad' => 'addendum',
			'masque_rg' => 'rang');
		$liste_masque = array();
 
		if (isset($this->masque['num_nom'])) {
			$liste_masque[] = $this->masque['num_nom'];
		}
 
		foreach ($tab_masque as $key => $filtre) {
            if (isset($this->masque[$filtre])) {
            	if (!isset($masque) && !in_array($filtre, array('rang', 'annee'))) {
            		$masque = array($key, $filtre);
            	}
                $liste_masque[] = $this->masque[$filtre];
            }
        }
        $this->masque = $liste_masque;
        return $masque;
	}
 
	private function mettreEnCacheOntologie($categorie, $valeur, $correspondance) {
		if(!isset($this->ontologie[$categorie])) {
			$this->ontologie[$categorie] = array();
		}
		if(!isset($this->ontologie[$categorie][$valeur])) {
			$this->ontologie[$categorie][$valeur] = array();
		}
		$this->ontologie[$categorie][$valeur] = $correspondance;
	}
 
	private function termeOntologieEstEnCache($categorie, $valeur) {
		return array_key_exists($categorie, $this->ontologie) && array_key_exists($valeur, $this->ontologie[$categorie]);
	}
 
	private function obtenirTermeOntologieParCache($categorie, $valeur) {
		return $this->ontologie[$categorie][$valeur];
	}
}
?>
Subversion Repositories eFlore/Projets.eflore-projets

(root)/trunk/services/modules/0.1/bdtfx/CommunNomsTaxons.php @ 990 – Rev 926 → 963

Rev 926		Rev 963
1	`<?php`	1	`<?php`
2	`// declare(encoding='UTF-8');`	2	`// declare(encoding='UTF-8');`
3	`/**`	3	`/**`
4	`* Description :`	4	`* Description :`
5	`* Classe CommunNomsTaxons.php`	5	`* Classe CommunNomsTaxons.php`
6	`* Encodage en entrée : utf8`	6	`* Encodage en entrée : utf8`
7	`* Encodage en sortie : utf8`	7	`* Encodage en sortie : utf8`
8	`* @package framework-v3`	8	`* @package framework-v3`
9	`* @author Jennifer Dhé <jennifer.dhe@tela-botanica.org>`	9	`* @author Jennifer Dhé <jennifer.dhe@tela-botanica.org>`
10	`* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>`	10	`* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>`
11	`* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>`	11	`* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>`
12	`* @version 1.0`	12	`* @version 1.0`
13	`* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)`	13	`* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)`
14	`*/`	14	`*/`
15		15
16		16
17	`abstract class CommunNomsTaxons extends Commun {`	17	`abstract class CommunNomsTaxons extends Commun {`
18		18
19	`/** Tableau de correspondance entre les noms des champs et les codes de l'ontologie.*/`	19	`/** Tableau de correspondance entre les noms des champs et les codes de l'ontologie.*/`
20	`private $relationsChampsCodesOntologie = null;`	20	`private $relationsChampsCodesOntologie = null;`
21	`protected $table_retour; //Permet de stocker le tableau de résultat (non encodé en json)`	21	`protected $table_retour; //Permet de stocker le tableau de résultat (non encodé en json)`
22	`protected $resultat_req; // Permet de stocker le résultat de la requete principale.`	22	`protected $resultat_req; // Permet de stocker le résultat de la requete principale.`
23	`protected $compo_nom = null; //Stocke sous forme de tableau les composant du nom à ajouter au nom scientifique`	23	`protected $compo_nom = null; //Stocke sous forme de tableau les composant du nom à ajouter au nom scientifique`
24	`protected $table;// Nom de la table dans laquelle on récupèrera les données dans les requetes SQL`	24	`protected $table;// Nom de la table dans laquelle on récupèrera les données dans les requetes SQL`
25	`protected $total_resultat = null;`	25	`protected $total_resultat = null;`
26	`/** Stocke le service appelé correspondant. Est utilisé principalement lors de l'affichage du href d'un synonyme`	26	`/** Stocke le service appelé correspondant. Est utilisé principalement lors de l'affichage du href d'un synonyme`
27	`(ex id=12, basionyme num 25 est un synonyme) dans le service taxon */`	27	`(ex id=12, basionyme num 25 est un synonyme) dans le service taxon */`
28	`protected $service_href = null;`	28	`protected $service_href = null;`
29	`protected $erreursParametres = null;`	29	`protected $erreursParametres = null;`
30	`protected $sans_nom_sci = array('gen','sp','ssp','fam','au_ss','bib_ss');`	30	`protected $sans_nom_sci = array('gen','sp','ssp','fam','au_ss','bib_ss');`
31	`private $bib_traitees = array();`	31	`private $bib_traitees = array();`
32	`private $ontologie = array();`	32	`private $ontologie = array();`
33		33
34	`//+------------------------------- PARAMÈTRES ---------------------------------------------------------------+`	34	`//+------------------------------- PARAMÈTRES ---------------------------------------------------------------+`
35		35
36	`public function traiterParametres() {`	36	`public function traiterParametres() {`
37	`$this->definirParametresParDefaut();`	37	`$this->definirParametresParDefaut();`
38	`$this->verifierParametres();`	38	`$this->verifierParametres();`
39		39
40	`if (isset($this->parametres) && count($this->parametres) > 0) {`	40	`if (isset($this->parametres) && count($this->parametres) > 0) {`