API PMB: Groupe pmbesSearch

Types déclarés ou référencés

1. search_field

   Nom du type:
   search_field
   Description:
   Décrit un champ de recherche
   Localisation:
   Importé du groupe pmbesTypes
   Contenu:

   id type string

   Id du champ de recherche

   label type string

   Description du champ

   type type string

   Type du champ

   operators type tableau de la structure suivante: id type string        Id de l'opération label type string        Affichage de l'opérateur

   Opérateurs du champ

   values type tableau de la structure suivante: value_id type integer        Id de la valeur value_caption type string        Affichage de la valeur

   Si fetch_values est à true et si le type du champ propose des valeurs prédéfinies:

   fieldvar type tableau de la structure suivante: label type string        Description du paramètre name type string        Nom du paramètre type type string        Type du paramètre values type tableau de la structure suivante:        Si valeurs prédéfinies value_id type integer        Valeur value_caption type string        Libellé

   Si le champ contient des paramètres modifiables par l'utilisateur

   
   
   
   Sommaire

2. unimarc_notice

   Nom du type:
   unimarc_notice
   Description:
   Désigne une notice unimarc
   Localisation:
   Importé du groupe pmbesSpecialTypes
   Contenu:

   id type string

   L'id de la notice

   header type tableau de la structure suivante: name type string        Le nom du champ value type string        La valeur du champ

   L'entête unimarc

   f type tableau de la structure suivante: c type string         ind type string         id type string         value type string         s type tableau de la structure suivante:         c type string         value type string

   Les champs f

   
   
   
   Sommaire

Méthodes

1. simpleSearch

   Nom de la méthode:
   simpleSearch
   Description:
   Effectuer une recherche simple
   Version:
   1.0
   Description des entrées:

   searchType type integer

   Le type de la recherche: 0 (SEARCH_ALL)=tous les champs, 1 (SEARCH_TITLE)=titre, 2 (SEARCH_AUTHOR)=auteur, 3 (SEARCH_EDITOR)=éditeur, 4 (SEARCH_COLLECTION)=collection, 6 (SEARCH_CATEGORIES)=catégories/mots matières

   searchTerm type string

   chaine à rechercher

   pmbUserId type integer

   l'id d'un utilisateur pmb, pour filtrer les résultats selon les droits d'accès. -1: pour ne pas en tenir compte

   OPACUserId type integer

   l'id d'un emprunteur, pour filtrer les résultats selon les droits d'accès -1: Ne pas tenir compte 0: emprunteur anonyme x: id de l'emprunteur

   Description des retours:

   searchId type string

   nom de la ressource résultat

   nbResults type integer

   nombre de résultats trouvés

   typdocs type tableau de string

   
   
   
   Sommaire

2. simpleSearchLocalise

   Nom de la méthode:
   simpleSearchLocalise
   Description:
   Effectuer une recherche simple filtrée par localisation et section
   Version:
   1.0
   Description des entrées:

   searchType type integer

   Le type de la recherche: 0 (SEARCH_ALL)=tous les champs, 1 (SEARCH_TITLE)=titre, 2 (SEARCH_AUTHOR)=auteur, 3 (SEARCH_EDITOR)=éditeur, 4 (SEARCH_COLLECTION)=collection, 6 (SEARCH_CATEGORIES)=catégories/mots matières

   searchTerm type string

   chaine à rechercher

   pmbUserId type integer

   l'id d'un utilisateur pmb, pour filtrer les résultats selon les droits d'accès. -1: pour ne pas en tenir compte

   OPACUserId type integer

   l'id d'un emprunteur, pour filtrer les résultats selon les droits d'accès -1: Ne pas tenir compte 0: emprunteur anonyme x: id de l'emprunteur

   localisation type integer

   Localisation

   section type integer

   Section

   Description des retours:

   searchId type string

   nom de la ressource résultat

   nbResults type integer

   nombre de résultats trouvés

   typdocs type tableau de string

   
   
   
   Sommaire

