WebSVN – eFlore/Applications.del – Diff – /trunk/services/modules/0.1/observations/ListeObservations.php


<?php
// declare(encoding='UTF-8');
/**
	* Le web service observations récupère toutes les observations et, pour chacune d'elle, les
	* images qui lui sont associées.
 *
 * @category	php 5.2
 * @package	del
 * @subpackage images
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @copyright	Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)
 * @license	http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL
 * @license	http://www.gnu.org/licenses/gpl.html Licence GNU-GPL
 * @version	$Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $
 * @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations
 */
 
class ListeObservations {
	
	
	private $conteneur;
	private $navigation;
	private $masque;
	private $gestionBdd;
	private $bdd;
	
	public function __construct(Conteneur $conteneur = null) {
		$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
		$this->conteneur->chargerConfiguration('config_departements.ini');
		$this->navigation = $conteneur->getNavigation();
		$this->masque = $conteneur->getMasque();
		$this->gestionBdd = $conteneur->getGestionBdd();
		$this->bdd = $this->gestionBdd->getBdd();
	}
	
	/**
	 * Méthode principale de la classe.
	 * Lance la récupération des images dans la base et les place dans un objet ResultatService 
	 * pour l'afficher.
	 * @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2)
	 * @param array $parametres les paramètres situés après le ? dans l'url
	 * */
	public function consulter($ressources, $parametres) {
		
		// Gestion des configuration du script
		$this->configurer();
		$this->verifierConfiguration();
		
		// Lancement du service
		$liaisons = $this->chargerLiaisons();
		$total = $this->compterObservations();
		$this->navigation->setTotal($total);
		$observations = $this->chargerObservations($liaisons);
		$observations = $this->chargerImages($observations);
		$observations = $this->chargerDeterminations($observations);
		$observations = $this->chargerNombreCommentaire($observations);
		
		// Mettre en forme le résultat et l'envoyer pour affichage
		$resultat = new ResultatService();
		$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $observations);
		return $resultat;
	}
	
	/*-------------------------------------------------------------------------------
	 							CONFIGURATION DU SERVICE
	 --------------------------------------------------------------------------------*/
	/**
	 * Configuration du service en fonction du fichier de config config_del.ini
	 * */
	private function configurer() {
		$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
		$this->mappingObservation = $this->conteneur->getParametre('mapping_observation');
	}
	
	/**
	 * Vérifier que le service est bien configuré 
	 * */
	private function verifierConfiguration() {
	
		$erreurs = array();
		$tableauObservations = $this->conteneur->getParametre('observations');
		if (empty($tableauObservations)) {
			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [images] ou celui-ci est vide ;'; 
		} else {
			if ($this->conteneur->getParametre('url_service') == null) {
				$erreurs[] = '- paramètre "url_service" manquant ;';
			}
			
			if ($this->conteneur->getParametre('url_images') == null) {
				$erreurs[] = '- paramètre "url_images" manquant ;';
			}
			
		}
 
		if (empty($this->mappingObservation)) {
			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_observation] ou celui-ci est vide ;';
		} else {
			$champsMappingObs = array('id_observation', 'date_observation', 'date_transmission', 'famille', 'nom_sel', 'nom_sel_nn', 'nt',
								'ce_zone_geo', 'zone_geo', 'lieudit', 'station', 'courriel', 'ce_utilisateur', 'nom', 'prenom');
			
			foreach ($champsMappingObs as $champ) {
				if (!isset($this->mappingObservation[$champ])) {
					$erreurs[] = '- le mapping du champ "'.$champ.'" pour l\'observation est manquant ;';
				}				
			}
		}
		
		if (empty($this->mappingFiltre)) {
			$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_masque] ou celui-ci est vide ;';
		} else {
			$champsMappingFiltre = array('famille', 'ns', 'nn', 'date', 'tag', 'commune');
			foreach ($champsMappingFiltre as $champ) {
				if (!isset($this->mappingFiltre[$champ])) {
					$erreurs[] = '- le mapping du champ "'.$champ.'" pour l\'observation est manquant ;';
				}				
			}
		}
		
		if (!empty($erreurs)) {
			$e = 'Erreur lors de la configuration : '."\n";
			$e .= implode("\n", $erreurs);
			throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
		}
	}
	
	
	
	/**
	 * Obtenir une chaine de caractère concaténant nom et prénom séparé par une virgule
	 * @param String $auteurId l'identifiant de l'auteur
	 * @return String la chaine de concaténation
	 * */
	private function getChaineNomPrenom($auteurId) {
		$nomPrenom = explode(' ', $auteurId);
		$nomPrenom = $this->proteger($nomPrenom);
		$chaineNomPrenom = implode(', ', $nomPrenom);
		return $chaineNomPrenom;
	}
	
	/**
	* Charger la clause WHERE en fonction des paramètres de masque
	* */
	private function chargerClauseWhere() {
		$where = array();
		$tableauMasque = $this->masque->getMasque();
		// FIXME : Les communes avec une apostrophe (ex: saint michel d'euzet) arrivent dans les paramètres sans l'apostrophe
		if (!empty($tableauMasque)) {
			foreach($tableauMasque as $idMasque => $valeurMasque) {
					
				$idMasque = str_replace('masque.', '', $idMasque);
				switch ($idMasque) {
					// nom du masque => nom BDD
					case 'auteur' :
						$auteurId = $this->masque->getMasque('auteur');
						if (is_numeric($auteurId)) {
							$where[] = ' ce_utilisateur = '.$auteurId;
						} else {
							if (strpos($auteurId, '@') === false) {
								$chaineNomPrenom = $this->getChaineNomPrenom($auteurId);
								$where[] = '((nom IN ('.$chaineNomPrenom.')) OR (prenom IN ('.$chaineNomPrenom.')))';
							} else {
								$where[] = " courriel LIKE ".$this->proteger($this->masque->getMasque('auteur').'%')." ";
							}
						}
						break;
			
						//TODO : gérer le format de la date ?
						// rechercher sur LIKE DATE % ?
						// TODO : recherche sur JOUR MOIS ou ANNEE
					case 'departement' :
						$dept = $valeurMasque;
						if (is_numeric($dept)) {
							$dept = sprintf('%02s', $dept);
							$dept = sprintf("%-'_5s", $dept);
							$where[] = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$dept);
						} else {
							
							//FIXME : et les apostrophes dans les départements ?
							
							$deptId = $this->conteneur->getParametre($dept);
							if ($deptId != null) {
								$where[] = " ce_zone_geo LIKE ".$this->proteger('INSEE-C:'.$deptId.'%');
							}
						}
						break;
					case 'genre' :
						$where[] = ' '.$this->mappingFiltre['ns'].' LIKE '.$this->proteger('%'.$valeurMasque.'% %');
						break;
					case 'tag' :
						$where[] = " mots_cles_texte LIKE ".$this->proteger($valeurMasque);
						break;
					case 'nn' :
						$where[] = ' '.$this->mappingFiltre['nn'].'  = '.$this->proteger($valeurMasque);
						break;
					default:
						$where[] = ' '.$this->mappingFiltre[$idMasque].' LIKE '.$this->proteger('%'.$valeurMasque.'%');
				}
			}	
		}
		
		if (!empty($where)) {
			return ' WHERE '.implode('AND', $where);
		} else {
			return;
		}
	}
	
	/*-------------------------------------------------------------------------------
								CHARGEMENT DES OBSERVATIONS 
	--------------------------------------------------------------------------------*/
	/**
	* Chargement depuis la bdd de toutes les liaisons entre images et observations
	* */
	private function chargerLiaisons() {
	
		$requeteLiaisons = 'SELECT SQL_CALC_FOUND_ROWS * '.
						   'FROM '.$this->gestionBdd->formaterTable('del_observation', 'dob').
						   'INNER JOIN '.$this->gestionBdd->formaterTable('del_obs_image', 'doi').
						   'ON doi.id_observation = dob.id_observation '.
						   'INNER JOIN del_utilisateur du '.
						   'ON du.id_utilisateur = doi.id_utilisateur ';
		$requeteLiaisons .= $this->chargerClauseWhere();
		$requeteLiaisons .=  ' GROUP BY doi.id_observation';
		$requeteLiaisons .= ' ORDER BY date_transmission DESC ';
		$requeteLiaisons .= $this->gestionBdd->getLimitSql();
		
		return $this->bdd->recupererTous($requeteLiaisons);
	}
	
	/**
	* Compter le nombre total d'images dans la base pour affichage dans entete.
	* */
	private function compterObservations() {
		$requete = 'SELECT FOUND_ROWS() AS nbre ';
		$resultats = $this->bdd->recuperer($requete);
		return (int) $resultats['nbre'];
	}
	
	/**
	* Retourner un tableau d'images formaté en fonction des liaisons trouvées
	* @param $liaisons les liaisons de la table del_obs_images
	* */
	private function chargerObservations($liaisons) {
	
		$observations = array();
		foreach ($liaisons as $liaison) {
			$idObs = $liaison[$this->mappingObservation['id_observation']];
			
			$observation = $this->formaterObservation($liaison); 
			$observations[$idObs] = $observation;
		}
		return $observations;
	}
	
	/**
	 * Sélectionner toutes les images de chaque observation
	 * @param array $observations la liste des observations 
	 * */
	private function chargerImages($observations) {
		
		foreach ($observations as $id => $observation) {
			
			$requeteImages = 'SELECT * FROM '. $this->gestionBdd->formaterTable('del_obs_image', 'doi').
							 'INNER JOIN '.$this->gestionBdd->formaterTable('del_image', 'di').
							 'ON doi.id_image = di.id_image '.
							 'WHERE doi.id_observation = '.$observation['id_observation'];
			
			$images = $this->bdd->recupererTous($requeteImages);
			$images = $this->formaterImages($images);
			$observations[$id]['images'] = $images;
		}
		
		return $observations;
	}
	
	/**
	* Récupérer toutes les déterminations et le nombre de commentaire au total
	* @param array $observations la liste des observations à mettre à jour
	* */
	private function chargerDeterminations($observations) {
		foreach ($observations as $id => $observation) {
			$requetePropositions = 'SELECT * FROM '.$this->gestionBdd->formaterTable('del_commentaire', 'dc').
									   'WHERE dc.nom_sel IS NOT NULL AND ce_observation = '.$observation['id_observation'];
			$propositions = $this->bdd->recupererTous($requetePropositions);
			$observations[$id]['propositions'] = $propositions;
		}
		return $observations;
	}
	
	/**
	 * Charger le nombre de commentaires (sans détermination) associé à l'observation
	 * @param Array $observations le tableau des observatins à mettre à jour
	 * */
	private function chargerNombreCommentaire($observations) {
		foreach ($observations as $id => $observation) {
			$requeteNbCommentaires = 'SELECT COUNT('.$this->proteger('id_commentaire').') as nb '.
		                         'FROM '.$this->gestionBdd->formaterTable('del_commentaire').
		                         'WHERE ce_observation = '.$observation['id_observation'].' '.
								 'AND nom_sel IS NULL';
			$nbCommentaires = $this->bdd->recuperer($requeteNbCommentaires);
			$observations[$id]['commentaires'] = (int) $nbCommentaires['nb'];
		}
		return $observations;
		
		
		                                                           
	}
	
	/*-------------------------------------------------------------------------------
								FORMATER ET METTRE EN FORME
	--------------------------------------------------------------------------------*/
	
	/**
	 * Formater les images d'une observation
	 * @param array $images les images de l'observation
	 * */
	private function formaterImages($images) {
		$imagesRetour = array();
		foreach ($images as $image) {
			$imageCourante = array();
			$imageCourante['id_image'] = $image['id_image'];
			$imageCourante['date'] = $image['date_prise_de_vue'];
			$imageCourante['binaire.href'] = $this->formaterLienImage($image['id_image']);
			$imageCourante['hauteur'] = $image['hauteur'];
			$imageRetour['largeur'] = $image['largeur'];
			
			$imagesRetour[] = $imageCourante;
		}
		
		return $imagesRetour;
	} 
	
	/**
	*  Formater une observation depuis une ligne liaison
	*  @param $liaison liaison issue de la recherche
	*  @return $observation l'observation mise en forme
	* */
	private function formaterObservation($liaison) {
		$observation = array();
		
		foreach ($this->mappingObservation as $nomOriginal => $nomFinal) {
			$observation[$nomFinal] = $liaison[$nomOriginal];
		}
		
		$observation['images'] = array();
 
		return $observation;
	}
	
	
	/**
	 * Formater le lien de l'image en fonction du fichier de config et de l'identifiant de l'image
	 * */
	private function formaterLienImage($idImage) {
		$idImage = sprintf('%09s', $idImage);
		$url = $this->conteneur->getParametre('url_images');
		$urlImage = str_replace('%s', $idImage, $url);
		return $urlImage;
	}
	
	private function proteger($valeur) {
		if (is_array($valeur)) {
			return $this->bdd->protegerTableau($valeur);
		} else {
			return $this->bdd->proteger($valeur);
		}
	}
}
?>

