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 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 $cle => $valeur) {
			$cle = '{'.$cle.'}';
			$parametres[$cle] = rawurlencode($valeur);
		}
		$url = strtr($tpl, $parametres);
		return $url;
	}
 
	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 286 → 291

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