API de la recherche - Historique des versions

Laucho : /* bab_SearchRealmFiles */

2014-07-11T14:22:14Z

‎bab_SearchRealmFiles

Laucho : /* bab_SearchRealmFiles */

2014-07-11T14:22:05Z

‎bab_SearchRealmFiles

Paul : /* bab_SearchRealmFiles */

2010-10-08T12:42:29Z

‎bab_SearchRealmFiles

Laucho : /* bab_SearchRealmFiles */

2010-10-08T12:34:33Z

‎bab_SearchRealmFiles

Laucho : /* bab_SearchRealmFiles */

2010-10-08T12:28:45Z

‎bab_SearchRealmFiles

Laucho le 8 octobre 2010 à 10:58

2010-10-08T10:58:59Z

Paul : /* bab_SearchRealmCalendars */

2010-08-19T09:10:30Z

‎bab_SearchRealmCalendars

Paul : /* bab_SearchRealmCalendars */

2010-08-19T09:09:35Z

‎bab_SearchRealmCalendars

Laucho : /* Enregistrer un nouvel environnement */

2009-04-09T08:17:04Z

‎Enregistrer un nouvel environnement

Laucho : /* Utilisation de l'API */

2009-04-09T08:13:02Z

‎Utilisation de l'API

@@ Ligne 392 : / Ligne 392 : @@
 || state || statut de suppression du fichier, la valeur peut être une chaine vide ou <code>D</code>, si la valeur est <code>D</code> le fichier se trouve dans la corbeille.
 |-
-|| relevance || Pertinance de la recherche
+|| relevance || Pertinence de la recherche
 |-
 || search || Ce champ n'est pas remonté dans les résultat, il permet d'effectuer des recherches sur le contenu des fichiers et dans les méta-données

@@ Ligne 394 : / Ligne 394 : @@
 || relevance || Pertinance de la recherche
 |-
-|| search || Ce champ n'est pas remonté dans les résultat, il permet d'effectuer des recherches sur le contenu des fichiers et dans les méta-donnés
+|| search || Ce champ n'est pas remonté dans les résultat, il permet d'effectuer des recherches sur le contenu des fichiers et dans les méta-données
 |}
@@ Ligne 417 : / Ligne 417 : @@
 </source>
-Dans cet exemple, on recherche les fichiers publiés après le 1<sup>er</sup> janvier 2009 qui contiennent '''Ovidentia''' et '''Webservices''' dans le contenu du fichier et dans les méta-donnés
+Dans cet exemple, on recherche les fichiers publiés après le 1<sup>er</sup> janvier 2009 qui contiennent '''Ovidentia''' et '''Webservices''' dans le contenu du fichier et dans les méta-données
 === bab_SearchRealmPublication ===

@@ Ligne 399 : / Ligne 399 : @@
-la méthode <code>setPrimaryCriteria</code> permet de définir le critère qui sera utilisé pour la recherche dans le contenu des fichiers et dans les méta-donnés.
+la méthode <code>setFieldLessCriteria</code> permet de définir le critère qui sera utilisé pour la recherche dans le contenu des fichiers et dans les méta-donnés.
 Exemple d'utilisation :
@@ Ligne 408 : / Ligne 408 : @@
 $primaryCriteria = $files->search->contain('Ovidentia');
 $primaryCriteria = $primaryCriteria->_AND_($files->search->contain('Webservices'));
-$files->setPrimaryCriteria($primaryCriteria);
+$files->setFieldLessCriteria($primaryCriteria);
 $criteria = $files->getDefaultCriteria();

@@ Ligne 405 : / Ligne 405 : @@
 <source lang="php">
-$files = bab_Search::getRealm('bab_SearchRealmFile');
+$files = bab_Search::getRealm('bab_SearchRealmFiles');
 $primaryCriteria = $files->search->contain('Ovidentia');
 $primaryCriteria = $primaryCriteria->_AND_($files->search->contain('Webservices'));

@@ Ligne 374 : / Ligne 374 : @@
 || name || nom du fichier
 |-
-|| id_owner || identifiant numérique du propriétaire du fichier, ce champ peut contenir l'ID du répertoire collectif dans lequel se trouve le fichier ou l'ID de l'utilisateur si le fichier se trouve dans un réertoire personnel.
+|| id_owner || identifiant numérique du propriétaire du fichier, ce champ peut contenir l'ID du répertoire collectif dans lequel se trouve le fichier ou l'ID de l'utilisateur si le fichier se trouve dans un répertoire personnel.
 |-
 || description || description du fichier

← Version précédente		Version du 8 octobre 2010 à 10:58
Ligne 289 :		Ligne 289 :


−	=== ~~bab_SearchRealmForumsPosts~~ ===	+	=== bab_SearchRealmForumPosts ===

	Recherche dans les contributions de forums		Recherche dans les contributions de forums

← Version précédente		Version du 19 août 2010 à 09:10
Ligne 582 :		Ligne 582 :

	Recherche dans les agendas		Recherche dans les agendas
		+
		+	{{Warning\|L'API de recherche sur les agenda n'est valable qu'a partir d'Ovidentia 7.4.0}}

	les champs fournis sont :		les champs fournis sont :

