WebSVN – eFlore/Applications.eflore-consultation – Diff – /trunk/metier/api_0.1/Eflore.php


<?php
// declare(encoding='UTF-8');
/**
 * Classe mère de l'API 0.1 d'eFLore.
 *
 * @category	PHP 5.2
 * @package		eflore-consultation
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
 * @author		Delphine CAUQUIL <delphine@tela-botanica.org>
 * @copyright	2011 Tela-Botanica
 * @license		http://www.gnu.org/licenses/gpl.html Licence GNU-GPL-v3
 * @license		http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL-v2
 * @version		$Id$
 */
abstract class Eflore {
 
	const RANG_FAMILLE = 180;
	const RANG_GENRE = 220;
	const RANG_ESPECE = 290;
	const API_EFLORE = '';
	const API_DEL = 'del';
	const PROTOCOLE_CARACTERES = 1;
	const PROTOCOLE_CAPITALISATION = 3;
	const PROTOCOLE_DEFI = 4;
	const PROTOCOLE_GENTIANE_AZURE = 5;
 
	private $entete = null;
	private $projet = null;
	private $api = null;
 
	public function __construct($projet = null) {
		$this->projet = Registre::get('parametres.referentiel');
		if (!is_null($projet)) {
			$this->projet = $projet;
		}
		$this->api = self::API_EFLORE;
	}
 
	public function setApi($api) {
		$this->api = $api;
		return $this;
	}
 
	public function getApi() {
		return $this->api;
	}
 
	public function setProjet($projet) {
		$this->projet = $projet;
	}
 
	public function getProjet() {
		return $this->projet;
	}
 
	public function getEnteteTotal() {
		return $this->entete['total'];
	}
 
	/**
	 * Récupère un squelette d'URL dans le fichier de configuration, en fonction de l'API spécifiée dans $this->api
	 * 
	 * @param string $squelette squelette d'URL à chercher dans le fichier de config, sans le préfixe d'API
	 * @param string $api forcer l'API, false par défaut pour utiliser l'API spécifié dans $this->api (utiliser les constantes)
	 * @throws Exception si la clef générée n'est pas présente dans le fichier de configuration
	 */
	protected function obtenirSqueletteSelonApi($squelette) {
		$api = $this->api;
		if ($api != '') {
			$squelette = ucfirst($squelette);
		}
		$clef = $api . $squelette . 'Tpl';
		if (Config::existe($clef)) {
			return Config::get($clef);
		} else {
			throw new Exception("Squelette indisponible pour l'API spécifiée");
		}
	}
 
	/**
	 * Formate une url à partir d'un template contenant des paramètres à remplacer sous la forme {monParametre}.
	 * Le tableau associatif de paramètres doit contenir en clé le paramêtre (monParametre) sans les accolades,
	 * la valeur correspondante sera la valeur de remplacement.
	 * Par défaut, les parametres suivant sont pris en compte par cette méthode :
	 *  - {projet} : le code du référentiel courrant ou définit dans le constructeur de l'objet métier.
	 *
	 * @param String $tpl le squelette d'url à formater.
	 * @param Array $parametres le tableau de parametres (sans accolades pour les clés).*/
	public function formaterUrl($tpl, Array $parametres) {
		$parametres = $this->ajouterParametreParDefaut($parametres);
		foreach($parametres as $key=> $value) {
			if(is_array($value)) {
				$value = implode(',', $value);
			}
			$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);
		}
		Debug::printr($tpl);
		return $tpl;
	}
 
	public function ajouterParametreParDefaut(Array $parametres) {
		$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;
		return $parametres;
	}
 
	/**
	 * Permet de consulter une url et retourne le résultat ou une erreur
	 *
	 * @param $url l'url du service à appeler pour charger les données. */
	protected function chargerDonnees($url) {
		$resultat = false;
		$json = $this->getRestClient()->consulter($url);
		$entete = $this->getRestClient()->getReponseEntetes();
		//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
		if (isset($entete['wrapper_data'])) {
			$forceTableauAssociatif = true;
			$resultat = json_decode($json, $forceTableauAssociatif);
			$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;
		} else {
			$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";
			trigger_error($m, E_USER_WARNING);
		}
		return $resultat;
	}
 
 
	/**
	 * Permet de consulter une url et retourne le résultat ou une erreur
	 *
	 * @param $url l'url du service à appeler pour charger les données. */
	protected function chargerDonneesRecursivement($url) {
		$resultat = false;
		$resultat = $this->chargerDonnees($url);
		if (isset($resultat['entete']['href.suivant'])) {
			$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);
			if ($resultatSuivant) {
				$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);
			}
		}
		return $resultat;
	}
 
	//+----------------------------------------------------------------------------------------------------------------+
	// GESTION DES CLASSES CHARGÉES À LA DEMANDE
 
	private function getRestClient() {
		if (!isset($this->restClient)) {
			$this->restClient = new RestClient();
		}
		return $this->restClient;
	}
 
 
	static function s_formaterUrl($tpl, Array $parametres, $enc = TRUE) {
		foreach($parametres as $key => $value) {
			if(is_array($value)) {
				$value = implode(',', $value);
			}
			$tpl = str_replace('{'.$key.'}',$enc ? rawurlencode($value) : $value, $tpl);
		}
		return $tpl;
	}
}
?>

