php-doc-en/reference/yaz/functions/yaz-connect.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 -->
  <refentry id="function.yaz-connect">
   <refnamediv>
    <refname>yaz_connect</refname>
    <refpurpose>
     Prepares for a connection to a Z39.50 server
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>yaz_connect</methodname>
      <methodparam><type>string</type><parameter>zurl</parameter></methodparam>
      <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function returns a connection resource on success, zero on
     failure.
    </para>
    <para>
     <function>yaz_connect</function> prepares for a connection to a
     Z39.50 server. The <parameter>zurl</parameter> argument takes the form
     host[:port][/database]. If port is omitted, port 210 is used. If
     database is omitted <literal>Default</literal> is used.
     This function is non-blocking and does not attempt to establish
     a connection  - it merely prepares a connect to be performed later when
     <function>yaz_wait</function> is called.
    </para>
    <para>
     If the second argument, <parameter>options</parameter>, is given as
     a string it is treated as the Z39.50 V2 authentication string
     (OpenAuth).
    </para>
    <para>
     If <parameter>options</parameter> is given as an array the contents
     of the array serves as options. Note that array options are only
     supported for PHP 4.1.0 and later.

    <variablelist>
     <title><function>yaz_connect</function> options</title>
     <varlistentry>
      <term>user</term>
      <listitem>
       <simpara>Username for authentication.</simpara>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>group</term>
      <listitem>
      <simpara>Group for authentication.</simpara>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>password</term>
       <listitem>
        <simpara>Password for authentication.</simpara>
       </listitem>
     </varlistentry>
     <varlistentry>
      <term>cookie</term>
      <listitem>
       <simpara>Cookie for session (YAZ proxy).</simpara>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>proxy</term>
      <listitem>
       <simpara>Proxy for connection (YAZ proxy).</simpara>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>persistent</term>
      <listitem>
       <simpara>A boolean. If &true; the connection is persistent; If &false;
        the connection is not persistent. By default connections are persistent.
       </simpara>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term>piggyback</term>
      <listitem>
       <simpara>A boolean. If &true; piggyback is enabled for searches; If
        &false; piggyback is disabled. By default piggyback is enabled. Enabling
        piggyback is more efficient and usually saves a network-round-trip for
        first time fetches of records. However, a few Z39.50 servers do not
        support piggyback or they ignore element set names. For those, piggyback
        should be disabled.
       </simpara>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>charset</term>
      <listitem>
       <simpara>A string that specifies character set to be used
        in Z39.50 language and character set negotiation.
        Use strings such as:
        <literal>ISO-8859-1</literal>, <literal>UTF-8</literal>, 
        <literal>UTF-16</literal>.
       </simpara>
       <simpara>
        Most Z39.50 servers do not support this feature (and thus, 
        this is ignored). Many servers use the ISO-8859-1
        encoding for queries and messages. MARC21/USMARC records are not
        affected by this setting.
       </simpara>
      </listitem>
     </varlistentry>

    </variablelist>
    </para>
    <para>
     <note>
      <para>
       The <ulink url="&url.yaz-proxy;">YAZ proxy</ulink> is a
       freely available Z39.50 proxy.
      </para>
     </note>
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->