Subversion Repositories eFlore/Applications.eflore-consultation

Rev

Rev 1116 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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