3. getAdvancedSearchFields

   Nom de la méthode:
   getAdvancedSearchFields
   Description:
   Récupérer la liste des champs recherchables en recherche avancée
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • getAdvancedSearchField du groupe pmbesSearch, en version 1.0
   Description des entrées:

   search_realm type string

   dans quel domaine de recherche on se situe. exemple: search_simple_fields, opac|search_fields

   lang type string

   la langue dans laquelle on souhaite les résultats

   fetch_values type boolean

   si l'on souhaite également les différentes valeurs possibles des champs, (pour les champs select par exemple)

   Description des retours:

   results type tableau de search_field id type string        Id du champ de recherche label type string        Description du champ type type string        Type du champ operators type tableau de la structure suivante:        Opérateurs du champ id type string        Id de l'opération label type string        Affichage de l'opérateur values type tableau de la structure suivante:        Si fetch_values est à true et si le type du champ propose des valeurs prédéfinies: value_id type integer        Id de la valeur value_caption type string        Affichage de la valeur fieldvar type tableau de la structure suivante:        Si le champ contient des paramètres modifiables par l'utilisateur label type string        Description du paramètre name type string        Nom du paramètre type type string        Type du paramètre values type tableau de la structure suivante:        Si valeurs prédéfinies value_id type integer        Valeur value_caption type string        Libellé

   Un tableau de champs de recherche

   
   
   
   Sommaire

4. getAdvancedSearchField

   Nom de la méthode:
   getAdvancedSearchField
   Description:
   Récupérer les informations d'un champ de recherche
   Version:
   1.0
   Description des entrées:

   field_id type string

   l'id du champ dont on souhaite les informations

   search_realm type string

   dans quel domaine de recherche on se situe. exemple: search_simple_fields, opac|search_fields

   lang type string

   la langue dans laquelle on souhaite le résultat

   fetch_values type boolean

   si l'on souhaite également les différentes valeurs possibles du champ, (pour les champs select par exemple)

   Description des retours:

   search_field type search_field id type string        Id du champ de recherche label type string        Description du champ type type string        Type du champ operators type tableau de la structure suivante:        Opérateurs du champ id type string        Id de l'opération label type string        Affichage de l'opérateur values type tableau de la structure suivante:        Si fetch_values est à true et si le type du champ propose des valeurs prédéfinies: value_id type integer        Id de la valeur value_caption type string        Affichage de la valeur fieldvar type tableau de la structure suivante:        Si le champ contient des paramètres modifiables par l'utilisateur label type string        Description du paramètre name type string        Nom du paramètre type type string        Type du paramètre values type tableau de la structure suivante:        Si valeurs prédéfinies value_id type integer        Valeur value_caption type string        Libellé

   un champ de recherche

   
   
   
   Sommaire

5. advancedSearch

   Nom de la méthode:
   advancedSearch
   Description:
   Effectuer une recherche avancée
   Version:
   1.0
   Description des entrées:

   search_realm type string

   dans quel domaine de recherche on se situe. exemple: search_simple_fields, opac|search_fields

   search type tableau de la structure suivante: inter type string        l'opérateur entre le champ et le champ précédent field type string        l'id du champ de recherche operator type string        l'opérateur de recherche value type tableau de string fieldvar type structure         id_thesaurus type tableau de string operator_between_multiple_authorities type tableau de string

   la recherche: un tableau d'une structure de recherche

   pmbUserId type integer

   l'id d'un utilisateur pmb, pour filtrer les résultats selon les droits d'accès. -1: ne pas tenir compte.

   OPACUserId type integer

   l'id d'un emprunteur, pour filtrer les résultats selon les droits d'accès -1: Ne pas tenir compte 0: emprunteur anonyme x: id de l'emprunteur

   Description des retours:

   searchId type string

   nom de la ressource résultat

   nbResults type integer

   nombre de résultats trouvés

   typdocs type tableau de string

   
   
   
   Sommaire

6. get_sort_types

   Nom de la méthode:
   get_sort_types
   Description:
   Renvoie la liste des différents tris possibles
   Version:
   1.0
   Description des entrées:
   Description des retours:

       Exemple de retour:
       Array
       (
       [0] => Array
       (
       [sort_name] => text_1
       [sort_caption] => Titre
       )
       
       [1] => Array
       (
       [sort_name] => num_2
       [sort_caption] => Indexation décimale
       )
       
       [2] => Array
       (
       [sort_name] => text_3
       [sort_caption] => Auteur
       )
     ...
   )

   results type tableau de la structure suivante: sort_name type string        L'id d'un tri sort_caption type string        Le nom d'un tri

   Les tris

   
   
   
   Sommaire

