Subversion Repositories eFlore/Applications.del

Compare Revisions

Ignore whitespace Rev 857 → Rev 858

/trunk/services/modules/0.1/commentaires/ConsulterCommentaire.php
New file
0,0 → 1,220
<?php
// declare(encoding='UTF-8');
/**
* Le web service image récupère toutes les données de la table del_obs_images
* pour retourner une liste d'images associée à une observation
*
* @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=ApiIdentiplante01Images
*/
 
class ConsulterCommentaire {
private $conteneur;
private $navigation;
private $masque;
private $gestionBdd;
private $bdd;
private $parametres = array();
private $ressources = array();
private $idCommentaire;
public function __construct(Conteneur $conteneur = null) {
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
$this->conteneur->chargerConfiguration('config_commentaires.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) {
$this->initialiserRessourcesEtParametres($ressources, $parametres);
// Gestion des configuration du script
$this->configurer();
$this->verifierConfiguration();
// Lancement du service
$commentaires = $this->chargerCommentaires();
$commentaires = $this->formaterCommentaires($commentaires);
$total = $this->compterCommentaires();
$this->navigation->setTotal($total);
/*$images = $this->chargerImage($liaisons);
$images = $this->chargerVotes($images);
// Mettre en forme le résultat et l'envoyer pour affichage*/
$resultat = new ResultatService();
$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $commentaires);
return $resultat;
}
private function initialiserRessourcesEtParametres($ressources, $parametres) {
$this->ressources = $ressources;
if (sizeof($this->ressources) == 1 && (is_numeric($this->ressources[0]))) {
$this->idCommentaire = $ressources[0];
} else {
$e = 'L\identifiant d\un commentaire est numérique';
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
}
$this->parametres = $parametres;
}
/*-------------------------------------------------------------------------------
CONFIGURATION DU SERVICE
--------------------------------------------------------------------------------*/
/**
* Configuration du service en fonction du fichier de config config_del.ini
* */
public function configurer() {
$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
$this->mappingCommentaire = $this->conteneur->getParametre('mapping_commentaire');
}
/**
* Vérifier que le service est bien configuré
* */
public function verifierConfiguration() {
$erreurs = array();
$tableauCommentaires = $this->conteneur->getParametre('commentaires');
if (empty($tableauCommentaires)) {
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [commentaires] ou celui-ci est vide ;';
} else {
if ($this->conteneur->getParametre('url_service') == null) {
$erreurs[] = '- paramètre "url_service" manquant ;';
}
}
 
if (empty($this->mappingCommentaire)) {
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_commentaire] ou celui-ci est vide ;';
} else {
$champsMappingCom = array('id_commentaire', 'texte', 'ce_utilisateur', 'utilisateur_nom', 'utilisateur_prenom', 'utilisateur_courriel', 'date');
foreach ($champsMappingCom as $champ) {
if (!isset($this->mappingCommentaire[$champ])) {
$erreurs[] = '- le mapping du champ "'.$champ.'" pour le commentaire 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('observation');
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);
}
}
/**
* Charger la clause WHERE en fonction des paramètres de masque
* */
private function chargerClauseWhere() {
$where = array();
if (isset($this->idCommentaire)) {
$where[] = 'id_commentaire = '.$this->idCommentaire;
}
$tableauMasque = $this->masque->getMasque();
if (!empty($tableauMasque)) {
foreach($tableauMasque as $idMasque => $valeurMasque) {
//TODO: scinder ceci en fonctions réutilisables ?
// voir si c'est interessant par rapport à la recherche générale
$idMasque = str_replace('masque.', '', $idMasque);
switch ($idMasque) {
default:
$where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->proteger($valeurMasque);
break;
}
}
}
if (!empty($where)) {
return ' WHERE '.implode('AND', $where);
} else {
return;
}
}
/*-------------------------------------------------------------------------------
CHARGEMENT DES COMMENTAIRES
--------------------------------------------------------------------------------*/
/**
* Chargement depuis la bdd de tous les commentaires
* */
private function chargerCommentaires() {
$requeteLiaisons = 'SELECT DISTINCT SQL_CALC_FOUND_ROWS * '.
'FROM '.$this->gestionBdd->formaterTable('del_commentaire', 'dc');
$requeteLiaisons .= $this->chargerClauseWhere();
$requeteLiaisons .= $this->gestionBdd->getLimitSql();
return $this->bdd->recupererTous($requeteLiaisons);
}
/**
* Compter le nombre total de commentaires dans la base pour affichage dans entete.
* */
private function compterCommentaires() {
$requete = 'SELECT FOUND_ROWS() AS nbre ';
$resultats = $this->bdd->recuperer($requete);
return (int) $resultats['nbre'];
}
/*-------------------------------------------------------------------------------
FORMATER ET METTRE EN FORME
--------------------------------------------------------------------------------*/
/**
* Formater les commentaires
* @param $commentaires les commentaires à mettre à jour
* @return $commentaires les commentaires mis à jour
* */
private function formaterCommentaires($commentaires) {
$retourCommentaires = array();
foreach ($commentaires as $id => $commentaire) {
foreach ($this->mappingCommentaire as $nomOriginal => $nomFinal) {
$retourCommentaires[$nomFinal] = $commentaire[$nomOriginal];
}
}
 
return $retourCommentaires;
}
private function proteger($valeur) {
if (is_array($valeur)) {
return $this->bdd->protegerTableau($valeur);
} else {
return $this->bdd->proteger($valeur);
}
}
}
?>
/trunk/services/modules/0.1/commentaires/ListeCommentaires.php
New file
0,0 → 1,207
<?php
// declare(encoding='UTF-8');
/**
* Le web service image récupère toutes les données de la table del_obs_images
* pour retourner une liste d'images associée à une observation
*
* @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=ApiIdentiplante01Images
*/
 
