Subversion Repositories eFlore/Applications.eflore-consultation

Rev

Go to most recent revision | Details | 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;
1115 mathias 20
	const API_EFLORE = '';
21
	const API_DEL = 'del';
1116 mathias 22
	const PROTOCOLE_CARACTERES = 1;
23
	const PROTOCOLE_CAPITALISATION = 3;
24
	const PROTOCOLE_DEFI = 4;
25
	const PROTOCOLE_GENTIANE_AZURE = 5;
107 jpm 26
 
60 jpm 27
	private $entete = null;
44 jpm 28
	private $projet = null;
1115 mathias 29
	private $api = null;
107 jpm 30
 
60 jpm 31
	public function __construct($projet = null) {
32
		$this->projet = Registre::get('parametres.referentiel');
33
		if (!is_null($projet)) {
34
			$this->projet = $projet;
35
		}
1115 mathias 36
		$this->api = self::API_EFLORE;
44 jpm 37
	}
107 jpm 38
 
1115 mathias 39
	public function setApi($api) {
40
		$this->api = $api;
41
		return $this;
42
	}
43
 
44
	public function getApi() {
45
		return $this->api;
46
	}
47
 
291 jpm 48
	public function setProjet($projet) {
49
		$this->projet = $projet;
50
	}
508 jpm 51
 
623 mathilde 52
	public function getProjet() {
436 aurelien 53
		return $this->projet;
54
	}
291 jpm 55
 
60 jpm 56
	public function getEnteteTotal() {
57
		return $this->entete['total'];
58
	}
107 jpm 59
 
44 jpm 60
	/**
1115 mathias 61
	 * Récupère un squelette d'URL dans le fichier de configuration, en fonction de l'API spécifiée dans $this->api
62
	 *
63
	 * @param string $squelette squelette d'URL à chercher dans le fichier de config, sans le préfixe d'API
64
	 * @param string $api forcer l'API, false par défaut pour utiliser l'API spécifié dans $this->api (utiliser les constantes)
65
	 * @throws Exception si la clef générée n'est pas présente dans le fichier de configuration
66
	 */
67
	protected function obtenirSqueletteSelonApi($squelette) {
68
		$api = $this->api;
69
		if ($api != '') {
70
			$squelette = ucfirst($squelette);
71
		}
72
		$clef = $api . $squelette . 'Tpl';
73
		if (Config::existe($clef)) {
74
			return Config::get($clef);
75
		} else {
76
			throw new Exception("Squelette indisponible pour l'API spécifiée");
77
		}
78
	}
79
 
80
	/**
44 jpm 81
	 * Formate une url à partir d'un template contenant des paramètres à remplacer sous la forme {monParametre}.
82
	 * Le tableau associatif de paramètres doit contenir en clé le paramêtre (monParametre) sans les accolades,
60 jpm 83
	 * la valeur correspondante sera la valeur de remplacement.
84
	 * Par défaut, les parametres suivant sont pris en compte par cette méthode :
85
	 *  - {projet} : le code du référentiel courrant ou définit dans le constructeur de l'objet métier.
107 jpm 86
	 *
87
	 * @param String $tpl le squelette d'url à formater.
44 jpm 88
	 * @param Array $parametres le tableau de parametres (sans accolades pour les clés).*/
1115 mathias 89
	public function formaterUrl($tpl, Array $parametres) {
60 jpm 90
		$parametres = $this->ajouterParametreParDefaut($parametres);
348 aurelien 91
		foreach($parametres as $key=> $value) {
924 aurelien 92
			if(is_array($value)) {
93
				$value = implode(',', $value);
94
			}
348 aurelien 95
			$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);
44 jpm 96
		}
348 aurelien 97
		return $tpl;
44 jpm 98
	}
107 jpm 99
 
1084 raphael 100
	public function ajouterParametreParDefaut(Array $parametres) {
80 delphine 101
		$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;
60 jpm 102
		return $parametres;
103
	}
107 jpm 104
 
44 jpm 105
	/**
106
	 * Permet de consulter une url et retourne le résultat ou une erreur
107 jpm 107
	 *
44 jpm 108
	 * @param $url l'url du service à appeler pour charger les données. */
109
	protected function chargerDonnees($url) {
110
		$resultat = false;
111
		$json = $this->getRestClient()->consulter($url);
112
		$entete = $this->getRestClient()->getReponseEntetes();
113
		//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
114
		if (isset($entete['wrapper_data'])) {
55 jpm 115
			$forceTableauAssociatif = true;
60 jpm 116
			$resultat = json_decode($json, $forceTableauAssociatif);
107 jpm 117
			$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;
44 jpm 118
		} else {
119
			$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";
120
			trigger_error($m, E_USER_WARNING);
121
		}
122
		return $resultat;
123
	}
107 jpm 124
 
125
 
60 jpm 126
	/**
127
	 * Permet de consulter une url et retourne le résultat ou une erreur
107 jpm 128
	 *
60 jpm 129
	 * @param $url l'url du service à appeler pour charger les données. */
130
	protected function chargerDonneesRecursivement($url) {
131
		$resultat = false;
132
		$resultat = $this->chargerDonnees($url);
133
		if (isset($resultat['entete']['href.suivant'])) {
134
			$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);
135
			if ($resultatSuivant) {
1118 aurelien 136
				// utilisation de + obligatoire pour ne pas casser l'indexation par des ids
137
				// numériques (au lieu de array merge)
138
				$resultat['resultat'] = $resultat['resultat'] + $resultatSuivant['resultat'];
60 jpm 139
			}
140
		}
141
		return $resultat;
142
	}
107 jpm 143
 
44 jpm 144
	//+----------------------------------------------------------------------------------------------------------------+
145
	// GESTION DES CLASSES CHARGÉES À LA DEMANDE
107 jpm 146
 
44 jpm 147
	private function getRestClient() {
148
		if (!isset($this->restClient)) {
149
			$this->restClient = new RestClient();
150
		}
151
		return $this->restClient;
152
	}
107 jpm 153
 
1048 raphael 154
 
1084 raphael 155
	static function s_formaterUrl($tpl, Array $parametres, $enc = TRUE) {
1048 raphael 156
		foreach($parametres as $key => $value) {
157
			if(is_array($value)) {
158
				$value = implode(',', $value);
159
			}
1084 raphael 160
			$tpl = str_replace('{'.$key.'}',$enc ? rawurlencode($value) : $value, $tpl);
1048 raphael 161
		}
162
		return $tpl;
163
	}
44 jpm 164
}
165
?>