mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
102 lines
3.5 KiB
XML
102 lines
3.5 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- 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 and Z-association to a Z39.50 target.
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</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 positive ID on success; zero on
|
|
failure.
|
|
</para>
|
|
<para>
|
|
<function>yaz_connect</function> prepares for a connection to a
|
|
Z39.50 target. The zurl argument takes the form
|
|
host[:port][/database]. If port is omitted 210 is used. If
|
|
database is omitted Default is used. This function is
|
|
non-blocking and doesn't attempt to establish a socket - 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 targets doesn't support piggyback or they ignore
|
|
element set names. For those, piggyback should be disabled.
|
|
</simpara></listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</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
|
|
-->
|