libilsws

libilsws

Paket PHP untuk mendukung penggunaan SirsiDynix Symphony Web Services API (ILSWS) untuk fungsi pelindung

John Houser [email protected]

Tujuan Desain

• Validasi semua masukan ke fungsi publik
• Menghasilkan pesan kesalahan yang bersih dan jelas
• Cegah atau ganti pesan kesalahan SirsiDynix (yang terkadang tidak jelas) sebisa mungkin
• Menyediakan fungsi tingkat tinggi yang mudah untuk membuat, memodifikasi, mencari, dan mengautentikasi patron
• Berikan contoh kode untuk semua fungsi
• Mendukung konfigurasi ulang yang mudah tanpa perubahan kode untuk mencerminkan perubahan pada konfigurasi Symphony
• Mendukung pendaftaran patron atau pembaruan bidang patron Simfoni yang valid tanpa perubahan kode
• Memungkinkan adaptasi yang mudah oleh perpustakaan lain

Fungsi Publik

Tingkat rendah

Fungsi-fungsi ini dapat digunakan dengan titik akses ILSWS apa pun yang valid. Mereka akan memberikan pengecualian jika ada kesalahan.

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

Fungsi Kenyamanan

Fungsi-fungsi ini sesuai dengan titik akses ILSWS, namun fungsi ini memvalidasi semua masukan dan akan memberikan pengecualian jika disajikan dengan masukan yang tidak sesuai.

• autentikasi_patron($token, $patron_id, $kata sandi)
• ubah_barcode($token, $patron_key, $patron_id, $options)
  Array opsi dapat mencakup: peran, client_id
• change_item_library($token, $item_key, $library)
• change_patron_password($token, $json, $pilihan)
  Array opsi dapat mencakup: peran, client_id
• delete_patron($token, $patron_key)
• deskripsikan_bib($token)
• deskripsikan_item($token)
• deskripsikan_patron($token)
• get_expiration($hari)
• get_policy($token, $policy_key)
• search_patron($token, $index, $search, $params)
• search_patron_alt_id($token, $alt_id, $hitungan)
• search_patron_id($token, $patron_id, $hitungan)
• transit_item($token, $item_key, $perpustakaan_baru, $perpustakaan_kerja)
• untransit_item($token, $item_id)
• update_patron_activity($token, $patron_id)

Tingkat tinggi

Fungsi-fungsi ini menawarkan fungsionalitas yang tidak secara langsung didukung oleh ILSWS dengan melakukan beberapa kueri atau dengan menggabungkan, memanipulasi, atau mengevaluasi data dari sistem Symphony.

• autentikasi_patron_id($token, $patron_id, $kata sandi)
• check_duplikat($token, $index1, $pencarian1, $index2, $pencarian2)
• email_template($patron, $ke, $dari, $subjek, $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)
• persiapan_penelusuran($istilah)
• register_patron($patron, $token, $addr_num, $pilihan)
  Array opsi dapat mencakup: peran, client_id, templat, subjek
• reset_patron_password($token, $patron_id, $url, $email)
  Opsional: email
• pencarian_authenticate($token, $indeks, $pencarian, $kata sandi)
• pencarian_bib($token, $indeks, $nilai, $params)
  Array params dapat mencakup: q, ct, rw, j, includeFields
• update_patron($patron, $token, $patron_key, $addr_num)
• update_patron_activeid($token, $patron_key, $patron_id, $option)
  Pilihannya mungkin: a, i, d
• update_phone_list($phone_list, $token, $patron_key, $options)
  Array opsi dapat mencakup: peran, client_id

Format Tanggal dan Nomor Telepon

Demi kenyamanan pengembang, pustaka kode menerima tanggal dalam format berikut, di mana pun tanggal diterima sebagai parameter: YYYYMMDD, YYYY-MM-DD, YYYY/MM/DD, MM-DD-YYYY, atau MM/DD/ YYYY.

Aturan validasi untuk nomor telepon saat ini ditetapkan untuk mengharapkan serangkaian digit tanpa tanda baca. Namun, akan mudah untuk mengubah aturan validasi di bagian atas fungsi publik mana pun untuk menerima tanda baca pada nomor telepon.

Contoh

Inisialisasi dan Hubungkan ke 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();

Cari Pelindung

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

Dapatkan Atribut Pelindung

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

Daftarkan Patron Baru

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

Perbarui Catatan Patron

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

Cari catatan bibliografi

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

Catatan tentang parameter includeFields:

• Untuk menyertakan data MARC berdasarkan tag, tambahkan item bib. Misalnya, untuk mendapatkan tag 650, subkolom a, tambahkan: bib{650_a}
• Untuk mendapatkan nomor panggilan atau item apa pun dari rekaman item, Anda harus menyertakan item CallList. Misalnya, tambahkan callList{callNumber}
• Untuk mendapatkan bidang apa pun dari catatan item, Anda harus menyertakan entri itemList dalam item callList. Misalnya, untuk mendapatkan kode batang, tambahkan callList{itemList{barcode}}

Informasi Lebih Lanjut

Lihat file libilsws .yaml.sample untuk definisi bidang dan dokumentasi opsi konfigurasi YAML.

Untuk contoh kode lengkap, lihat contoh skrip di direktori test .

Peringatan: skrip pengujian mungkin membuat perubahan nyata pada sistem Symphony yang dikonfigurasi. Jangan gunakan pada sistem produksi tanpa meninjau secara cermat fungsinya!