libilsws

libilsws

Package PHP pour prendre en charge l'utilisation de l'API SirsiDynix Symphony Web Services (ILSWS) pour les fonctions d'usager

John Houser [email protected]

Objectifs de conception

• Valider toutes les entrées dans les fonctions publiques
• Produisez des messages d’erreur clairs et clairs
• Prévenir ou remplacer autant que possible les messages d’erreur SirsiDynix (parfois obscurs)
• Fournir des fonctions simples et de haut niveau pour créer, modifier, rechercher et authentifier les usagers
• Fournir des exemples de code pour toutes les fonctions
• Prise en charge d'une reconfiguration facile sans modification de code pour refléter les modifications apportées à la configuration Symphony
• Prise en charge des inscriptions d'usagers ou des mises à jour de tout champ d'usager Symphony valide sans modification du code
• Permettre une adaptation facile par d’autres bibliothèques

Fonctions publiques

Bas niveau

Ces fonctions peuvent être utilisées avec n’importe quel point d’accès ILSWS valide. Ils lanceront des exceptions en cas d'erreur.

• connecter ()
• send_get($url, $token, $params)
• send_query($url, $token, $query_json, $query_type)

Fonctions pratiques

Ces fonctions correspondent aux points d'accès ILSWS, mais elles valident toutes les entrées et lèveront des exceptions si elles sont présentées avec des entrées inappropriées.

• Authenticate_patron($token, $patron_id, $password)
• change_barcode($token, $patron_key, $patron_id, $options)
  Le tableau d'options peut inclure : rôle, client_id
• change_item_library($token, $item_key, $library)
• change_patron_password ($ token, $ json, $ options)
  Le tableau d'options peut inclure : rôle, client_id
• delete_patron($token, $patron_key)
• décrire_bib ($ jeton)
• décrire_item ($ jeton)
• décrire_patron ($ jeton)
• get_expiration ($ jours)
• get_policy($token, $policy_key)
• search_patron($token, $index, $search, $params)
• search_patron_alt_id($token, $alt_id, $count)
• search_patron_id($token, $patron_id, $count)
• transit_item($token, $item_key, $new_library, $working_library)
• untransit_item($token, $item_id)
• update_patron_activity($token, $patron_id)

Haut niveau

Ces fonctions offrent des fonctionnalités non directement prises en charge par ILSWS en effectuant plusieurs requêtes ou en combinant, manipulant ou évaluant les données du système Symphony.

• Authenticate_patron_id($token, $patron_id, $password)
• check_duplicate ($ token, $ index1, $ search1, $ index2, $ search2)
• email_template($patron, $to, $from, $subject, $template)
• get_bib($token, $bib_key, $field_list)
• get_bib_circ_info($token, $bib_key)
• get_bib_marc ($ jeton, $ bib_key)
• get_call_number ($ token, $ call_key, $ field_list)
• get_catalog_indexes ($ jeton)
• get_hold ($ jeton, $ hold_key)
• get_item($token, $item_key, $field_list)
• get_item_circ_info($token, $item_key)
• get_library_paging_list($token, $library_key)
• get_patron_attributes($token, $patron_key)
• get_patron_checkouts($token, $patron_key, $include_fields)
• get_patron_indexes ($ jeton)
• préparer_recherche ($ termes)
• register_patron($patron, $token, $addr_num, $options)
  Le tableau d'options peut inclure : rôle, client_id, modèle, sujet
• reset_patron_password($token, $patron_id, $url, $email)
  Facultatif : e-mail
• search_authenticate ($ jeton, $ index, $ recherche, $ mot de passe)
• search_bib ($ jeton, $ index, $ valeur, $ params)
  Le tableau Params peut inclure : q, ct, rw, j, includeFields
• update_patron($patron, $token, $patron_key, $addr_num)
• update_patron_activeid($token, $patron_key, $patron_id, $option)
  L'option peut être : a, i, d
• update_phone_list($phone_list, $token, $patron_key, $options)
  Le tableau d'options peut inclure : rôle, client_id

Formats de date et de numéro de téléphone

Pour la commodité des développeurs, la bibliothèque de codes accepte les dates dans les formats suivants, partout où une date est acceptée comme paramètre : AAAAMMJJ, AAAA-MM-JJ, AAAA/MM/JJ, MM-JJ-AAAA ou MM/JJ/. AAAA.

Les règles de validation des numéros de téléphone sont actuellement définies pour s'attendre à une chaîne de chiffres sans ponctuation. Cependant, il serait facile de modifier les règles de validation en haut de toute fonction publique pour accepter la ponctuation dans les numéros de téléphone.

Exemples

Initialiser et se connecter à ILSWS

libilsws ('./ libilsws .yaml'); // Connect to ILSWS with configuration loaded from YAML file $token = $ilsws->connect();">

 require_once 'vendor/autoload.php';

// Initialize and load configuration from YAML configuration file
$ilsws = new libilsws  libilsws ('./ libilsws .yaml');

