API de la recherche : Différence entre versions
De OviWiki
(Nouvelle page : {{Warning|Cette API est disponible à partir de Ovidentia 7.0.0}}) |
|||
| Ligne 1 : | Ligne 1 : | ||
{{Warning|Cette API est disponible à partir de Ovidentia 7.0.0}} | {{Warning|Cette API est disponible à partir de Ovidentia 7.0.0}} | ||
| + | |||
| + | |||
| + | == 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 <code>utilit/searchapi.php</code> et utiliser la classe </code>bab_Search</code> | ||
| + | |||
| + | exemple : | ||
| + | |||
| + | <source lang="php"> | ||
| + | include_once $babInstallPath."utilit/searchapi.php"; | ||
| + | bab_Search::getRealms(); | ||
| + | </source> | ||
| + | |||
| + | {{Information: toutes les méthode de la classe <code>bab_Search</code> sont statiques.}} | ||
| + | |||
| + | ==== Obtenir la liste des environnements de recherche ==== | ||
| + | |||
| + | <code>bab_Search::getRealms();</code> retourne un tableau d'objets qui héritent tous de la classe bab_SearchRealm | ||
| + | |||
| + | ==== Obtenir un environement de recherche ==== | ||
| + | |||
| + | <code>bab_Search::getRealm('bab_SearchRealmContacts');</code> permet d'obtenir l'objet qui permet d'effectuer une recherche dans les contacts. | ||
| + | |||
| + | |||
| + | |||
| + | === Enregistrer un nouveau "Realm" === | ||
| + | |||
| + | |||
| + | == Les environnements de recherche == | ||
Version du 9 février 2009 à 12:43
|
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>
{{Information: 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.
