libilsws

libilsws

Pacote PHP para suportar o uso da API SirsiDynix Symphony Web Services (ILSWS) para funções de usuário

John Houser [email protected]

Metas de projeto

• Valide todas as entradas para funções públicas
• Produza mensagens de erro limpas e claras
• Evite ou substitua mensagens de erro SirsiDynix (que às vezes são obscuras) tanto quanto possível
• Fornece funções fáceis e de alto nível para criar, modificar, pesquisar e autenticar usuários
• Forneça exemplos de código para todas as funções
• Suporta reconfiguração fácil sem alterações de código para espelhar alterações na configuração do Symphony
• Suporte a registros de usuários ou atualizações de qualquer campo de usuário válido do Symphony sem alterações de código
• Permitir fácil adaptação por outras bibliotecas

Funções Públicas

Baixo nível

Estas funções podem ser usadas com qualquer ponto de acesso ILSWS válido. Eles lançarão exceções em caso de erro.

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

Funções de conveniência

Essas funções correspondem aos pontos de acesso ILSWS, mas validam todas as entradas e lançarão exceções se forem apresentadas entradas inadequadas.

• authenticate_patron($token, $patron_id, $senha)
• change_barcode($token, $patron_key, $patron_id, $opções)
  A matriz de opções pode incluir: role, client_id
• change_item_library($token, $item_key, $library)
• change_patron_password($token, $json, $opções)
  A matriz de opções pode incluir: role, client_id
• delete_patron($token, $patron_key)
• descreva_bib($token)
• descrever_item($token)
• descreva_patron($token)
• get_expiration($dias)
• get_policy($token, $policy_key)
• search_patron($token, $index, $search, $params)
• search_patron_alt_id($token, $alt_id, $contagem)
• 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)

De alto nível

Essas funções oferecem funcionalidades não suportadas diretamente pelo ILSWS, realizando múltiplas consultas ou combinando, manipulando ou avaliando dados do sistema Symphony.

• authenticate_patron_id($token, $patron_id, $senha)
• check_duplicate($token, $index1, $search1, $index2, $search2)
• email_template($patrono, $para, $de, $assunto, $modelo)
• 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($termos)
• registrador_patron($patrono, $token, $addr_num, $opções)
  A matriz de opções pode incluir: função, client_id, modelo, assunto
• reset_patron_password($token, $patron_id, $url, $email)
  Opcional: e-mail
• search_authenticate($token, $index, $search, $password)
• search_bib($token, $index, $value, $params)
  A matriz de parâmetros pode incluir: q, ct, rw, j, includeFields
• update_patron($patrono, $token, $patron_key, $addr_num)
• update_patron_activeid($token, $patron_key, $patron_id, $opção)
  A opção pode ser: a, i, d
• update_phone_list($phone_list, $token, $patron_key, $opções)
  A matriz de opções pode incluir: role, client_id

Formatos de data e número de telefone

Para conveniência dos desenvolvedores, a biblioteca de código aceita datas nos seguintes formatos, sempre que uma data for aceita como parâmetro: AAAAMMDD, AAAA-MM-DD, AAAA/MM/DD, MM-DD-AAAA ou MM/DD/ AAAA.

As regras de validação para números de telefone estão atualmente definidas para esperar uma sequência de dígitos sem pontuação. Contudo, seria fácil modificar as regras de validação no topo de qualquer função pública para aceitar pontuação em números de telefone.

Exemplos

Inicialize e conecte-se ao 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();

Procure um patrono

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

Obtenha atributos de patrono

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

Cadastrar novo patrono

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

Atualizar registro de usuário

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

Pesquisa 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 o parâmetro includeFields:

• Para incluir dados MARC por tag, adicione um item de babador. Por exemplo, para obter a tag 650, subcampo a, adicione: bib{650_a}
• Para obter um número de telefone ou qualquer item do registro do item, você deve incluir um item callList. Por exemplo, adicione callList{callNumber}
• Para obter qualquer campo do registro do item, você deve incluir uma entrada itemList no item callList. Por exemplo, para obter um código de barras, adicione callList{itemList{barcode}}

Mais informações

Consulte o arquivo libilsws .yaml.sample para obter definições de campo e documentação das opções de configuração YAML.

Para obter um conjunto completo de exemplos de código, consulte os scripts de exemplo no diretório test .

Aviso: os scripts de teste podem fazer alterações reais no sistema Symphony configurado. Não use em um sistema de produção sem revisar cuidadosamente o que eles fazem!