@@ Ligne 591 : / Ligne 591 : @@
 || ov_reference || référence vers l'événement
 |-
-|| id || identifiant numérique
+|| summary || titre
-|-
-|| title || titre
 |-
 || description || description en HTML
 |-
 || location || Lieu
 |-
 || start_date || date et heure de début au format ISO : 0000-00-00 00:00:00
@@ Ligne 603 : / Ligne 605 : @@
 || end_date || date et heure de fin au format ISO : 0000-00-00 00:00:00
 |-
-|| category || nom de la catégorie de l'événement
+|| categories || nom de la catégorie de l'événement
 |-
-|| id_cat || identifiant numérique de la catégorie
+|| calendar || identifiant de l'agenda utilisé dans l'url
 |-
-|| id_cal || identifiant numérique de l'agenda
+|| class || statut privé/public de l'événement, la valeur peut être <code>PUBLIC</code>, <code>PRIVATE</code> ou <code>CONFIDENTIAL</code>
-|-
-|| owner || identifiant numérique du propriétaire de l'agenda, la valeur peut être un ID d'utilisateur ou un ID d'agenda de ressource ou un ID d'agenda collectif
-|-
-|| type || 3 constantes possibles :
-* <code>BAB_CAL_USER_TYPE</code> : agenda personel
-* <code>BAB_CAL_PUB_TYPE</code> : agenda collectif
-* <code>BAB_CAL_RES_TYPE</code> : agenda de ressource
-|-
-|| date_modification || la date de dernière modification de l'événement
-|-
-|| bprivate || statut privé/public de l'événement, la valeur peut être <code>Y</code> ou <code>N</code>
 |}
 {{Warning|La recherche ne remonte pas un résultat par événement mais autant de résultats qu'il y a d'agendas associés à l'événement}}
 === bab_SearchRealmTags ===

@@ Ligne 48 : / Ligne 48 : @@
 Pour créer un environnement de recherche, il faut créer une classe qui hérite de la classe abstraite <code>bab_searchRealm</code>. Pour que l'objet puisse être utilisé par l'API, il faut [[API du gestionnaire d'événement|s'enregistrer]] sur l'événement <code>bab_eventSearchRealms</code>.
-Dans la fonction enregistrée sur l'événement, il faut ajouter les informations nécessaire, voici un exemple avec la recherche dans les notes :
+Dans la fonction enregistrée sur l'événement, il faut ajouter les informations nécessaires, voici un exemple avec la recherche dans les notes :
 <source lang="php">
@@ Ligne 60 : / Ligne 60 : @@
 ==== getLink() ====
-Cette méthode est optionelle, elle permet de retourner un lien http vers l'ensemble des ressources recherchées.
+Cette méthode est optionnelle, elle permet de retourner un lien http vers l'ensemble des ressources recherchées.
 ==== getSortMethods() ====
-Cette méthode doit retourner un tableau contenant la liste des méthodes d'ordonnancement des résultats possibles dans cet environnement. Les clefs du tableau sont des chaine de caractères qui permettent d'identifier la méthode utilisée au sein de l'environnement de recherche. Les Valeurs du tableaux sont des chaines de caractères internationalisées utilisées pour décrire chaque méthodes de recherche.
+Cette méthode doit retourner un tableau contenant la liste des méthodes d'ordonnancement des résultats possibles dans cet environnement. Les clés du tableau sont des chaîne de caractères qui permettent d'identifier la méthode utilisée au sein de l'environnement de recherche. Les valeurs du tableau
 Par exemple, voici la méthode <code>getSortMethods()</code> de la classe <code>bab_SearchRealmFiles</code>
@@ Ligne 83 : / Ligne 84 : @@
-Dans cet exemple, les fichiers retournées par une recherche peuvent êtres ordonnés de plusieurs façon, par pertinence, en ordre alphabétique par le nom ou par dates croissantes ou décroissantes.
+Dans cet exemple, les fichiers retournés par une recherche peuvent être ordonnés de plusieurs façons, par pertinence, en ordre alphabétique par le nom ou par dates croissantes ou décroissantes.
@@ Ligne 110 : / Ligne 111 : @@
 ==== getFields() ====
-Cette méthode doit retourner un tableau contenant la liste des champs des résultats de recherche, les clefs du tableau doivent être numériques et les valeurs doivent être des objets <code>bab_SearchField</code>. Pour simplifier la création de la liste des champs, il existe une méthode <code>createField()</code> qui prend en paramètre le nom et la description du champ pour créer l'objet.
+Cette méthode doit retourner un tableau contenant la liste des champs des résultats de recherche, les clés du tableau doivent être numériques et les valeurs doivent être des objets <code>bab_SearchField</code>. Pour simplifier la création de la liste des champs, il existe une méthode <code>createField()</code> qui prend en paramètre le nom et la description du champ pour créer l'objet.
 Un objet <code>bab_SearchField</code> peut avoir plusieurs états :

@@ Ligne 6 : / Ligne 6 : @@
 == 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).
+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ée au travers d'un événement dans l'API et sera appelé "realm" (environnement de recherche).
 === Interroger l'API ===