Subversion Repositories eFlore/Applications.eflore-consultation

Rev

Rev 286 | Rev 348 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
44 jpm 1
<?php
2
// declare(encoding='UTF-8');
3
/**
4
 * Classe mère de l'API 0.1 d'eFLore.
5
 *
6
 * @category	PHP 5.2
7
 * @package		eflore-consultation
8
 * @author		Jean-Pascal MILCENT <jpm@tela-botanica.org>
9
 * @author		Delphine CAUQUIL <delphine@tela-botanica.org>
10
 * @copyright	2011 Tela-Botanica
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
13
 * @version		$Id$
14
 */
15
abstract class Eflore {
107 jpm 16
 
60 jpm 17
	const RANG_FAMILLE = 180;
18
	const RANG_GENRE = 220;
19
	const RANG_ESPECE = 290;
107 jpm 20
 
60 jpm 21
	private $entete = null;
44 jpm 22
	private $projet = null;
107 jpm 23
 
60 jpm 24
	public function __construct($projet = null) {
25
		$this->projet = Registre::get('parametres.referentiel');
26
		if (!is_null($projet)) {
27
			$this->projet = $projet;
28
		}
44 jpm 29
	}
107 jpm 30
 
291 jpm 31
	public function setProjet($projet) {
32
		$this->projet = $projet;
33
	}
34
 
60 jpm 35
	public function getEnteteTotal() {
36
		return $this->entete['total'];
37
	}
107 jpm 38
 
44 jpm 39
	/**
40
	 * 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,
60 jpm 42
	 * la valeur correspondante sera la valeur de remplacement.
43
	 * 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.
107 jpm 45
	 *
46
	 * @param String $tpl le squelette d'url à formater.
44 jpm 47
	 * @param Array $parametres le tableau de parametres (sans accolades pour les clés).*/
48
	protected function formaterUrl($tpl, Array $parametres) {
60 jpm 49
		$parametres = $this->ajouterParametreParDefaut($parametres);
44 jpm 50
		foreach ($parametres as $cle => $valeur) {
51
			$cle = '{'.$cle.'}';
89 jpm 52
			$parametres[$cle] = rawurlencode($valeur);
44 jpm 53
		}
54
		$url = strtr($tpl, $parametres);
55
		return $url;
56
	}
107 jpm 57
 
60 jpm 58
	private function ajouterParametreParDefaut(Array $parametres) {
80 delphine 59
		$parametres['projet'] = isset($parametres['projet']) ? $parametres['projet'] : $this->projet;
60 jpm 60
		return $parametres;
61
	}
107 jpm 62
 
44 jpm 63
	/**
64
	 * Permet de consulter une url et retourne le résultat ou une erreur
107 jpm 65
	 *
44 jpm 66
	 * @param $url l'url du service à appeler pour charger les données. */
67
	protected function chargerDonnees($url) {
68
		$resultat = false;
69
		$json = $this->getRestClient()->consulter($url);
70
		$entete = $this->getRestClient()->getReponseEntetes();
71
		//Si le service meta-donnees fonctionne correctement, l'entete comprend la clé wrapper_data
72
		if (isset($entete['wrapper_data'])) {
55 jpm 73
			$forceTableauAssociatif = true;
60 jpm 74
			$resultat = json_decode($json, $forceTableauAssociatif);
107 jpm 75
			$this->entete = (isset($resultat['entete'])) ? $resultat['entete'] : null;
44 jpm 76
		} else {
77
			$m = "L'url <a href=\"$url\">$url</a> lancée via RestClient renvoie une erreur";
78
			trigger_error($m, E_USER_WARNING);
79
		}
80
		return $resultat;
81
	}
107 jpm 82
 
83
 
60 jpm 84
	/**
85
	 * Permet de consulter une url et retourne le résultat ou une erreur
107 jpm 86
	 *
60 jpm 87
	 * @param $url l'url du service à appeler pour charger les données. */
88
	protected function chargerDonneesRecursivement($url) {
89
		$resultat = false;
90
		$resultat = $this->chargerDonnees($url);
91
		if (isset($resultat['entete']['href.suivant'])) {
92
			$resultatSuivant = $this->chargerDonneesRecursivement($resultat['entete']['href.suivant']);
93
			if ($resultatSuivant) {
94
				$resultat['resultat'] = array_merge($resultat['resultat'], $resultatSuivant['resultat']);
95
			}
96
		}
97
		return $resultat;
98
	}
107 jpm 99
 
44 jpm 100
	//+----------------------------------------------------------------------------------------------------------------+
101
	// GESTION DES CLASSES CHARGÉES À LA DEMANDE
107 jpm 102
 
44 jpm 103
	private function getRestClient() {
104
		if (!isset($this->restClient)) {
105
			$this->restClient = new RestClient();
106
		}
107
		return $this->restClient;
108
	}
107 jpm 109
 
44 jpm 110
}
111
?>