Rev 1115	Rev 1116
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;`
-		23	`const PROTOCOLE_CAPITALISATION = 3;`
-		24	`const PROTOCOLE_DEFI = 4;`
-		25	`const PROTOCOLE_GENTIANE_AZURE = 5;`
22		26
23	`private $entete = null;`	27	`private $entete = null;`
24	`private $projet = null;`	28	`private $projet = null;`
25	`private $api = null;`	29	`private $api = null;`
26		30
27	`public function __construct($projet = null) {`	31	`public function __construct($projet = null) {`
28	`$this->projet = Registre::get('parametres.referentiel');`	32	`$this->projet = Registre::get('parametres.referentiel');`
29	`if (!is_null($projet)) {`	33	`if (!is_null($projet)) {`
30	`$this->projet = $projet;`	34	`$this->projet = $projet;`
31	`}`	35	`}`
32	`$this->api = self::API_EFLORE;`	36	`$this->api = self::API_EFLORE;`
33	`}`	37	`}`
34		38
35	`public function setApi($api) {`	39	`public function setApi($api) {`
36	`$this->api = $api;`	40	`$this->api = $api;`
37	`return $this;`	41	`return $this;`
38	`}`	42	`}`
39		43
40	`public function getApi() {`	44	`public function getApi() {`
41	`return $this->api;`	45	`return $this->api;`
42	`}`	46	`}`
43		47
44	`public function setProjet($projet) {`	48	`public function setProjet($projet) {`
45	`$this->projet = $projet;`	49	`$this->projet = $projet;`
46	`}`	50	`}`
47		51
48	`public function getProjet() {`	52	`public function getProjet() {`
49	`return $this->projet;`	53	`return $this->projet;`
50	`}`	54	`}`
51		55
52	`public function getEnteteTotal() {`	56	`public function getEnteteTotal() {`
53	`return $this->entete['total'];`	57	`return $this->entete['total'];`
54	`}`	58	`}`
55		59
56	`/**`	60	`/**`
57	`* 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`
58	`*`	62	`*`
59	`* @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`
60	`* @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)`
61	`* @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`
62	`*/`	66	`*/`
63	`protected function obtenirSqueletteSelonApi($squelette) {`	67	`protected function obtenirSqueletteSelonApi($squelette) {`
64	`$api = $this->api;`	68	`$api = $this->api;`
65	`if ($api != '') {`	69	`if ($api != '') {`
66	`$squelette = ucfirst($squelette);`	70	`$squelette = ucfirst($squelette);`
67	`}`	71	`}`
68	`$clef = $api . $squelette . 'Tpl';`	72	`$clef = $api . $squelette . 'Tpl';`
69	`if (Config::existe($clef)) {`	73	`if (Config::existe($clef)) {`
70	`return Config::get($clef);`	74	`return Config::get($clef);`
71	`} else {`	75	`} else {`
72	`throw new Exception("Squelette indisponible pour l'API spécifiée");`	76	`throw new Exception("Squelette indisponible pour l'API spécifiée");`
73	`}`	77	`}`
74	`}`	78	`}`
75		79
76	`/**`	80	`/**`
77	`* 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}.`
78	`* 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,`
79	`* la valeur correspondante sera la valeur de remplacement.`	83	`* la valeur correspondante sera la valeur de remplacement.`
80	`* 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 :`
81	`* - {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.`
82	`*`	86	`*`
83	`* @param String $tpl le squelette d'url à formater.`	87	`* @param String $tpl le squelette d'url à formater.`
84	`* @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).*/`
85	`public function formaterUrl($tpl, Array $parametres) {`	89	`public function formaterUrl($tpl, Array $parametres) {`
86	`$parametres = $this->ajouterParametreParDefaut($parametres);`	90	`$parametres = $this->ajouterParametreParDefaut($parametres);`
87	`foreach($parametres as $key=> $value) {`	91	`foreach($parametres as $key=> $value) {`
88	`if(is_array($value)) {`	92	`if(is_array($value)) {`
89	`$value = implode(',', $value);`	93	`$value = implode(',', $value);`
90	`}`	94	`}`
91	`$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);`	95	`$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);`
92	`}`	96	`}`
93	`Debug::printr($tpl);`	97	`Debug::printr($tpl);`
94	`return $tpl;`	98	`return $tpl;`
95	`}`	99	`}`
96		100
97	`public function ajouterParametreParDefaut(Array $parametres) {`	101	`public function ajouterParametreParDefaut(Array $parametres) {`
98	`$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;`	102	`$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;`
99	`return $parametres;`	103	`return $parametres;`
100	`}`	104	`}`
101		105
102	`/**`	106	`/**`
103	`* Permet de consulter une url et retourne le résultat ou une erreur`	107	`* Permet de consulter une url et retourne le résultat ou une erreur`
104	`*`	108	`*`
105	`* @param $url l'url du service à appeler pour charger les données. */`	109	`* @param $url l'url du service à appeler pour charger les données. */`
106	`protected function chargerDonnees($url) {`	110	`protected function chargerDonnees($url) {`
107	`$resultat = false;`	111	`$resultat = false;`
108	`$json = $this->getRestClient()->consulter($url);`	112	`$json = $this->getRestClient()->consulter($url);`
109	`$entete = $this->getRestClient()->getReponseEntetes();`	113	`$entete = $this->getRestClient()->getReponseEntetes();`
110	`//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data`	114	`//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data`
111	`if (isset($entete['wrapper_data'])) {`	115	`if (isset($entete['wrapper_data'])) {`
112	`$forceTableauAssociatif = true;`	116	`$forceTableauAssociatif = true;`
113	`$resultat = json_decode($json, $forceTableauAssociatif);`	117	`$resultat = json_decode($json, $forceTableauAssociatif);`
114	`$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;`	118	`$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;`
115	`} else {`	119	`} else {`
116	`$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";`	120	`$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";`
117	`trigger_error($m, E_USER_WARNING);`	121	`trigger_error($m, E_USER_WARNING);`
118	`}`	122	`}`
119	`return $resultat;`	123	`return $resultat;`
120	`}`	124	`}`
121		125
122		126
123	`/**`	127	`/**`
124	`* Permet de consulter une url et retourne le résultat ou une erreur`	128	`* Permet de consulter une url et retourne le résultat ou une erreur`
125	`*`	129	`*`
126	`* @param $url l'url du service à appeler pour charger les données. */`	130	`* @param $url l'url du service à appeler pour charger les données. */`
127	`protected function chargerDonneesRecursivement($url) {`	131	`protected function chargerDonneesRecursivement($url) {`
128	`$resultat = false;`	132	`$resultat = false;`
129	`$resultat = $this->chargerDonnees($url);`	133	`$resultat = $this->chargerDonnees($url);`
130	`if (isset($resultat['entete']['href.suivant'])) {`	134	`if (isset($resultat['entete']['href.suivant'])) {`
131	`$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);`	135	`$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);`
132	`if ($resultatSuivant) {`	136	`if ($resultatSuivant) {`
133	`$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);`	137	`$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);`
134	`}`	138	`}`
135	`}`	139	`}`
136	`return $resultat;`	140	`return $resultat;`
137	`}`	141	`}`
138		142
139	`//+----------------------------------------------------------------------------------------------------------------+`	143	`//+----------------------------------------------------------------------------------------------------------------+`
140	`// GESTION DES CLASSES CHARGÉES À LA DEMANDE`	144	`// GESTION DES CLASSES CHARGÉES À LA DEMANDE`
141		145
142	`private function getRestClient() {`	146	`private function getRestClient() {`
143	`if (!isset($this->restClient)) {`	147	`if (!isset($this->restClient)) {`
144	`$this->restClient = new RestClient();`	148	`$this->restClient = new RestClient();`
145	`}`	149	`}`
146	`return $this->restClient;`	150	`return $this->restClient;`
147	`}`	151	`}`
148		152
149		153
150	`static function s_formaterUrl($tpl, Array $parametres, $enc = TRUE) {`	154	`static function s_formaterUrl($tpl, Array $parametres, $enc = TRUE) {`
151	`foreach($parametres as $key => $value) {`	155	`foreach($parametres as $key => $value) {`
152	`if(is_array($value)) {`	156	`if(is_array($value)) {`
153	`$value = implode(',', $value);`	157	`$value = implode(',', $value);`
154	`}`	158	`}`
155	`$tpl = str_replace('{'.$key.'}',$enc ? rawurlencode($value) : $value, $tpl);`	159	`$tpl = str_replace('{'.$key.'}',$enc ? rawurlencode($value) : $value, $tpl);`
156	`}`	160	`}`
157	`return $tpl;`	161	`return $tpl;`
158	`}`	162	`}`
159	`}`	163	`}`
160	`?>`	164	`?>`

Subversion Repositories eFlore/Applications.eflore-consultation

(root)/trunk/metier/api_0.1/Eflore.php @ 1118 – Rev 1115 → 1116