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;
 
	private $entete = null;
	private $projet = null;
 
	public function __construct($projet = null) {
		$this->projet = Registre::get('parametres.referentiel');
		if (!is_null($projet)) {
			$this->projet = $projet;
		}
	}
 
	public function setProjet($projet) {
		$this->projet = $projet;
	}
 
	public function getProjet() {
		return $this->projet;
	}
 
	public function getEnteteTotal() {
		return $this->entete['total'];
	}
 
	/**
	 * 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).*/
	protected 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);
		}
		return $tpl;
	}
 
	private 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) {
		foreach($parametres as $key => $value) {
			if(is_array($value)) {
				$value = implode(',', $value);
			}
			$tpl = str_replace('{'.$key.'}',rawurlencode($value), $tpl);
		}
		return $tpl;
	}
}
?>

Subversion Repositories eFlore/Applications.eflore-consultation

(root)/trunk/metier/api_0.1/Eflore.php – Rev 924 → 1048

Rev 924		Rev 1048
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		20
21	`private $entete = null;`	21	`private $entete = null;`
22	`private $projet = null;`	22	`private $projet = null;`
23		23
24	`public function __construct($projet = null) {`	24	`public function __construct($projet = null) {`
25	`$this->projet = Registre::get('parametres.referentiel');`	25	`$this->projet = Registre::get('parametres.referentiel');`
26	`if (!is_null($projet)) {`	26	`if (!is_null($projet)) {`
27	`$this->projet = $projet;`	27	`$this->projet = $projet;`
28	`}`	28	`}`
29	`}`	29	`}`
30		30
31	`public function setProjet($projet) {`	31	`public function setProjet($projet) {`
32	`$this->projet = $projet;`	32	`$this->projet = $projet;`
33	`}`	33	`}`
34		34
35	`public function getProjet() {`	35	`public function getProjet() {`
36	`return $this->projet;`	36	`return $this->projet;`
37	`}`	37	`}`
38		38
39	`public function getEnteteTotal() {`	39	`public function getEnteteTotal() {`
40	`return $this->entete['total'];`	40	`return $this->entete['total'];`
41	`}`	41	`}`
42		42
43	`/**`	43	`/**`
44	`* Formate une url à partir d'un template contenant des paramètres à remplacer sous la forme {monParametre}.`	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,`	45	`* Le tableau associatif de paramètres doit contenir en clé le paramêtre (monParametre) sans les accolades,`
46	`* la valeur correspondante sera la valeur de remplacement.`	46	`* la valeur correspondante sera la valeur de remplacement.`
47	`* Par défaut, les parametres suivant sont pris en compte par cette méthode :`	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.`	48	`* - {projet} : le code du référentiel courrant ou définit dans le constructeur de l'objet métier.`
49	`*`	49	`*`
50	`* @param String $tpl le squelette d'url à formater.`	50	`* @param String $tpl le squelette d'url à formater.`
51	`* @param Array $parametres le tableau de parametres (sans accolades pour les clés).*/`	51	`* @param Array $parametres le tableau de parametres (sans accolades pour les clés).*/`
52	`protected function formaterUrl($tpl, Array $parametres) {`	52	`protected function formaterUrl($tpl, Array $parametres) {`
53	`$parametres = $this->ajouterParametreParDefaut($parametres);`	53	`$parametres = $this->ajouterParametreParDefaut($parametres);`
54	`foreach($parametres as $key=> $value) {`	54	`foreach($parametres as $key=> $value) {`
55	`if(is_array($value)) {`	55	`if(is_array($value)) {`
56	`$value = implode(',', $value);`	56	`$value = implode(',', $value);`
57	`}`	57	`}`
58	`$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);`	58	`$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);`
59	`}`	59	`}`
60	`return $tpl;`	60	`return $tpl;`
61	`}`	61	`}`
62		62
63	`private function ajouterParametreParDefaut(Array $parametres) {`	63	`private function ajouterParametreParDefaut(Array $parametres) {`
64	`$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;`	64	`$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;`
65	`return $parametres;`	65	`return $parametres;`
66	`}`	66	`}`
67		67
68	`/**`	68	`/**`
69	`* Permet de consulter une url et retourne le résultat ou une erreur`	69	`* Permet de consulter une url et retourne le résultat ou une erreur`
70	`*`	70	`*`
71	`* @param $url l'url du service à appeler pour charger les données. */`	71	`* @param $url l'url du service à appeler pour charger les données. */`
72	`protected function chargerDonnees($url) {`	72	`protected function chargerDonnees($url) {`
73	`$resultat = false;`	73	`$resultat = false;`
74	`$json = $this->getRestClient()->consulter($url);`	74	`$json = $this->getRestClient()->consulter($url);`
75	`$entete = $this->getRestClient()->getReponseEntetes();`	75	`$entete = $this->getRestClient()->getReponseEntetes();`
76	`//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data`	76	`//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data`
77	`if (isset($entete['wrapper_data'])) {`	77	`if (isset($entete['wrapper_data'])) {`
78	`$forceTableauAssociatif = true;`	78	`$forceTableauAssociatif = true;`
79	`$resultat = json_decode($json, $forceTableauAssociatif);`	79	`$resultat = json_decode($json, $forceTableauAssociatif);`
80	`$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;`	80	`$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;`
81	`} else {`	81	`} else {`
82	`$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";`	82	`$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";`
83	`trigger_error($m, E_USER_WARNING);`	83	`trigger_error($m, E_USER_WARNING);`
84	`}`	84	`}`
85	`return $resultat;`	85	`return $resultat;`
86	`}`	86	`}`
87		87
88		88
89	`/**`	89	`/**`
90	`* Permet de consulter une url et retourne le résultat ou une erreur`	90	`* Permet de consulter une url et retourne le résultat ou une erreur`
91	`*`	91	`*`
92	`* @param $url l'url du service à appeler pour charger les données. */`	92	`* @param $url l'url du service à appeler pour charger les données. */`
93	`protected function chargerDonneesRecursivement($url) {`	93	`protected function chargerDonneesRecursivement($url) {`
94	`$resultat = false;`	94	`$resultat = false;`
95	`$resultat = $this->chargerDonnees($url);`	95	`$resultat = $this->chargerDonnees($url);`
96	`if (isset($resultat['entete']['href.suivant'])) {`	96	`if (isset($resultat['entete']['href.suivant'])) {`
97	`$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);`	97	`$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);`
98	`if ($resultatSuivant) {`	98	`if ($resultatSuivant) {`
99	`$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);`	99	`$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);`
100	`}`	100	`}`
101	`}`	101	`}`
102	`return $resultat;`	102	`return $resultat;`
103	`}`	103	`}`
104		104
105	`//+----------------------------------------------------------------------------------------------------------------+`	105	`//+----------------------------------------------------------------------------------------------------------------+`
106	`// GESTION DES CLASSES CHARGÉES À LA DEMANDE`	106	`// GESTION DES CLASSES CHARGÉES À LA DEMANDE`
107		107
108	`private function getRestClient() {`	108	`private function getRestClient() {`
109	`if (!isset($this->restClient)) {`	109	`if (!isset($this->restClient)) {`
110	`$this->restClient = new RestClient();`	110	`$this->restClient = new RestClient();`
111	`}`	111	`}`
112	`return $this->restClient;`	112	`return $this->restClient;`
113	`}`	113	`}`
-		114
-		115
-		116	`static function s_formaterUrl($tpl, Array $parametres) {`
-		117	`foreach($parametres as $key => $value) {`
-		118	`if(is_array($value)) {`
-		119	`$value = implode(',', $value);`
-		120	`}`
-		121	`$tpl = str_replace('{'.$key.'}',rawurlencode($value), $tpl);`
-		122	`}`
-		123	`return $tpl;`
114		124	`}`
115	`}`	125	`}`
116	`?>`	126	`?>`