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($projet) {
		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) {
			$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;
	}
 
}
?>

Subversion Repositories eFlore/Applications.eflore-consultation

(root)/trunk/metier/api_0.1/Eflore.php – Rev 348 → 436

Rev 348		Rev 436
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
-		35	`public function getProjet($projet) {`
-		36	`return $this->projet;`
-		37	`}`
34		38
35	`public function getEnteteTotal() {`	39	`public function getEnteteTotal() {`
36	`return $this->entete['total'];`	40	`return $this->entete['total'];`
37	`}`	41	`}`
38		42
39	`/**`	43	`/**`
40	`* 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}.`
41	`* 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,`
42	`* la valeur correspondante sera la valeur de remplacement.`	46	`* la valeur correspondante sera la valeur de remplacement.`
43	`* 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 :`
44	`* - {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.`
45	`*`	49	`*`
46	`* @param String $tpl le squelette d'url à formater.`	50	`* @param String $tpl le squelette d'url à formater.`
47	`* @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).*/`
48	`protected function formaterUrl($tpl, Array $parametres) {`	52	`protected function formaterUrl($tpl, Array $parametres) {`
49	`$parametres = $this->ajouterParametreParDefaut($parametres);`	53	`$parametres = $this->ajouterParametreParDefaut($parametres);`
50	`foreach($parametres as $key=> $value) {`	54	`foreach($parametres as $key=> $value) {`
51	`$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);`	55	`$tpl = str_replace('{'.$key.'}',rawurlencode($value),$tpl);`
52	`}`	56	`}`
53	`return $tpl;`	57	`return $tpl;`
54	`}`	58	`}`
55		59
56	`private function ajouterParametreParDefaut(Array $parametres) {`	60	`private function ajouterParametreParDefaut(Array $parametres) {`
57	`$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;`	61	`$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;`
58	`return $parametres;`	62	`return $parametres;`
59	`}`	63	`}`
60		64
61	`/**`	65	`/**`
62	`* Permet de consulter une url et retourne le résultat ou une erreur`	66	`* Permet de consulter une url et retourne le résultat ou une erreur`
63	`*`	67	`*`
64	`* @param $url l'url du service à appeler pour charger les données. */`	68	`* @param $url l'url du service à appeler pour charger les données. */`
65	`protected function chargerDonnees($url) {`	69	`protected function chargerDonnees($url) {`
66	`$resultat = false;`	70	`$resultat = false;`
67	`$json = $this->getRestClient()->consulter($url);`	71	`$json = $this->getRestClient()->consulter($url);`
68	`$entete = $this->getRestClient()->getReponseEntetes();`	72	`$entete = $this->getRestClient()->getReponseEntetes();`
69	`//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data`	73	`//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data`
70	`if (isset($entete['wrapper_data'])) {`	74	`if (isset($entete['wrapper_data'])) {`
71	`$forceTableauAssociatif = true;`	75	`$forceTableauAssociatif = true;`
72	`$resultat = json_decode($json, $forceTableauAssociatif);`	76	`$resultat = json_decode($json, $forceTableauAssociatif);`
73	`$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;`	77	`$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;`
74	`} else {`	78	`} else {`
75	`$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";`	79	`$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";`
76	`trigger_error($m, E_USER_WARNING);`	80	`trigger_error($m, E_USER_WARNING);`
77	`}`	81	`}`
78	`return $resultat;`	82	`return $resultat;`
79	`}`	83	`}`
80		84
81		85
82	`/**`	86	`/**`
83	`* Permet de consulter une url et retourne le résultat ou une erreur`	87	`* Permet de consulter une url et retourne le résultat ou une erreur`
84	`*`	88	`*`
85	`* @param $url l'url du service à appeler pour charger les données. */`	89	`* @param $url l'url du service à appeler pour charger les données. */`
86	`protected function chargerDonneesRecursivement($url) {`	90	`protected function chargerDonneesRecursivement($url) {`
87	`$resultat = false;`	91	`$resultat = false;`
88	`$resultat = $this->chargerDonnees($url);`	92	`$resultat = $this->chargerDonnees($url);`
89	`if (isset($resultat['entete']['href.suivant'])) {`	93	`if (isset($resultat['entete']['href.suivant'])) {`
90	`$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);`	94	`$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);`
91	`if ($resultatSuivant) {`	95	`if ($resultatSuivant) {`
92	`$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);`	96	`$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);`
93	`}`	97	`}`
94	`}`	98	`}`
95	`return $resultat;`	99	`return $resultat;`
96	`}`	100	`}`
97		101
98	`//+----------------------------------------------------------------------------------------------------------------+`	102	`//+----------------------------------------------------------------------------------------------------------------+`
99	`// GESTION DES CLASSES CHARGÉES À LA DEMANDE`	103	`// GESTION DES CLASSES CHARGÉES À LA DEMANDE`
100		104
101	`private function getRestClient() {`	105	`private function getRestClient() {`
102	`if (!isset($this->restClient)) {`	106	`if (!isset($this->restClient)) {`
103	`$this->restClient = new RestClient();`	107	`$this->restClient = new RestClient();`
104	`}`	108	`}`
105	`return $this->restClient;`	109	`return $this->restClient;`
106	`}`	110	`}`
107		111
108	`}`	112	`}`
109	`?>`	113	`?>`