Voir la source de Paramètres de la recherche

[[Catégorie:Développement de modules]]
[[Catégorie:API Ovidentia]]
[[Catégorie:Recherche]]
{{Warning|Cette normalisation des paramètres de la recherche est disponible à partir de Ovidentia 7.1.0}}

== But ==
Normaliser les paramètres passés au moteur de recherche d'OVIDENTIA afin de permettre aux utilisateurs ou aux addons de créer leur propre url de recherche. 
La recherche doit permettre de prendre en compte les GET et les POST

== Paramètres généraux ==
URL : index.php?tg=search&...


{|class="prettytable" width="100%"
|| '''Paramètre'''
| '''Description'''
|-
|| idx  || Si idx vaut 'find', la recherche est effectuée. Sinon seul le formulaire de recherche est affiché.
|-
|| what  || Mot à rechercher
|-
|| what2 || Deuxième mot à rechercher
|-
|| option || Prend une des valeurs suivantes vide, OR, AND ou NOT
|-
|| item || Vide pour recherche dans tous les objets
* ''articles'' pour rechercher dans les articles
* ''forums'' pour rechercher dans forums
* ''faqs'' pour rechercher dans les faqs
* ''notes'' pour rechercher dans les notes
* ''files'' pour rechercher dans les fichiers
* ''contacts'' pour rechercher dans contacts
* ''directories'' pour rechercher dans les annuaires
* ''calendars'' pour rechercher dans les agendas
* ''addon/addonname'' or « addon/addonid »  pour rechercher dans  un un addon spécifique
|}

== Paramètres Articles ==

{|class="prettytable" width="100%"
|| '''Paramètre'''
| '''Description'''
|-
|| topic || vide ou id du thème où rechercher
|-
|| category || vide où la catégorie où chercher
|-
|| authorid || ID de l'auteur sinon vide
|-
|| before || Date de fin au format 'YYYY-MM-DD'
|-
|| after || Date de début au format 'YYYY-MM-DD'
|}

== Paramètres Forums ==
Pas de paramètres supplémentaires

== Paramètres Faqs ==
Pas de paramètres supplémentaires

== Paramètres Notes ==
Pas de paramètres supplémentaires

== Paramètres Fichiers ==

Pas de paramètres supplémentaires

== Paramètres Contacts ==
Pas de paramètres supplémentaires

== Paramètres Annuaires ==

{|class="prettytable" width="100%"
|| '''Paramètre''' || '''Description'''
|-
|| directoryid  || ID de l'annuaire ou vide pour  tous les annuaires
|-
|| f[0]  || Nom du champ à chercher ( sn, givenname, email, etc … )
|-
|| v[0] || Valeur du champ à chercher ( sn, givenname, email, etc … )
|-
|| f[1] || Nom du champ à chercher ( sn, givenname, email, etc … )
|-
|| v[1] || Valeur du champ à chercher( sn, givenname, email, etc … ) 
|-
|| f[2] || Nom du champ à chercher ( sn, givenname, email, etc … ) 
|-
|| v[2] || Valeur du champ à chercher ( sn, givenname, email, etc … )
|}

Il est possible d'ajouter d'autres champs de recherche ou de ne pas tous les spécifier en augmentant ou en diminuant la clef des deux tableaux '''f''' et '''v'''

== Paramètres Agendas ==

{|class="prettytable" width="100%"
|| '''Paramètre'''
| '''Description'''
|-
|| calendarid  || ID de l'agenda ou vide pour  tous les agendas
|-
|| before || Date de fin au format 'YYYY-MM-DD'
|-
|| after || Date de début au format 'YYYY-MM-DD'
|}