class ListeCommentaires {
private $conteneur;
private $navigation;
private $masque;
private $gestionBdd;
private $bdd;
private $parametres = array();
private $ressources = array();
public function __construct(Conteneur $conteneur = null) {
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
$this->conteneur->chargerConfiguration('config_commentaires.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) {
$this->initialiserRessourcesEtParametres($ressources, $parametres);
// Gestion des configuration du script
$this->configurer();
$this->verifierConfiguration();
// Lancement du service
$commentaires = $this->chargerCommentaires();
$commentaires = $this->formaterCommentaires($commentaires);
$total = $this->compterCommentaires();
$this->navigation->setTotal($total);
/*$images = $this->chargerImage($liaisons);
$images = $this->chargerVotes($images);
// Mettre en forme le résultat et l'envoyer pour affichage*/
$resultat = new ResultatService();
$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => $commentaires);
return $resultat;
}
private function initialiserRessourcesEtParametres($ressources, $parametres) {
$this->ressources = $ressources;
$this->parametres = $parametres;
}
/*-------------------------------------------------------------------------------
CONFIGURATION DU SERVICE
--------------------------------------------------------------------------------*/
/**
* Configuration du service en fonction du fichier de config config_del.ini
* */
public function configurer() {
$this->mappingFiltre = $this->conteneur->getParametre('mapping_masque');
$this->mappingCommentaire = $this->conteneur->getParametre('mapping_commentaire');
}
/**
* Vérifier que le service est bien configuré
* */
public function verifierConfiguration() {
$erreurs = array();
$tableauCommentaires = $this->conteneur->getParametre('commentaires');
if (empty($tableauCommentaires)) {
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [commentaires] ou celui-ci est vide ;';
} else {
if ($this->conteneur->getParametre('url_service') == null) {
$erreurs[] = '- paramètre "url_service" manquant ;';
}
}
 
if (empty($this->mappingCommentaire)) {
$erreurs[] = '- le fichier de configuration ne contient pas le tableau [mapping_commentaire] ou celui-ci est vide ;';
} else {
$champsMappingCom = array('id_commentaire', 'texte', 'ce_utilisateur', 'utilisateur_nom', 'utilisateur_prenom', 'utilisateur_courriel', 'date');
foreach ($champsMappingCom as $champ) {
if (!isset($this->mappingCommentaire[$champ])) {
$erreurs[] = '- le mapping du champ "'.$champ.'" pour le commentaire 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('observation');
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);
}
}
/**
* Charger la clause WHERE en fonction des paramètres de masque
* */
private function chargerClauseWhere() {
$where = array();
$tableauMasque = $this->masque->getMasque();
if (!empty($tableauMasque)) {
foreach($tableauMasque as $idMasque => $valeurMasque) {
//TODO: scinder ceci en fonctions réutilisables ?
// voir si c'est interessant par rapport à la recherche générale
$idMasque = str_replace('masque.', '', $idMasque);
switch ($idMasque) {
default:
$where[] = ' '.$this->mappingFiltre[$idMasque].' = '.$this->proteger($valeurMasque);
break;
}
}
}
if (!empty($where)) {
return ' WHERE '.implode('AND', $where);
} else {
return;
}
}
/*-------------------------------------------------------------------------------
CHARGEMENT DES COMMENTAIRES
--------------------------------------------------------------------------------*/
/**
* Chargement depuis la bdd de tous les commentaires
* */
private function chargerCommentaires() {
$requeteLiaisons = 'SELECT DISTINCT SQL_CALC_FOUND_ROWS * '.
'FROM '.$this->gestionBdd->formaterTable('del_commentaire', 'dc');
$requeteLiaisons .= $this->gestionBdd->getLimitSql();
return $this->bdd->recupererTous($requeteLiaisons);
}
/**
* Compter le nombre total de commentaires dans la base pour affichage dans entete.
* */
private function compterCommentaires() {
$requete = 'SELECT FOUND_ROWS() AS nbre ';
$resultats = $this->bdd->recuperer($requete);
return (int) $resultats['nbre'];
}
/*-------------------------------------------------------------------------------
FORMATER ET METTRE EN FORME
--------------------------------------------------------------------------------*/
/**
* Formater les commentaires
* @param $commentaires les commentaires à mettre à jour
* @return $commentaires les commentaires mis à jour
* */
private function formaterCommentaires($commentaires) {
$retourCommentaires = array();
foreach ($commentaires as $id => $commentaire) {
$nouveauCommentaire = array();
foreach ($this->mappingCommentaire as $nomOriginal => $nomFinal) {
$nouveauCommentaire[$nomFinal] = $commentaire[$nomOriginal];
}
$retourCommentaires[] = $nouveauCommentaire;
}
return $retourCommentaires;
}
private function proteger($valeur) {
if (is_array($valeur)) {
return $this->bdd->protegerTableau($valeur);
} else {
return $this->bdd->proteger($valeur);
}
}
}
?>
/trunk/services/modules/0.1/commentaires/AjouterCommentaire.php
New file
0,0 → 1,215
<?php
// declare(encoding='UTF-8');
/**
* Le web service image récupère toutes les données de la table del_obs_images
* pour retourner une liste d'images associée à une observation
*
* @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=ApiIdentiplante01Images
*/
 
class AjouterCommentaire {
private $conteneur;
private $navigation;
private $masque;
private $gestionBdd;
private $bdd;
private $parametres = array();
private $ressources = array();
private $commentaire;
 
public function __construct(Conteneur $conteneur = null) {
$this->conteneur = $conteneur == null ? new Conteneur() : $conteneur;
$this->conteneur->chargerConfiguration('config_commentaires.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 ajouter($ressources, $parametres) {
$this->initialiserRessourcesEtParametres($ressources, $parametres);
// Gestion des configuration du script
$this->configurer();
$this->verifierConfiguration();
$utilisateur = $this->chercherUtilisateur();
$this->insererCommentaire($utilisateur);
// Lancement du service
$resultat = new ResultatService();
$resultat->corps = array('entete' => $this->conteneur->getEntete(), 'resultats' => '');
return $resultat;
}
//ce_observation=728176&texte=ABC&auteur.id=11623&auteur.prenom=grégoire&auteur.nom=duché&auteur.courriel=gregoire@tela-botanica.org
private function initialiserRessourcesEtParametres($ressources, $parametres) {
$this->ressources = $ressources;
$this->parametres = $parametres;
}
/*-------------------------------------------------------------------------------
CONFIGURATION DU SERVICE
--------------------------------------------------------------------------------*/
/**
* Initialiser les attributs de la classe avec les parametres
* */
public function configurer() {
$this->mappingCommentaire = $this->conteneur->getParametre('mapping_commentaire');;
//TODO : Gérer le cas d'une proposition
}
/**
* Vérifier que le service est bien configuré
* */
public function verifierConfiguration() {
$erreurs = array();
$parametresPossibles = array('observation', 'proposition', 'id_parent', 'texte', 'id_auteur',
'prenom_auteur', 'nom_auteur', 'courriel_auteur', 'nom_sel',
'nom_sel_nn', 'nom_ret', 'nom_ret_nn', 'nt', 'famille');
foreach ($this->parametres as $nomParam => $valeur) {
if (!in_array($nomParam, $parametresPossibles)) {
$erreurs[] = ' - paramètre '.$nomParam.' non autorisé; ';
}
}
if (!isset($this->parametres['observation'])) {
$erreurs[] = ' - impossible d\'ajouter un commentaire sans observation ;';
}
if (!isset($this->parametres['id_auteur'])) {
if (!isset($this->parametres['nom_auteur'])) {
$erreurs[] = ' - pas de nom donné ;';
}
if (!isset($this->parametres['prenom_auteur'])) {
$erreurs[] = ' - pas de prenom donné; ';
}
if (!isset($this->parametres['courriel_auteur'])) {
$erreurs[] = ' - pas de courriel donné;';
}
}
//TODO : Gérer le cas d'une proposition
if (!empty($erreurs)) {
$e = 'Erreur de configuration :';
$e = implode("\n", $erreurs);
echo var_dump($e);
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
}
}
/*-------------------------------------------------------------------------------
INSERTION DES COMMENTAIRES
--------------------------------------------------------------------------------*/
/**
* Trouver l'utilisateur en fonction des paramètres ou de la base de données si le nom, prénom et courriel ne sont pas donnés
* @return le tableau utilisateur
* */
private function chercherUtilisateur() {
$utilisateur = array();
// Si l'id est fournit, on récupère les informations de l'utilisateur dans la base de données
// Sinon, on récupère les informations depuis le tableau Commentaire et on vérifie leur cohérence
if (isset($this->parametres['id_auteur'])) {
$requete = 'SELECT id_utilisateur as id_auteur, nom as nom_auteur, prenom as prenom_auteur, courriel as courriel_auteur '.
'FROM '.$this->gestionBdd->formaterTable('del_utilisateur').
'WHERE id_utilisateur = '.$this->parametres['id_auteur'];
$utilisateur = $this->bdd->recuperer($requete);
} else {
if (isset($this->parametres['nom_auteur']) && isset($this->parametres['prenom_auteur']) && isset($this->parametres['courriel_auteur'])) {
$utilisateur['nom_auteur'] = $this->parametres['nom_auteur'];
$utilisateur['prenom_auteur'] = $this->parametres['prenom_auteur'];
$utilisateur['courriel_auteur'] = $this->parametres['courriel_auteur'];
if (!($utilisateur = $this->estValideDansBdd($utilisateur))) {
$e = 'L\'utilisateur saisi existe déjà dans la base de données';
throw new Exception($e, RestServeur::HTTP_CODE_ACCES_NON_AUTORISE);
} else {
$this->parametres['id_auteur'] = $utilisateur['id_auteur'];
}
}
}
return $utilisateur;
}
/**
* Vérifier que les informations saisies pour un utilisateur sont valides pour la bdd
* @param $utilisateur array le tableau de l'utilisateur
* */
private function estValideDansBdd($utilisateur) {
$requete = 'SELECT id_utilisateur as id_auteur, nom as nom_auteur, prenom as prenom_auteur, courriel_auteur '.
'FROM '.$this->gestionBdd->formaterTable('del_utilisateur').
'WHERE courriel = '.$this->bdd->proteger($utilisateur['courriel_auteur']).
' AND nom = '.$this->bdd->proteger($utilisateur['nom_auteur']).
' AND prenom = '.$this->bdd->proteger($utilisateur['prenom_auteur']);
$utilisateurBdd = $this->bdd->recuperer($requete);
return $utilisateurBdd;
}
/**
* Insère un commentaire dans la table
* @param $utilisateur array la liste des paramètres utilisateur
* */
private function insererCommentaire($utilisateur) {
$requete = 'INSERT INTO '.$this->gestionBdd->formaterTable('del_commentaire');
$requete .= '('.$this->genererEntete($utilisateur).') ';
$requete .= 'VALUES ('.$this->genererValues().')';
$retour = $this->bdd->requeter($requete);
if ($retour == null) {
$e = 'Erreur inopinée lors de l\insertion';
throw new Exception($e, RestServeur::HTTP_CODE_ERREUR);
}
}
private function genererEntete($utilisateur) {
$this->parametres = array_merge($this->parametres, $utilisateur);
$entete = array();
foreach ($this->parametres as $var => $val) {
if ($val != null) {
$entete[] = $this->mappingCommentaire[$var];
}
}
return implode(', ', $entete);
}
private function genererValues() {
$valeurs = array();
foreach ($this->parametres as $var => $val) {
if ($val != null) {
$valeurs[] = $val;
}
}
$valeurs = $this->bdd->protegerTableau($valeurs);
return implode(', ', $valeurs);
}
}
?>