// Connect to ILSWS with configuration loaded from YAML file
$token = $ilsws->connect();

Rechercher un mécène

 /** 
 * Valid incoming params are: 
 * ct            = number of results to return,
 * rw            = row to start on (so you can page through results),
 * j             = boolean AND or OR to use with multiple search terms, and
 * includeFields = fields to return in result.
 */

$index = 'EMAIL';
$search = '[email protected]';

// Prepare search parameters, including fields to return
$options = [
    'rw' => 1, 
    'ct' => 10, 
    'j' => 'AND', 
    'includeFields' => 'key,barcode']
    ];

// Run search
$response = $ilsws->search_patron($token, $index, $search, $options);

Obtenir les attributs des contributeurs

 $response = $ilsws->get_patron_attributes($token, $patron_key);

Enregistrer un nouveau mécène

 /**
 * The order of the fields doesn't matter. Not all of these are actually required. 
 * See the YAML configuration file to determine which fields are required. If an
 * email template name is included in the options array, an email will be sent to the 
 * patron. Actual template files must include a language extension (for example .en for
 * English. The system will look for template that matches the patrons language
 * preference. If one is found, it will use that, otherwise it will attempt to
 * find and use an English template.
 */
$patron = [
    'birthDate' => '1962-03-07',
    'city_state' => 'Portland, OR',
    'county' => '0_MULT',
    'email' => '[email protected]',
    'firstName' => 'Bogus',
    'friends_notices' => 'YES',
    'home_library' => 'CEN',
    'language' => 'ENGLISH',
    'lastName' => 'Bogart',
    'library_news' => 'YES',
    'middleName' => 'T',
    'notice_type' => 'PHONE',
    'patron_id' => '21168045918653',
    'postal_code' => '97209',
    'street' => '925 NW Hoyt St Apt 406',
    'telephone' => '215-534-6821',
    'sms_phone' => [
        'number' => '215-534-6821',
        'countryCode' => 'US',
        'bills'       => true,
        'general'     => true,
        'holds'       => true,
        'manual'      => true,
        'overdues'    => true,
        ],
    ];

$addr_num = 1;

$options = [];
$options['role'] = 'STAFF';
$options['client_id'] = 'StaffClient';
$options['template'] = 'template.html.twig';
$options['subject'] = 'Welcome to the library!';

$response = $ilsws->register_patron($patron, $token, $addr_num, $options);

Mettre à jour le dossier de l'usager

 // Define patron array
$patron = [
    'firstName' => 'John',
    'middleName' => 'Rad',
    'lastName' => 'Houser',
    'birthDate' => '1972-03-10',
    'home_library' => 'CEN',
    'county' => '0_MULT',
    'notice_type' => 'PHONE',
    'library_news' => 'YES',
    'friends_notices' => 'YES',
    'online_update' => 'YES',
    'street' => '925 NW Hoyt St Apt 606',
    'city_state' => 'Portland, OR',
    'patron_id' => '21168045918653',
    'postal_code' => '97208',
    'email' => '[email protected]',
    'telephone' => '215-544-6941',
    'sms_phone' => [
        'number' => '215-544-6941',
        'countryCode => 'US',
        'bills'       => true,
        'general'     => true,
        'holds'       => true,
        'manual'      => true,
        'overdues'    => true,
        ],
    ];

$addr_num = 1;
$patron_key = '782339';

// Update the patron record
$response = $ilsws->update_patron($patron, $token, $patron_key, $addr_num);

Rechercher des notices bibliographiques

 /**
 * Convert UTF-8 characters with accents to ASCII and strip unwanted characters and 
 * boolean operators from search terms
 */
$search = $ilsws->prepare_search($search);

// Prepare search parameters and choose fields to return
$params = [ 
    'ct'            => '50',
    'rw'            => '1',
    'j'             => 'AND',
    'includeFields' => 'author,title,bib{650_a,856_u},callList{callNumber,itemList{barcode,currentLocation}}'
    ];

// Run search
$response = $ilsws->search_bib($token, $index, $search, $params);

Remarques sur le paramètre includeFields :

• Pour inclure des données MARC par balise, ajoutez un élément bibliographique. Par exemple, pour obtenir la balise 650, sous-champ a, ajoutez : bib{650_a}
• Pour obtenir une cote ou tout élément de l'enregistrement d'élément, vous devez inclure un élément callList. Par exemple, ajoutez callList{callNumber}
• Pour obtenir n’importe quel champ de l’enregistrement d’élément, vous devez inclure une entrée itemList dans l’élément callList. Par exemple, pour obtenir un code-barres, ajoutez callList{itemList{barcode}}

Plus d'informations

Consultez le fichier libilsws .yaml.sample pour les définitions de champs et la documentation des options de configuration YAML.

Pour un ensemble complet d'exemples de code, consultez les exemples de scripts dans le répertoire test .

Attention : les scripts de test peuvent apporter de réelles modifications au système Symphony configuré. Ne pas utiliser sur un système de production sans examiner attentivement ce qu'ils font !