7. fetchSearchRecords

   Nom de la méthode:
   fetchSearchRecords
   Description:
   Récupérer les notices issues d'une recherche
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • fetchSearchRecordsSorted du groupe pmbesSearch, en version 1.0
   Description des entrées:

   searchId type string

   l'id renvoyé par la fonction de recherche

   firstRecord type integer

   numéro de la première notice à récupérer

   recordCount type integer

   nombre de notices à récupérer

   recordFormat type string

   format des résultats

   recordCharset type string

   le charset dans lequel on souhaite les résultats

   includeLinks type boolean

   inclure les liens entre notices, bulletins et articles

   includeItems type boolean

   inclure les exemplaires dans la zone 995

   Description des retours:

   results type tableau de la structure suivante: noticeId type integer        l'id de la notice noticeContent type string        la notice dans le format demandé

   Un tableau de résultats

   
   
   
   Sommaire

8. fetchSearchRecordsSorted

   Nom de la méthode:
   fetchSearchRecordsSorted
   Description:
   Récupérer les notices issues d'une recherche, en appliquant un tri
   Version:
   1.0
   Description des entrées:

       Le paramètre sortType se construit de la façon suivante:
       typedutri_nomdutri, avec:
       -typedutri: d ou c pour un tri croissant ou décroissant
       -nomdutri: l'id du tri (voir la fonction get_sort_types).
       
       exemples:
       -c_text_1: tri par titre croissant.
       -d_num_7: tri par année d'édition décroissante.
       -c_text_5: tri par côte croissante.

   searchId type string

   l'id renvoyé par la fonction de recherche

   firstRecord type integer

   numéro de la première notice à récupérer

   recordCount type integer

   nombre de notices à récupérer

   recordFormat type string

   format des résultats

   recordCharset type string

   le charset dans le lequel on souhaite les résultats

   includeLinks type boolean

   inclure les liens entre notices, bulletins et articles

   includeItems type boolean

   inclure les exemplaires dans la zone 995

   sortType type string

   le tri à appliquer aux résultats

   Description des retours:

   results type tableau de la structure suivante: noticeId type integer        l'id de la notice noticeContent type string        la notice dans le format demandé

   Un tableau de résultats

   
   
   
   Sommaire

9. fetchSearchRecordsArray

   Nom de la méthode:
   fetchSearchRecordsArray
   Description:
   Récupérer les notices issues d'une recherche
   Version:
   1.0
   Nécessite les méthodes suivantes:
   • fetchSearchRecordsArraySorted du groupe pmbesSearch, en version 1.0
   Description des entrées:

   searchId type string

   l'id renvoyé par la fonction de recherche

   firstRecord type integer

   numéro de la première notice à récupérer

   recordCount type integer

   nombre de notices à récupérer

   recordCharset type string

   le charset dans le lequel on souhaite les résultats

   includeLinks type boolean

   inclure les liens entre notices, bulletins et articles

   includeItems type boolean

   inclure les exemplaires dans la zone 995

   Description des retours:

   results type tableau de unimarc_notice id type string        L'id de la notice header type tableau de la structure suivante:        L'entête unimarc name type string        Le nom du champ value type string        La valeur du champ f type tableau de la structure suivante:        Les champs f c type string         ind type string         id type string         value type string         s type tableau de la structure suivante:         c type string         value type string

   Un tableau de résultats

   
   
   
   Sommaire

