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)
  옵션 배열에는 역할, client_id가 포함될 수 있습니다.
• change_item_library($token, $item_key, $library)
• change_patron_password($token, $json, $options)
  옵션 배열에는 역할, client_id가 포함될 수 있습니다.
• delete_patron($token, $patron_key)
• explain_bib($token)
• explain_item($token)
• explain_patron($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($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)
  옵션 배열에는 역할, 클라이언트 ID, 템플릿, 제목이 포함될 수 있습니다.
• Reset_patron_password($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)
  옵션 배열에는 역할, 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}} 추가하세요.

추가 정보

YAML 구성 옵션의 필드 정의 및 문서는 libilsws .yaml.sample 파일을 참조하세요.

전체 코드 예제 세트를 보려면 test 디렉터리의 예제 스크립트를 참조하세요.

경고: 테스트 스크립트는 구성된 Symphony 시스템을 실제로 변경할 수 있습니다. 수행하는 작업을 주의 깊게 검토하지 않고 프로덕션 시스템에서 사용하지 마십시오!