Subversion Repositories eFlore/Applications.del

(root)/trunk/services/modules/0.1/observations/ListeObservations.php @ 766 – Rev 757 → 766

Rev 757		Rev 766
1	`<?php`	1	`<?php`
2	`// declare(encoding='UTF-8');`	2	`// declare(encoding='UTF-8');`
3	`/**`	3	`/**`
4	`* Le web service observations récupère toutes les observations et, pour chacune d'elle, les`	4	`* Le web service observations récupère toutes les observations et, pour chacune d'elle, les`
5	`* images qui lui sont associées.`	5	`* images qui lui sont associées.`
6	`*`	6	`*`
7	`* @category php 5.2`	7	`* @category php 5.2`
8	`* @package del`	8	`* @package del`
9	`* @subpackage images`	9	`* @subpackage images`
10	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`	10	`* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>`
11	`* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)`	11	`* @copyright Copyright (c) 2012, Tela Botanica (accueil@tela-botanica.org)`
12	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`	12	`* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL`
13	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`	13	`* @license http://www.gnu.org/licenses/gpl.html Licence GNU-GPL`
14	`* @version $Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $`	14	`* @version $Id: Bdd.php 403 2012-02-22 14:35:20Z gduche $`
15	`* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations`	15	`* @see http://www.tela-botanica.org/wikini/eflore/wakka.php?wiki=ApiIdentiplante01Observations`
16	`*/`	16	`*/`
17		17
18	`class ListeObservations {`	18	`class ListeObservations {`
19		19
20		20
21	`private $conteneur;`	21	`private $conteneur;`
22	`private $navigation;`	22	`private $navigation;`
23	`private $masque;`	23	`private $masque;`
24	`private $gestionBdd;`	24	`private $gestionBdd;`
25	`private $bdd;`	25	`private $bdd;`
26		26
27	`public function __construct(Conteneur $conteneur = null) {`	27	`public function __construct(Conteneur $conteneur = null) {`
28	`$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;`	28	`$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;`
29	`$this->conteneur->chargerConfiguration('config_departements.ini');`	29	`$this->conteneur->chargerConfiguration('config_departements.ini');`
30	`$this->navigation = $conteneur->getNavigation();`	30	`$this->navigation = $conteneur->getNavigation();`
31	`$this->masque = $conteneur->getMasque();`	31	`$this->masque = $conteneur->getMasque();`
32	`$this->gestionBdd = $conteneur->getGestionBdd();`	32	`$this->gestionBdd = $conteneur->getGestionBdd();`
33	`$this->bdd = $this->gestionBdd->getBdd();`	33	`$this->bdd = $this->gestionBdd->getBdd();`
34	`}`	34	`}`
35		35
36	`/**`	36	`/**`
37	`* Méthode principale de la classe.`	37	`* Méthode principale de la classe.`
38	`* Lance la récupération des images dans la base et les place dans un objet ResultatService`	38	`* Lance la récupération des images dans la base et les place dans un objet ResultatService`
39	`* pour l'afficher.`	39	`* pour l'afficher.`
40	`* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2)`	40	`* @param array $ressources les ressources situées après l'url de base (ex : http://url/ressource1/ressource2)`