10. fetchSearchRecordsArraySorted

    Nom de la méthode:
    fetchSearchRecordsArraySorted
    Description:
    Récupérer les notices issues d'une recherche, en appliquant un tri
    Version:
    1.0
    Description des entrées:

        Le paramètre sortType se construit de la façon suivante:
        typedutri_nomdutri, avec:
        -typedutri: d ou c pour un tri croissant ou décroissant
        -nomdutri: l'id du tri (voir la fonction get_sort_types).
        
        exemples:
        -c_text_1: tri par titre croissant.
        -d_num_7: tri par année d'édition décroissante.
        -c_text_5: tri par côte croissante.

    searchId type string

    l'id renvoyé par la fonction de recherche

    firstRecord type integer

    numéro de la première notice à récupérer

    recordCount type integer

    nombre de notices à récupérer

    recordCharset type string

    le charset dans lequel on souhaite les résultats

    includeLinks type boolean

    inclure les liens entre notices, bulletins et articles

    includeItems type boolean

    inclure les exemplaires dans la zone 995

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de unimarc_notice id type string        L'id de la notice header type tableau de la structure suivante:        L'entête unimarc name type string        Le nom du champ value type string        La valeur du champ f type tableau de la structure suivante:        Les champs f c type string         ind type string         id type string         value type string         s type tableau de la structure suivante:         c type string         value type string

    Un tableau de résultats

    
    
    
    Sommaire

11. fetchSearchRecordsFull

    Nom de la méthode:
    fetchSearchRecordsFull
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsFullSorted du groupe pmbesSearch, en version 1.0
    Description des entrées:

    searchId type string

    firstRecord type integer

    recordCount type integer

    recordCharset type string

    includeLinks type boolean

    includeItems type boolean

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticesExplNum type tableau de explNum noticeBulletins type tableau de bulletin

    
    
    
    Sommaire

12. fetchSearchRecordsFullSorted

    Nom de la méthode:
    fetchSearchRecordsFullSorted
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeListFull du groupe pmbesNotices, en version 1.0
    Description des entrées:

    searchId type string

    firstRecord type integer

    recordCount type integer

    recordCharset type string

    includeLinks type boolean

    includeItems type boolean

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin

    
    
    
    Sommaire

13. fetchSearchRecordsFullWithBullId

    Nom de la méthode:
    fetchSearchRecordsFullWithBullId
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchSearchRecordsFullWithBullIdSorted du groupe pmbesSearch, en version 1.0
    Description des entrées:

    searchId type string

    firstRecord type integer

    recordCount type integer

    recordCharset type string

    includeLinks type boolean

    includeItems type boolean

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin

    
    
    
    Sommaire

14. fetchSearchRecordsFullWithBullIdSorted

    Nom de la méthode:
    fetchSearchRecordsFullWithBullIdSorted
    Description:
    Version:
    1.0
    Nécessite les méthodes suivantes:
    • fetchNoticeListFullWithBullId du groupe pmbesNotices, en version 1.0
    Description des entrées:

    searchId type string

    firstRecord type integer

    recordCount type integer

    recordCharset type string

    includeLinks type boolean

    includeItems type boolean

    sortType type string

    le tri à appliquer aux résultats

    Description des retours:

    results type tableau de la structure suivante: noticeId type integer         noticeContent type string         noticeItems type tableau de item noticeExplNums type tableau de explNum noticeBulletins type tableau de bulletin

    
    
    
    Sommaire

15. listExternalSources

    Nom de la méthode:
    listExternalSources
    Description:
    Version:
    1.0
    Description des entrées:

    OPACUserId type integer

    Description des retours:

    results type tableau de la structure suivante: category_caption type string         sources type tableau de la structure suivante:         source_id type string         source_caption type string         source_comment type string

    
    
    
    Sommaire

16. listFacets

    Nom de la méthode:
    listFacets
    Description:
    Récupérer les facettes issues d'une recherche
    Version:
    1.0
    Description des entrées:

    searchId type string

    l'id renvoyé par la fonction de recherche

    fields type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ

    Un tableau de facettes à calculer

    filters type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ value type string        Valeur

    Un tableau de filtres (affinage : facettes déjà sélectionnées)

    Description des retours:

    results type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ value type string         count type integer        Nombre de notices associées

    Liste des facettes calculées

    
    
    
    Sommaire

17. listRecordsFromFacets

    Nom de la méthode:
    listRecordsFromFacets
    Description:
    Récupérer les notices issues d'une ou plusieurs facettes
    Version:
    1.0
    Description des entrées:

    searchId type string

    l'id renvoyé par la fonction de recherche

    filters type tableau de la structure suivante: code_champ type integer        Code champ code_ss_champ type integer        Code sous champ value type string        Valeur

    Un tableau de filtres (affinage : facettes déjà sélectionnées)

    Description des retours:

    results type tableau de integer

    Liste des notices

    
    
    
    Sommaire