Subversion Repositories eFlore/Applications.eflore-consultation

Rev

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