libilsws

libilsws

PHP-Paket zur Unterstützung der Verwendung der SirsiDynix Symphony Web Services API (ILSWS) für Benutzerfunktionen

John Houser [email protected]

Designziele

• Validieren Sie alle Eingaben in öffentliche Funktionen
• Erstellen Sie klare, klare Fehlermeldungen
• Verhindern oder ersetzen Sie SirsiDynix-Fehlermeldungen (die manchmal unklar sind) so weit wie möglich
• Stellen Sie einfache, umfassende Funktionen zum Erstellen, Ändern, Suchen und Authentifizieren von Benutzern bereit
• Stellen Sie Codebeispiele für alle Funktionen bereit
• Unterstützen Sie eine einfache Neukonfiguration ohne Codeänderungen, um Änderungen an der Symphony-Konfiguration widerzuspiegeln
• Unterstützen Sie Benutzerregistrierungen oder Aktualisierungen aller gültigen Symphony-Benutzerfelder ohne Codeänderungen
• Ermöglichen Sie eine einfache Anpassung durch andere Bibliotheken

Öffentliche Funktionen

Niedriges Niveau

Diese Funktionen können mit jedem gültigen ILSWS-Zugangspunkt verwendet werden. Sie lösen bei Fehlern Ausnahmen aus.

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

Komfortfunktionen

Diese Funktionen entsprechen ILSWS-Zugriffspunkten, validieren jedoch alle Eingaben und lösen Ausnahmen aus, wenn unangemessene Eingaben angezeigt werden.

• Authenticate_patron($token, $patron_id, $password)
• change_barcode($token, $patron_key, $patron_id, $options)
  Das Optionsarray kann Folgendes enthalten: Rolle, Client_ID
• change_item_library($token, $item_key, $library)
• change_patron_password($token, $json, $options)
  Das Optionsarray kann Folgendes enthalten: Rolle, Client_ID
• delete_patron($token, $patron_key)
• beschreiben_bib($token)
• beschreiben_item($token)
• beschreiben_patron($token)
• get_expiration($days)
• 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)

Hohes Niveau

Diese Funktionen bieten Funktionen, die von ILSWS nicht direkt unterstützt werden, indem sie mehrere Abfragen durchführen oder Daten aus dem Symphony-System kombinieren, bearbeiten oder auswerten.

• 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($token, $bib_key)
• get_call_number($token, $call_key, $field_list)
• get_catalog_indexes($token)
• get_hold($token, $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($token)
• Prepare_search($terms)
• register_patron($patron, $token, $addr_num, $options)
  Das Optionsarray kann Folgendes umfassen: Rolle, Client_ID, Vorlage, Betreff
• reset_patron_password($token, $patron_id, $url, $email)
  Optional: E-Mail
• search_authenticate($token, $index, $search, $password)
• search_bib($token, $index, $value, $params)
  Das Params-Array kann Folgendes enthalten: q, ct, rw, j, includeFields
• update_patron($patron, $token, $patron_key, $addr_num)
• update_patron_activeid($token, $patron_key, $patron_id, $option)
  Option kann sein: a, i, d
• update_phone_list($phone_list, $token, $patron_key, $options)
  Das Optionsarray kann Folgendes enthalten: Rolle, Client_ID

Datums- und Telefonnummerformate

Zur Vereinfachung für Entwickler akzeptiert die Codebibliothek Datumsangaben in den folgenden Formaten, sofern ein Datum als Parameter akzeptiert wird: JJJJMMTT, JJJJ-MM-TT, JJJJ/MM/TT, MM-TT-JJJJ oder MM/TT/ JJJJ.

Die Validierungsregeln für Telefonnummern sind derzeit so eingestellt, dass sie eine Ziffernfolge ohne Satzzeichen erwarten. Es wäre jedoch einfach, die Validierungsregeln oben in jeder öffentlichen Funktion zu ändern, um Satzzeichen in Telefonnummern zu akzeptieren.

Beispiele

Initialisieren und verbinden Sie sich mit 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();

Suchen Sie nach einem Gönner

 /** 
 * 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);

Erhalten Sie Benutzerattribute

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

Registrieren Sie einen neuen Benutzer

 /**
 * 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);

Benutzerdatensatz aktualisieren

 // 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);

Suche nach bibliografischen Datensätzen

 /**
 * 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);

Hinweise zum includeFields-Parameter:

• Um MARC-Daten nach Tag einzuschließen, fügen Sie ein Titelelement hinzu. Um beispielsweise das 650-Tag zu erhalten, fügen Sie Unterfeld a hinzu: bib{650_a}
• Um eine Signatur oder ein beliebiges Element aus dem Exemplardatensatz abzurufen, müssen Sie ein CallList-Element einschließen. Fügen Sie beispielsweise callList{callNumber} hinzu
• Um ein beliebiges Feld aus dem Artikeldatensatz abzurufen, müssen Sie einen itemList-Eintrag in das callList-Element einfügen. Um beispielsweise einen Barcode zu erhalten, fügen Sie callList{itemList{barcode}} hinzu.

Weitere Informationen

Felddefinitionen und Dokumentation der YAML-Konfigurationsoptionen finden Sie in der Datei libilsws .yaml.sample.

Einen vollständigen Satz an Codebeispielen finden Sie in den Beispielskripten im test .

Warnung: Die Testskripte können echte Änderungen am konfigurierten Symphony-System vornehmen. Nicht auf einem Produktionssystem verwenden, ohne sorgfältig zu prüfen, was sie tun!