API de la recherche : Différence entre versions
(→Interroger l'API) |
|||
| Ligne 27 : | Ligne 27 : | ||
<code>bab_Search::getRealm('bab_SearchRealmContacts');</code> permet d'obtenir l'objet qui permet d'effectuer une recherche dans les contacts. | <code>bab_Search::getRealm('bab_SearchRealmContacts');</code> permet d'obtenir l'objet qui permet d'effectuer une recherche dans les contacts. | ||
| − | === Enregistrer un | + | === Enregistrer un nouvel environnement === |
| + | Pour créer un environnement de recherche, il faut créer un objet qui hérite de <code>bab_searchRealm</code> | ||
== Les environnements de recherche == | == Les environnements de recherche == | ||
Version du 9 février 2009 à 12:48
|
Cette API est disponible à partir de Ovidentia 7.0.0 |
Sommaire
Utilisation de l'API
L'API de recherche est un ensemble de classes avec des interfaces communes pour interroger les différentes parties d'Ovidentia. Chaque partie d'Ovidentia proposant une interface de recherche sera enregistré au travers d'un événement dans l'API et sera appelé "realm" (environement de recherche).
Interroger l'API
Il faut inclure le fichier utilit/searchapi.php et utiliser la classe </code>bab_Search</code>
exemple :
<source lang="php">
include_once $babInstallPath."utilit/searchapi.php"; bab_Search::getRealms();
</source>
|
toutes les méthode de la classe bab_Search sont statiques.
|
Obtenir la liste des environnements de recherche
bab_Search::getRealms(); retourne un tableau d'objets qui héritent tous de la classe bab_SearchRealm
Obtenir un environement de recherche
bab_Search::getRealm('bab_SearchRealmContacts'); permet d'obtenir l'objet qui permet d'effectuer une recherche dans les contacts.
Enregistrer un nouvel environnement
Pour créer un environnement de recherche, il faut créer un objet qui hérite de bab_searchRealm
