libilsws下載 - libilsws原始碼下載

libilsws

其他類別

v1.3.0

下載

libilsws

支援使用 SirsiDynix Symphony Web 服務 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)
更改條碼（$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
刪除_patron($token, $patron_key)
描述_bib($token)
描述項目（$令牌）
描述_贊助人（$令牌）
get_expiration($天)
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 系統的資料來提供 ILSWS 不直接支援的功能。

authenticate_patron_id($令牌,$patron_id,$密碼)
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_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)
準備搜尋($terms)
register_patron($patron, $token, $addr_num, $options)
選項數組可能包括：角色、client_id、模板、主題
Reset_patron_password($token, $patron_id, $url, $email)
可選：電子郵件
search_authenticate（$令牌，$索引，$搜索，$密碼）
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/ YYYY。

電話號碼的驗證規則目前設定為期望一串不帶標點符號的數字。然而，修改任何公共函數頂部的驗證規則以接受電話號碼中的標點符號是很容易的。

範例

初始化並連接到 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}}