libilsws

libilsws

Paquete PHP para admitir el uso de la API de servicios web SirsiDynix Symphony (ILSWS) para funciones de usuario

John Houser [email protected]

Objetivos de diseño

• Validar todas las entradas a funciones públicas.
• Produzca mensajes de error limpios y claros
• Evite o reemplace los mensajes de error de SirsiDynix (que a veces son oscuros) tanto como sea posible.
• Proporciona funciones sencillas y de alto nivel para crear, modificar, buscar y autenticar usuarios.
• Proporcionar ejemplos de código para todas las funciones.
• Admite una reconfiguración sencilla sin cambios de código para reflejar los cambios en la configuración de Symphony
• Admitir registros de usuarios o actualizaciones de cualquier campo de usuario válido de Symphony sin cambios de código
• Permitir una fácil adaptación por parte de otras bibliotecas.

Funciones Públicas

nivel bajo

Estas funciones se pueden utilizar con cualquier punto de acceso ILSWS válido. Lanzarán excepciones en caso de error.

• conectar ()
• send_get($url, $token, $params)
• enviar_query($url, $token, $query_json, $query_type)

Funciones de conveniencia

Estas funciones se corresponden con los puntos de acceso ILSWS, pero validan todas las entradas y generarán excepciones si se presentan entradas inapropiadas.

• autenticar_patron($token, $patron_id, $contraseña)
• change_barcode($token, $patron_key, $patron_id, $opciones)
  La matriz de opciones puede incluir: rol, client_id
• change_item_library($token, $item_key, $biblioteca)
• change_patron_password($token, $json, $opciones)
  La matriz de opciones puede incluir: rol, client_id
• eliminar_patron($token, $patron_key)
• describe_bib($token)
• describe_item($token)
• describe_patron($token)
• get_expiration($días)
• get_policy($token, $policy_key)
• search_patron($token, $índice, $búsqueda, $parámetros)
• search_patron_alt_id($token, $alt_id, $cuenta)
• search_patron_id($token, $patron_id, $recuento)
• transit_item($token, $item_key, $new_library, $working_library)
• untransit_item($token, $item_id)
• update_patron_activity($token, $patron_id)

De alto nivel

Estas funciones ofrecen funcionalidades que ILSWS no admite directamente al realizar múltiples consultas o al combinar, manipular o evaluar datos del sistema Symphony.

• autenticar_patron_id($token, $patron_id, $contraseña)
• check_duplicate($token, $índice1, $búsqueda1, $índice2, $búsqueda2)
• plantilla_correo electrónico($patrón, $a, $de, $asunto, $plantilla)
• get_bib($token, $bib_key, $lista_campo)
• 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, $clave_biblioteca)
• get_patron_attributes($token, $patron_key)
• get_patron_checkouts($token, $patron_key, $include_fields)
• get_patron_indexes($token)
• prepare_search($términos)
• registrar_patron($patrón, $token, $addr_num, $opciones)
  La matriz de opciones puede incluir: rol, client_id, plantilla, asunto
• reset_patron_password($token, $patron_id, $url, $correo electrónico)
  Opcional: correo electrónico
• search_authenticate($token, $índice, $búsqueda, $contraseña)
• search_bib($token, $índice, $valor, $parámetros)
  La matriz de parámetros puede incluir: q, ct, rw, j, includeFields
• update_patron($patrón, $token, $patron_key, $addr_num)
• update_patron_activeid($token, $patron_key, $patron_id, $opción)
  La opción puede ser: a, i, d
• update_phone_list($lista_teléfonos, $token, $patron_key, $opciones)
  La matriz de opciones puede incluir: rol, client_id

Formatos de fecha y número de teléfono

Para comodidad de los desarrolladores, la biblioteca de códigos acepta fechas en los siguientes formatos, siempre que se acepte una fecha como parámetro: AAAAMMDD, AAAA-MM-DD, AAAA/MM/DD, MM-DD-AAAA o MM/DD/. AAAA.

Actualmente, las reglas de validación para números de teléfono están configuradas para esperar una cadena de dígitos sin puntuación. Sin embargo, sería fácil modificar las reglas de validación en la parte superior de cualquier función pública para aceptar la puntuación en los números de teléfono.

Ejemplos

Inicializar y conectarse a 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();

Buscar un patrón

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

Obtener atributos de usuario

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

Registrar nuevo usuario

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

Actualizar registro de usuario

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

Búsqueda de registros bibliográficos

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

Notas sobre el parámetro includeFields:

• Para incluir datos MARC por etiqueta, agregue un artículo dorsal. Por ejemplo, para obtener la etiqueta 650, subcampo a, agregue: bib{650_a}
• Para obtener un número de clasificación o cualquier elemento del registro de elementos, debe incluir un elemento de lista de llamadas. Por ejemplo, agregue callList{callNumber}
• Para obtener cualquier campo del registro de artículo, debe incluir una entrada itemList dentro del elemento callList. Por ejemplo, para obtener un código de barras, agregue callList{itemList{barcode}}

Más información

Consulte el archivo libilsws .yaml.sample para obtener definiciones de campos y documentación de las opciones de configuración de YAML.

Para obtener un conjunto completo de ejemplos de código, consulte los scripts de ejemplo en el directorio test .

Advertencia: los scripts de prueba pueden realizar cambios reales en el sistema Symphony configurado. ¡No lo use en un sistema de producción sin revisar cuidadosamente lo que hacen!