Subversion Repositories eFlore/Applications.eflore-consultation

Rev

Rev 623 | Rev 1048 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
44 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe mère de l'API 0.1 d'eFLore.
5
 *
6
 * @category	PHP 5.2
7
 * @package		eflore-consultation
8
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
9
 * @author		Delphine CAUQUIL <delphine@tela-botanica.org>
10
 * @copyright	2011 Tela-Botanica
11
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
12
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
13
 * @version		$Id$
14
 */
15
abstract class Eflore {
107 jpm 16
 
60 jpm 17
	const RANG_FAMILLE = 180;
18
	const RANG_GENRE = 220;
19
	const RANG_ESPECE = 290;
107 jpm 20
 
60 jpm 21
	private $entete = null;
44 jpm 22
	private $projet = null;
107 jpm 23
 
60 jpm 24
	public function __construct($projet = null) {
25
		$this->projet = Registre::get('parametres.referentiel');
26
		if (!is_null($projet)) {
27
			$this->projet = $projet;
28
		}
44 jpm 29
	}
107 jpm 30
 
291 jpm 31
	public function setProjet($projet) {
32
		$this->projet = $projet;
33
	}
508 jpm 34
 
623 mathilde 35
	public function getProjet() {
436 aurelien 36
		return $this->projet;
37
	}
291 jpm 38
 
60 jpm 39
	public function getEnteteTotal() {
40
		return $this->entete['total'];
41
	}
107 jpm 42
 
44 jpm 43
	/**
44
	 * Formate une url à partir d'un template contenant des paramètres à remplacer sous la forme {monParametre}.
45
	 * Le tableau associatif de paramètres doit contenir en clé le paramêtre (monParametre) sans les accolades,
60 jpm 46
	 * la valeur correspondante sera la valeur de remplacement.
47
	 * Par défaut, les parametres suivant sont pris en compte par cette méthode :
48
	 *  - {projet} : le code du référentiel courrant ou définit dans le constructeur de l'objet métier.
107 jpm 49
	 *
50
	 * @param String $tpl le squelette d'url à formater.
44 jpm 51
	 * @param Array $parametres le tableau de parametres (sans accolades pour les clés).*/
52
	protected function formaterUrl($tpl, Array $parametres) {
60 jpm 53
		$parametres = $this->ajouterParametreParDefaut($parametres);
348 aurelien 54
		foreach($parametres as $key=> $value) {
924 aurelien 55
			if(is_array($value)) {
56
				$value = implode(',', $value);
57
			}
348 aurelien 58
			$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);
44 jpm 59
		}
348 aurelien 60
		return $tpl;
44 jpm 61
	}
107 jpm 62
 
60 jpm 63
	private function ajouterParametreParDefaut(Array $parametres) {
80 delphine 64
		$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;
60 jpm 65
		return $parametres;
66
	}
107 jpm 67
 
44 jpm 68
	/**
69
	 * Permet de consulter une url et retourne le résultat ou une erreur
107 jpm 70
	 *
44 jpm 71
	 * @param $url l'url du service à appeler pour charger les données. */
72
	protected function chargerDonnees($url) {
73
		$resultat = false;
74
		$json = $this->getRestClient()->consulter($url);
75
		$entete = $this->getRestClient()->getReponseEntetes();
76
		//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
77
		if (isset($entete['wrapper_data'])) {
55 jpm 78
			$forceTableauAssociatif = true;
60 jpm 79
			$resultat = json_decode($json, $forceTableauAssociatif);
107 jpm 80
			$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;
44 jpm 81
		} else {
82
			$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";
83
			trigger_error($m, E_USER_WARNING);
84
		}
85
		return $resultat;
86
	}
107 jpm 87
 
88
 
60 jpm 89
	/**
90
	 * Permet de consulter une url et retourne le résultat ou une erreur
107 jpm 91
	 *
60 jpm 92
	 * @param $url l'url du service à appeler pour charger les données. */
93
	protected function chargerDonneesRecursivement($url) {
94
		$resultat = false;
95
		$resultat = $this->chargerDonnees($url);
96
		if (isset($resultat['entete']['href.suivant'])) {
97
			$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);
98
			if ($resultatSuivant) {
99
				$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);
100
			}
101
		}
102
		return $resultat;
103
	}
107 jpm 104
 
44 jpm 105
	//+----------------------------------------------------------------------------------------------------------------+
106
	// GESTION DES CLASSES CHARGÉES À LA DEMANDE
107 jpm 107
 
44 jpm 108
	private function getRestClient() {
109
		if (!isset($this->restClient)) {
110
			$this->restClient = new RestClient();
111
		}
112
		return $this->restClient;
113
	}
107 jpm 114
 
44 jpm 115
}
116
?>