| 3 |
jpm |
1 |
<?php
|
|
|
2 |
/**
|
|
|
3 |
* Description :
|
|
|
4 |
* Classe Ontologies.php fournit des informations sur ensemble structuré des termes et concepts représentant les éléments
|
|
|
5 |
* d'un domaine de connaissances .
|
|
|
6 |
* Le but étant de fournir un ensemble minimal d'information comprenant :
|
|
|
7 |
* un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une description et
|
|
|
8 |
* éventuellement une relation hiérarchique avec un autre terme (=classe).
|
|
|
9 |
* Si l'url finit par /ontologies on retourne une liste de termes (seulement les 100 premières par défaut).
|
|
|
10 |
* L'url peut contenir des paramètres optionnels passés après le ? : /ontologies?param1=val1¶m2=val2&...
|
|
|
11 |
*
|
|
|
12 |
* Les paramètres de requête disponibles sont : masque, masque.code, masque.nom, masque.description , recherche,
|
|
|
13 |
* distinct, retour.format, navigation.depart et navigation.limite.
|
|
|
14 |
*
|
|
|
15 |
* Encodage en entrée : utf8
|
|
|
16 |
* Encodage en sortie : utf8
|
|
|
17 |
* @package eflore-projets
|
|
|
18 |
* @author Jennifer DHÉ <jennifer.dhe@tela-botanica.org>
|
|
|
19 |
* @author Delphine CAUQUIL <delphine@tela-botanica.org>
|
|
|
20 |
* @author Jean-Pascal MILCENT <jpm@tela-botanica.org>
|
|
|
21 |
* @license GPL v3 <http://www.gnu.org/licenses/gpl.txt>
|
|
|
22 |
* @license CECILL v2 <http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt>
|
|
|
23 |
* @version 0.1
|
|
|
24 |
* @copyright 1999-2011 Tela Botanica (accueil@tela-botanica.org)
|
|
|
25 |
*/
|
|
|
26 |
class Ontologies extends Commun {
|
|
|
27 |
|
|
|
28 |
protected $requete_condition = null; //Représente la partie de la requete SQL ajoutant une condition (WHERE ...)
|
|
|
29 |
/** Permet de stocker la requete formulée: /ontologies | /ontologies/#id | /ontologies/#id/champ | /ontologies/#id/relations */
|
|
|
30 |
protected $format_reponse = 'ontologies';
|
|
|
31 |
/** Permet de stocker les limite de la requete SQL (par défaut seul les 100 premiers résultats seront retournés).
|
|
|
32 |
* Stocke également les valeurs des paramètres navigation.depart et navigation.limite passés dans la requete*/
|
|
|
33 |
protected $limite_requete = array( 'depart' => 0, 'limite' => 100);
|
|
|
34 |
/** Stocke le nombre total de résultats de la requete principale. Est calculée lors de l'assemblage de la requete */
|
|
|
35 |
protected $total_resultat;
|
|
|
36 |
protected $retour_format = 'max';
|
|
|
37 |
|
|
|
38 |
public function traiterParametres() {
|
|
|
39 |
if (isset($this->parametres) && !empty($this->parametres)) {
|
|
|
40 |
foreach ($this->parametres as $param => $valeur) {
|
|
|
41 |
switch ($param) {
|
|
|
42 |
case 'masque' : $this->ajouterLeFiltreMasque('masque', $valeur); break;
|
|
|
43 |
case 'masque_code' : $this->ajouterLeFiltreMasque('code', $valeur); break;
|
|
|
44 |
case 'masque_nom' : $this->ajouterLeFiltreMasque('nom', $valeur); break;
|
|
|
45 |
case 'masque_description' : $this->ajouterLeFiltreMasque('description', $valeur); break;
|
|
|
46 |
case 'retour_format' : $this->retour_format = $valeur; break;
|
|
|
47 |
case 'retour_champs' : break;
|
|
|
48 |
case 'navigation_depart' : $this->limite_requete['depart'] = $valeur; break;
|
|
|
49 |
case 'navigation_limite' : $this->limite_requete['limite'] = $valeur; break;
|
|
|
50 |
case 'recherche' : break;
|
|
|
51 |
default :
|
|
|
52 |
$e = 'Erreur dans les parametres de recherche de votre requête : </br> Le paramètre " '
|
|
|
53 |
.$param.' " n\'existe pas.';
|
|
|
54 |
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e); break;
|
|
|
55 |
}
|
|
|
56 |
}
|
|
|
57 |
}
|
|
|
58 |
}
|
|
|
59 |
|
|
|
60 |
public function ajouterLeFiltreMasque($nom_champ, $valeur) {
|
|
|
61 |
if ($nom_champ == 'code') {
|
|
|
62 |
$this->requete_condition[] = $nom_champ.' = '.$this->getBdd()->proteger($valeur);
|
|
|
63 |
} else {
|
|
|
64 |
if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'floue') {
|
|
|
65 |
if ($nom_champ == 'masque') {
|
|
|
66 |
$this->requete_condition[] = '( code = '.$this->getBdd()->proteger($valeur)
|
|
|
67 |
.' OR ( SOUNDEX(nom) = SOUNDEX(\''.$valeur.'\')'
|
|
|
68 |
.' OR SOUNDEX(REVERSE(nom)) = SOUNDEX(REVERSE(\''.$valeur.'\')) '
|
|
|
69 |
.') OR ( SOUNDEX(description) = SOUNDEX(\''.$valeur.'\')'
|
|
|
70 |
.' OR SOUNDEX(REVERSE(description)) = SOUNDEX(REVERSE(\''.$valeur.'\')) ))';
|
|
|
71 |
} else {
|
|
|
72 |
$this->requete_condition[] = '(SOUNDEX('.$nom_champ.') = SOUNDEX(\''.$valeur.'\')'
|
|
|
73 |
.' OR SOUNDEX(REVERSE('.$nom_champ.')) = SOUNDEX(REVERSE(\''.$valeur.'\')))';
|
|
|
74 |
}
|
|
|
75 |
} else {
|
|
|
76 |
if (isset($this->parametres['recherche']) && $this->parametres['recherche'] == 'etendue') {
|
|
|
77 |
$valeur = str_replace(' ','%', $valeur);
|
|
|
78 |
$valeur .= '%';
|
|
|
79 |
}
|
|
|
80 |
if ($nom_champ == 'masque') {
|
|
|
81 |
$this->requete_condition[] = '(code = '.$this->getBdd()->proteger($valeur)
|
|
|
82 |
.' OR nom LIKE '.$this->getBdd()->proteger($valeur)
|
|
|
83 |
.' OR description LIKE '.$this->getBdd()->proteger($valeur).')';
|
|
|
84 |
} else {
|
|
|
85 |
$this->requete_condition[] = $nom_champ.' LIKE '.$this->getBdd()->proteger($valeur);
|
|
|
86 |
}
|
|
|
87 |
}
|
|
|
88 |
}
|
|
|
89 |
}
|
|
|
90 |
|
|
|
91 |
|
|
|
92 |
public function traiterRessources() {
|
|
|
93 |
if (isset($this->ressources) && !empty($this->ressources)) {
|
|
|
94 |
if (isset($this->ressources[0]) && !empty($this->ressources[0])) {
|
|
|
95 |
//requete = /ontologies/#id
|
|
|
96 |
$this->traiterRessourceId();
|
|
|
97 |
if (isset($this->ressources[1]) && !empty($this->ressources[1])) {
|
|
|
98 |
//requete = /ontologies/#id/relations
|
|
|
99 |
$this->traiterRessourceRelations();
|
|
|
100 |
}
|
|
|
101 |
}
|
|
|
102 |
}
|
|
|
103 |
}
|
|
|
104 |
|
|
|
105 |
|
|
|
106 |
public function traiterRessourceId() {
|
|
|
107 |
$this->requete_condition = array();
|
|
|
108 |
//requete : /ontologies/#id (ex : /ontologies/7)
|
|
|
109 |
if (is_numeric($this->ressources[0])) {
|
|
|
110 |
$this->requete_condition[] = ' id = '.$this->getBdd()->proteger($this->ressources[0]);
|
|
|
111 |
$this->format_reponse .= '/id';
|
|
|
112 |
//requete : /ontologies/#classe:#code (ex : /ontologies/rangTaxo:290)
|
|
|
113 |
} elseif (strrpos($this->ressources[0], ':') !== false) {
|
|
|
114 |
$this->format_reponse .= '/id';
|
|
|
115 |
preg_match('/^([^:]+):([^:]+)$/', $this->ressources[0], $match);
|
|
|
116 |
$this->requete_condition[] =
|
|
|
117 |
' id = (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[2])
|
|
|
118 |
.' AND classe_id = (SELECT id FROM '.$this->table.' WHERE code = '.$this->getBdd()->proteger($match[1]).'))';
|
|
|
119 |
} else {
|
|
|
120 |
$e = 'Erreur dans les paramètres de recherche de votre requête : </br> Le paramètre " '
|
|
|
121 |
.$this->ressources[0].' " n\'existe pas.';
|
|
|
122 |
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
|
|
|
123 |
}
|
|
|
124 |
}
|
|
|
125 |
|
|
|
126 |
|
|
|
127 |
public function traiterRessourceRelations() {
|
|
|
128 |
//requete = /ontologies/#id/relations :
|
|
|
129 |
if ($this->ressources[1] == 'relations') {
|
|
|
130 |
$this->format_reponse .= '/relations';
|
|
|
131 |
$this->requete_condition = array('classe_id = (SELECT classe_id FROM '.$this->table.' WHERE '
|
|
|
132 |
.implode(' AND ', $this->requete_condition).')');
|
|
|
133 |
}
|
|
|
134 |
}
|
|
|
135 |
|
|
|
136 |
//+--------------------------FONCTION ASSEMBLAGE DE LA REQUETE-------------------------------------------+
|
|
|
137 |
|
|
|
138 |
public function assemblerLaRequete() {
|
|
|
139 |
$requete = ' SELECT '.$this->formerRequeteChamp().
|
|
|
140 |
' FROM '.$this->table
|
|
|
141 |
.$this->retournerRequeteCondition()
|
|
|
142 |
.$this->formerRequeteLimite(); //print_r($requete);
|
|
|
143 |
return $requete;
|
|
|
144 |
}
|
|
|
145 |
|
|
|
146 |
public function formerRequeteChamp() {
|
|
|
147 |
$champ[] = 'id';
|
|
|
148 |
if ($this->format_reponse == 'ontologies') {
|
|
|
149 |
$champ[] = 'nom, code ';
|
|
|
150 |
}
|
|
|
151 |
if (isset($this->parametres['retour_champs']) || $this->format_reponse == 'ontologies/id/champs') {
|
|
|
152 |
$champs_recherches = explode(',', $this->parametres['retour_champs']);
|
|
|
153 |
$champs_possibles = $this->rechercherChampsPossibles();
|
|
|
154 |
foreach ($champs_recherches as $champ_recherche) {
|
|
|
155 |
if ($this->verifierValiditeChamp($champ_recherche)) {
|
|
|
156 |
$champ[] = (preg_match('/classe/', $champ_recherche)) ? 'classe_id' : $champ_recherche;
|
|
|
157 |
}
|
|
|
158 |
}
|
|
|
159 |
}
|
|
|
160 |
if (count($champ) == 1) {
|
|
|
161 |
$champ = array(' * ');
|
|
|
162 |
}
|
|
|
163 |
return implode(', ', $champ);
|
|
|
164 |
}
|
|
|
165 |
|
|
|
166 |
public function rechercherChampsPossibles() {
|
|
|
167 |
$this->recupererNomChamp($this->table);
|
|
|
168 |
$champs_possibles = $this->champs_table;
|
|
|
169 |
$champs_possibles[] = 'classe.id';
|
|
|
170 |
$champs_possibles[] = 'classe';
|
|
|
171 |
$champs_possibles[] = 'classe.href';
|
|
|
172 |
return $champs_possibles;
|
|
|
173 |
}
|
|
|
174 |
|
|
|
175 |
public function verifierValiditeChamp($champ, $champs_possibles) {
|
|
|
176 |
$validite = false;
|
|
|
177 |
preg_match('/^([^.]+)(:?\.([^.]+))?$/', $champ, $match);
|
|
|
178 |
if (in_array($match[1], $champs_possibles)) {
|
|
|
179 |
$validite = true;
|
|
|
180 |
} else {
|
|
|
181 |
$champs = implode('</li><li>', $champs_possibles);
|
|
|
182 |
$e = 'Erreur dans votre requête : </br> Le champ "'.$champ
|
|
|
183 |
.'" n\'existe pas. Les champs disponibles sont : <li>'.$champs.'</li>';
|
|
|
184 |
$this->renvoyerErreur(RestServeur::HTTP_CODE_MAUVAISE_REQUETE, $e);
|
|
|
185 |
}
|
|
|
186 |
return $validite;
|
|
|
187 |
}
|
|
|
188 |
|
|
|
189 |
public function retournerRequeteCondition() {
|
|
|
190 |
$condition = '';
|
|
|
191 |
if ($this->requete_condition !== null) {
|
|
|
192 |
$condition = ' WHERE '.implode(' AND ', $this->requete_condition);
|
|
|
193 |
}
|
|
|
194 |
return $condition;
|
|
|
195 |
}
|
|
|
196 |
|
|
|
197 |
public function formerRequeteLimite() {
|
|
|
198 |
$this->total_resultat = $this->recupererTotalResultat();
|
|
|
199 |
if (in_array($this->format_reponse , array('textes/id', 'textes/id/relations'))) {
|
|
|
200 |
$this->requete_limite = '';
|
|
|
201 |
} elseif (($depart = $this->limite_requete['depart']) > ($this->total_resultat)) {
|
|
|
202 |
$this->limite_requete['depart'] =
|
|
|
203 |
(($this->total_resultat - $this->limite_requete['limite']) < 0) ? 0 : ($this->total_resultat - $this->limite_requete['limite']);
|
|
|
204 |
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
|
|
|
205 |
} else {
|
|
|
206 |
$this->requete_limite = ' LIMIT '.$this->limite_requete['depart'].', '.$this->limite_requete['limite'];
|
|
|
207 |
}
|
|
|
208 |
return $this->requete_limite;
|
|
|
209 |
}
|
|
|
210 |
|
|
|
211 |
|
|
|
212 |
public function recupererTotalResultat() {
|
|
|
213 |
//on récupère le nombre total de résultats de la requete (ex : le nombre d'id contenu dans la liste /ontologies)
|
|
|
214 |
$requete = 'SELECT count(*) as nombre FROM '
|
|
|
215 |
.$this->table
|
|
|
216 |
.$this->retournerRequeteCondition();
|
|
|
217 |
$res = $this->getBdd()->recuperer($requete);
|
|
|
218 |
if ($res) {
|
|
|
219 |
$total = $res['nombre'];
|
|
|
220 |
} else {
|
|
|
221 |
$e = 'Données introuvables dans la base';
|
|
|
222 |
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
|
|
|
223 |
Debug::printr($requete);
|
|
|
224 |
}
|
|
|
225 |
return $total;
|
|
|
226 |
}
|
|
|
227 |
|
|
|
228 |
//+------------------------------------------------------------------------------------------------------+
|
|
|
229 |
public function retournerResultatFormate($resultat) {
|
|
|
230 |
// determine en fct du service appelé (/ontologies | /ontologies/#id | /ontologies/#id/champ |
|
|
|
231 |
// /ontologies/#id/relations) le format du tableau à retourner. Encode en json
|
|
|
232 |
switch ($this->format_reponse) {
|
|
|
233 |
case 'ontologies' : $reponse = $this->formaterOntologies($resultat); break;
|
|
|
234 |
case 'ontologies/id' : $reponse = $this->formaterOntologiesId($resultat[0]); break;
|
|
|
235 |
case 'ontologies/id/relations' : $reponse = $this->formaterOntologiesIdRelations($resultat); break;
|
|
|
236 |
default : break;
|
|
|
237 |
}
|
|
|
238 |
return $reponse;
|
|
|
239 |
}
|
|
|
240 |
|
|
|
241 |
|
|
|
242 |
public function formaterOntologies($resultat) {
|
|
|
243 |
$this->ajouterEnteteResultat($resultat);
|
|
|
244 |
$table_retour_json['entete'] = $this->ajouterEnteteResultat($resultat);
|
|
|
245 |
if (isset($this->parametres['masque_code']) || isset($this->parametres['masque'])) {
|
|
|
246 |
$resultat = $this->trierRechercheFloue($this->parametres['masque_code'], $resultat, 'code');
|
|
|
247 |
} elseif (isset($this->parametres['masque_nom'])) {
|
|
|
248 |
$resultat = $this->trierRechercheFloue($this->parametres['masque_nom'], $resultat, 'nom');
|
|
|
249 |
} elseif (isset($this->parametres['masque_description'])) {
|
|
|
250 |
$resultat = $this->trierRechercheFloue($this->parametres['masque_description'], $resultat, 'description');
|
|
|
251 |
}
|
|
|
252 |
//on remplit la table $table_retour_json['resultat']
|
|
|
253 |
foreach ($resultat as $tab) {
|
|
|
254 |
$num = $tab['id'];
|
|
|
255 |
unset($tab['id']);
|
|
|
256 |
foreach ($tab as $param => $valeur) {
|
|
|
257 |
$resultat_json[$num][$param] = $valeur;
|
|
|
258 |
}
|
|
|
259 |
if ($this->retour_format == 'max') $resultat_json[$num]['href'] = $this->ajouterHref('ontologies', $num);
|
|
|
260 |
}
|
|
|
261 |
$table_retour_json['resultat'] = $resultat_json;
|
|
|
262 |
return $table_retour_json;
|
|
|
263 |
}
|
|
|
264 |
|
|
|
265 |
public function ajouterEnteteResultat($resultat) {
|
|
|
266 |
//on remplit la table $table_retour_json['entete']
|
|
|
267 |
$entete['depart'] = $this->limite_requete['depart'];
|
|
|
268 |
$entete['limite'] = $this->limite_requete['limite'];
|
|
|
269 |
$entete['total'] = $this->total_resultat;
|
|
|
270 |
//formuler les urls
|
|
|
271 |
$url = $this->formulerUrl($this->total_resultat, '/ontologies');
|
|
|
272 |
if (isset($url['precedent']) && $url['precedent'] != '') { $entete['href.precedent'] = $url['precedent']; }
|
|
|
273 |
if (isset($url['suivant']) && $url['suivant'] != '') { $entete['href.suivant'] = $url['suivant']; }
|
|
|
274 |
return $entete;
|
|
|
275 |
}
|
|
|
276 |
|
|
|
277 |
|
|
|
278 |
public function formaterOntologiesId($resultat) {
|
|
|
279 |
$table_retour = array();
|
|
|
280 |
foreach ($resultat as $key => $valeur) {
|
|
|
281 |
if ($valeur != '') {
|
|
|
282 |
$table_retour = array_merge($table_retour, $this->afficherDonnees($key, $valeur));
|
|
|
283 |
}
|
|
|
284 |
}
|
|
|
285 |
return $table_retour;
|
|
|
286 |
}
|
|
|
287 |
|
|
|
288 |
public function afficherDonnees($champ, $valeur) {
|
|
|
289 |
$retour[$champ] = $valeur;
|
|
|
290 |
if ($this->retour_format == 'max') {
|
|
|
291 |
if ($champ == 'classe_id') {
|
|
|
292 |
unset($retour[$champ]); // remplacer par classe.id
|
|
|
293 |
if ($valeur != "0") { // pas de parent
|
|
|
294 |
if (isset($this->parametres['retour_champs'])) {
|
|
|
295 |
switch ($this->parametres['retour_champs']) {
|
|
|
296 |
case 'classe' : $retour['classe'] = $this->ajouterClasseCorrespondante($valeur); break;
|
|
|
297 |
case 'classe.id' : $retour['classe.id'] = $valeur; break;
|
|
|
298 |
case 'classe.href' : $retour['classe.href'] = $this->ajouterHref('ontologies', $valeur); break;
|
|
|
299 |
case 'classe.*' : $retour['classe.id'] = $valeur; $retour['classe.href'] = $this->ajouterHref('ontologies', $valeur); break;
|
|
|
300 |
}
|
|
|
301 |
} else {
|
|
|
302 |
$nom_classe = $this->ajouterClasseCorrespondante($valeur);
|
|
|
303 |
if (isset($nom_classe)) $retour['classe'] = $nom_classe;
|
|
|
304 |
$retour['classe.id'] = $valeur;
|
|
|
305 |
$retour['classe.href'] = $this->ajouterHref('ontologies', $valeur);
|
|
|
306 |
}
|
|
|
307 |
}
|
|
|
308 |
}
|
|
|
309 |
}
|
|
|
310 |
return $retour;
|
|
|
311 |
}
|
|
|
312 |
|
|
|
313 |
/** Recherche par interrogation de la base, le nom de la classe à partir de son identifiant (classe.id) */
|
|
|
314 |
public function ajouterClasseCorrespondante($classe_id) {
|
|
|
315 |
$nom = null;
|
|
|
316 |
if ($classe_id != 0) {
|
|
|
317 |
$nom = '';
|
|
|
318 |
$req = 'SELECT nom FROM '.$this->table.' WHERE id = '.$this->getBdd()->proteger($classe_id);
|
|
|
319 |
$res = $this->getBdd()->recuperer($req);
|
|
|
320 |
if ($res) {
|
|
|
321 |
$nom = $res['nom'];
|
|
|
322 |
} else {
|
|
|
323 |
$e = "Données introuvables dans la table $this->table";
|
|
|
324 |
$this->renvoyerErreur(RestServeur::HTTP_CODE_RESSOURCE_INTROUVABLE, $e);
|
|
|
325 |
Debug::printr($req);
|
|
|
326 |
}
|
|
|
327 |
}
|
|
|
328 |
return $nom;
|
|
|
329 |
}
|
|
|
330 |
|
|
|
331 |
public function formaterOntologiesIdRelations($resultat) {
|
|
|
332 |
$retour = null;
|
|
|
333 |
if ($resultat != '') {
|
|
|
334 |
$retour['entete'] = $this->ajouterEnteteResultat($resultat);
|
|
|
335 |
//on remplit la table $table_retour_json['resultat']
|
|
|
336 |
foreach ($resultat as $tab) {
|
|
|
337 |
$num = $tab['id'];
|
|
|
338 |
$retour['resultat'][$num]['nom'] = $tab['nom'];
|
|
|
339 |
if ($this->retour_format == 'max') {
|
|
|
340 |
$retour['resultat'][$num]['href'] = $this->ajouterHref('ontologies', $num);
|
|
|
341 |
}
|
|
|
342 |
}
|
|
|
343 |
}
|
|
|
344 |
return $retour;
|
|
|
345 |
}
|
|
|
346 |
}
|
|
|
347 |
?>
|