libilsws

libilsws

パトロン機能のための SirsiDynix Symphony Web Services API (ILSWS) の使用をサポートする PHP パッケージ

ジョン・ハウザー [email protected]

設計目標

• パブリック関数へのすべての入力を検証する
• 明確で明確なエラー メッセージを生成する
• SirsiDynix エラー メッセージ (不明瞭な場合もあります) をできる限り防ぐか置き換えます
• パトロンの作成、変更、検索、認証のための簡単で高度な機能を提供します
• すべての関数のコード例を提供する
• コードを変更せずに簡単な再構成をサポートし、Symphony 構成への変更をミラーリングします。
• コードを変更せずに、有効な Symphony パトロン フィールドのパトロン登録または更新をサポートします。
• 他のライブラリによる簡単な適応を可能にする

公的行事

低レベル

これらの機能は、有効な ILSWS アクセス ポイントで使用できます。エラーが発生すると例外がスローされます。

• 接続する （）
• send_get($url, $token, $params)
• send_query($url, $token, $query_json, $query_type)

便利な機能

これらの関数は ILSWS アクセス ポイントに対応しますが、すべての入力を検証し、不適切な入力が指定された場合は例外をスローします。

• Authenticate_patron($token, $patron_id, $password)
• change_barcode($token, $patron_key, $patron_id, $options)
  オプション配列には次のものが含まれる場合があります: role、client_id
• change_item_library($token, $item_key, $library)
• change_patron_password($token, $json, $options)
  オプション配列には次のものが含まれる場合があります: role、client_id
• delete_patron($token, $patron_key)
• description_bib($token)
• 説明項目($token)
• description_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)

ハイレベル

これらの関数は、複数のクエリを実行したり、Symphony システムからのデータを結合、操作、評価したりすることによって、ILWSS によって直接サポートされていない機能を提供します。

• 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)
  オプション配列には、ロール、client_id、テンプレート、件名が含まれる場合があります。
• リセット_パトロン_パスワード($token, $patron_id, $url, $email)
  オプション: 電子メール
• search_authenticate($token, $index, $search, $password)
• search_bib($token, $index, $value, $params)
  Params 配列には、q、ct、rw、j、includeFields が含まれる可能性があります。
• update_patron($patron, $token, $patron_key, $addr_num)
• update_patron_activeid($token, $patron_key, $patron_id, $option)
  オプションは次のとおりです: a、i、d
• update_phone_list($phone_list, $token, $patron_key, $options)
  オプション配列には次のものが含まれる場合があります: role、client_id

日付と電話番号の形式

開発者の便宜を図るため、コード ライブラリは、日付がパラメーターとして受け入れられる場合は常に、YYYYMMDD、YYYY-MM-DD、YYYY/MM/DD、MM-DD-YYYY、または MM/DD/ の形式で日付を受け入れます。 ＹＹＹＹ。

電話番号の検証ルールは現在、句読点のない数字の文字列を想定するように設定されています。ただし、電話番号の句読点を受け入れるように、パブリック関数の先頭にある検証ルールを変更するのは簡単です。

例

初期化して 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();

パトロンを探す

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

パトロンの属性を取得する

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

新しいパトロンを登録する

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

パトロン記録を更新する

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

書誌レコードの検索

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

includeFields パラメータに関する注意:

• MARC データをタグ別に含めるには、よだれかけアイテムを追加します。たとえば、650 タグ、サブフィールド a を取得するには、 bib{650_a}を追加します。
• 項目レコードから請求番号または項目を取得するには、callList 項目を含める必要があります。たとえば、 callList{callNumber}を追加します。
• 項目レコードからフィールドを取得するには、callList 項目内に itemList エントリを含める必要があります。たとえば、バーコードを取得するには、 callList{itemList{barcode}}を追加します。

詳細情報

YAML 構成オプションのフィールド定義とドキュメントについては、 libilsws .yaml.sample ファイルを参照してください。

コード例の完全なセットについては、 testディレクトリ内のサンプル スクリプトを参照してください。

警告:テスト スクリプトは、構成された Symphony システムに実際の変更を加える可能性があります。動作を慎重に検討することなく実稼働システムで使用しないでください。