cvs: phpdoc /en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml yaz-ccl-parse.xml yaz-close.xml yaz-connect.xml yaz-database.xml
yaz-element.xml yaz-errno.xml yaz-error.xml yaz-es-result.xml yaz-get-option.xml yaz-hits.xml yaz-itemorder.xml yaz-present.xml yaz-range.xml
yaz-scan-result.xml yaz-schema.xml yaz-sort.xml yaz-syntax.xml
| From: | Mehdi Achour | Date: | Tue, 05 Apr 2005 16:18:40 +0000 |
| Subject: | cvs: phpdoc /en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml yaz-ccl-parse.xml yaz-close.xml yaz-connect.xml yaz-database.xml yaz-element.xml yaz-errno.xml yaz-error.xml yaz-es-result.xml yaz-get-option.xml yaz-hits.xml yaz-itemorder.xml yaz-present.xml yaz-range.xml yaz-scan-result.xml yaz-schema.xml yaz-sort.xml yaz-syntax.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969367506@lists.php.net to get a copy of this message | ||
didou Tue Apr 5 12:18:40 2005 EDT
Modified files:
/phpdoc/en/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml
yaz-ccl-parse.xml yaz-close.xml
yaz-connect.xml yaz-database.xml
yaz-element.xml yaz-errno.xml
yaz-error.xml yaz-es-result.xml
yaz-get-option.xml yaz-hits.xml
yaz-itemorder.xml
yaz-present.xml yaz-range.xml
yaz-scan-result.xml
yaz-schema.xml yaz-sort.xml
yaz-syntax.xml
Log:
Switch ref.yaz to the new style
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-addinfo.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-addinfo.xml diff -u phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.7 phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.8 --- phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.7 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-addinfo.xml Tue Apr 5 12:18:39 2005 @@ -1,24 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.yaz-addinfo"> <refnamediv> <refname>yaz_addinfo</refname> <refpurpose>Returns additional error information</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>yaz_addinfo</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns additional error message for server (last request), identified by - parameter <parameter>id</parameter>. An empty string is returned if the + Returns additional error information for the last request on the server. + </para> + <para> + With some servers, this function may return the same string as + <function>yaz_error</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A string containing additional error information or an empty string if the last operation was successful or if no additional information was provided by the server. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>yaz_error</function>. + <simplelist> + <member><function>yaz_error</function></member> + <member><function>yaz_errno</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.8 phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.9 --- phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.8 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml Tue Apr 5 12:18:39 2005 @@ -1,50 +1,96 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.yaz-ccl-conf"> <refnamediv> <refname>yaz_ccl_conf</refname> <refpurpose>Configure CCL parser</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_ccl_conf</methodname> + <void/><methodname>yaz_ccl_conf</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>config</parameter></methodparam> </methodsynopsis> <para> - This function configures the CCL query parser for a server - with definitions of access points (CCL qualifiers) and their - mapping to RPN. To map a specific CCL query to RPN afterwards - call the <function>yaz_ccl_parse</function> function. - Each index of the array <parameter>config</parameter> is the - name of a CCL field and the corresponding value holds a string - that specifies a mapping to RPN. - The mapping is a sequence of attribute-type, attribute-value - pairs. Attribute-type and attribute-value is separated by an equal - sign (<literal>=</literal>). Each pair is separated by white space. + This function configures the CCL query parser for a server with + definitions of access points (CCL qualifiers) and their mapping to RPN. </para> <para> + To map a specific CCL query to RPN afterwards call the + <function>yaz_ccl_parse</function> function. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem> + <para> + An array of configuration. Each key of the array is the name of a CCL + field and the corresponding value holds a string that specifies a + mapping to RPN. + </para> + <para> + The mapping is a sequence of attribute-type, attribute-value pairs. + Attribute-type and attribute-value is separated by an equal sign + (<literal>=</literal>). Each pair is separated by white space. + </para> + <para> + Additional information can be found on the <ulink + url="&url.yaz-ccl;">CCL</ulink> page. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + In the example below, the CCL parser is configured to support three CCL + fields: <literal>ti</literal>, <literal>au</literal> and + <literal>isbn</literal>. Each field is mapped to their BIB-1 equivalent. + It is assumed that variable <literal>$id</literal> is the connection ID. + </para> <example> - <title>CCL configuration</title> - <simpara> - In the example below, the CCL parser is configured to support - three CCL fields: <literal>ti</literal>, <literal>au</literal> and - <literal>isbn</literal>. Each field is mapped to their BIB-1 - equivalent. It is assumed that variable <literal>$id</literal> is the - connection ID. - </simpara> - <programlisting role="php"> + <title>CCL configuration</title> + <programlisting role="php"> <![CDATA[ <?php -$fields["ti"] = "1=4"; -$fields["au"] = "1=1"; -$fields["isbn"] = "1=7"; +$fields = array( + "ti" => "1=4", + "au" => "1=1", + "isbn" => "1=7" +); yaz_ccl_conf($id, $fields); ?> ]]> - </programlisting> + </programlisting> </example> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_ccl_parse</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml?r1=1.10&r2=1.11&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.10 phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.11 --- phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.10 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.yaz-ccl-parse"> <refnamediv> <refname>yaz_ccl_parse</refname> <refpurpose>Invoke CCL Parser</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_ccl_parse</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -14,31 +14,87 @@ <methodparam><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> - This function invokes a CCL parser. It converts a given - CCL FIND query to an RPN query which may be passed to the - <function>yaz_search</function> function to perform a search. - To define a set of valid CCL fields call - <function>yaz_ccl_conf</function> prior to this function. - If the supplied <parameter>query</parameter> was successfully - converted to RPN, this function returns &true;, and the index - <literal>rpn</literal> of the supplied array - <parameter>result</parameter> holds a valid RPN query. - If the query could not be converted (because of invalid syntax, - unknown field, etc.) this function returns &false; and three - indexes are set in the resulting array to indicate the cause - of failure: <literal>errorcode</literal> CCL error code (integer), - <literal>errorstring</literal> CCL error string, and - <literal>errorpos</literal> approximate position in query of failure - (integer is character position). + This function invokes a CCL parser. It converts a given CCL FIND query to + an RPN query which may be passed to the <function>yaz_search</function> + function to perform a search. </para> + <para> + To define a set of valid CCL fields call <function>yaz_ccl_conf</function> + prior to this function. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + If the function was executed successfully, this will be an array + containing the valid RPN query under the key <literal>rpn</literal>. + </para> + <para> + Upon failure, three indexes are set in this array to indicate the cause + of failure: + <itemizedlist> + <listitem> + <para> + <literal>errorcode</literal> - the CCL error code (integer) + </para> + </listitem> + <listitem> + <para> + <literal>errorstring</literal> - the CCL error string + </para> + </listitem> + <listitem> + <para> + <literal>errorpos</literal> - approximate position in query of failure + (integer is character position) + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <example> <title>CCL Parsing</title> - <para>We will try to search using CCL. In the example below, + <para> + We will try to search using CCL. In the example below, <literal>$ccl</literal> is a CCL query. </para> <programlisting role="php"> <![CDATA[ <?php + yaz_ccl_conf($id, $fields); // see example for yaz_ccl_conf if (!yaz_ccl_parse($id, $ccl, &$cclresult)) { echo 'Error: ' . $cclresult["errorstring"]; http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-close.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-close.xml diff -u phpdoc/en/reference/yaz/functions/yaz-close.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-close.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-close.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-close.xml Tue Apr 5 12:18:39 2005 @@ -1,23 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-close"> <refnamediv> <refname>yaz_close</refname> <refpurpose>Close YAZ connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_close</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> Closes the connection given by parameter <parameter>id</parameter>. - The <parameter>id</parameter> is a connection resource as returned - by a previous call to <function>yaz_connect</function>. </para> + <note> + <para> + This function will only close a non-persistent connection opened by + setting the <literal>persistent</literal> option to &false; with + <function>yaz_connect</function>. + </para> + </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - &return.success; + <simplelist> + <member><function>yaz_connect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-connect.xml?r1=1.10&r2=1.11&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-connect.xml diff -u phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.10 phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.11 --- phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.10 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-connect.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.yaz-connect"> <refnamediv> <refname>yaz_connect</refname> @@ -7,8 +7,8 @@ Prepares for a connection to a Z39.50 server </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>yaz_connect</methodname> <methodparam><type>string</type><parameter>zurl</parameter></methodparam> @@ -20,97 +20,12 @@ </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. + Z39.50 server. 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 @@ -119,6 +34,160 @@ </note> </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zurl</parameter></term> + <listitem> + <para> + A string that takes the form <literal>host[:port][/database]</literal>. + If port is omitted, port 210 is used. If database is omitted + <literal>Default</literal> is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + If given as a string, it is treated as the Z39.50 V2 authentication + string (OpenAuth). + </para> + <para> + If given as an array, the contents of the array serves as options. + <variablelist> + <varlistentry> + <term>user</term> + <listitem> + <para> + Username for authentication. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>group</term> + <listitem> + <para> + Group for authentication. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>password</term> + <listitem> + <para> + Password for authentication. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cookie</term> + <listitem> + <para> + Cookie for session (YAZ proxy). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>proxy</term> + <listitem> + <para> + Proxy for connection (YAZ proxy). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>persistent</term> + <listitem> + <para> + A boolean. If &true; the connection is persistent; If &false; the + connection is not persistent. By default connections are persistent. + </para> + <note> + <para> + If you open a persistent connection, you won't be able to close + it later with <function>yaz_close</function>. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term>piggyback</term> + <listitem> + <para> + A boolean. If &true; piggyback is enabled for searches; If &false; + piggyback is disabled. By default piggyback is enabled. + </para> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>charset</term> + <listitem> + <para> + 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>. + </para> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A connection resource on success, &false; on error. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.1.0</entry> + <entry> + The parameter <parameter>options</parameter> was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_close</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-database.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-database.xml diff -u phpdoc/en/reference/yaz/functions/yaz-database.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-database.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-database.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-database.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-database"> <refnamediv> <refname>yaz_database</refname> @@ -7,22 +7,46 @@ Specifies the databases within a session </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_database</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>databases</parameter></methodparam> </methodsynopsis> <para> - This function specifies one or more databases to be used in search, - retrieval, etc. - overriding databases specified in call to - <function>yaz_connect</function>. Multiple databases are - separated by a plus sign <literal>+</literal>. + This function allows you to change databases within a session by + specifying one or more databases to be used in search, retrieval, etc. + - overriding databases specified in call to + <function>yaz_connect</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function allows you to change databases within a session. + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>databases</parameter></term> + <listitem> + <para> + A string containing one or more databases. Multiple databases are + separated by a plus sign <literal>+</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-element.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-element.xml diff -u phpdoc/en/reference/yaz/functions/yaz-element.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-element.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-element.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-element.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-element"> <refnamediv> <refname>yaz_element</refname> @@ -7,8 +7,8 @@ Specifies Element-Set Name for retrieval </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_element</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -16,12 +16,46 @@ </methodsynopsis> <para> This function sets the element set name for retrieval. + </para> + <para> Call this function before <function>yaz_search</function> or - <function>yaz_present</function> - to specify the element set name for records to be retrieved. - Most servers support <literal>F</literal> (for full records) and - <literal>B</literal> (for brief records). + <function>yaz_present</function> to specify the element set name for + records to be retrieved. + </para> + <note> + <para> + If this function seems effectless, see the description of the + <literal>piggybacking</literal> option in + <function>yaz_connect</function>. + </para> + </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>elementset</parameter></term> + <listitem> + <para> + Most servers support <literal>F</literal> (for full records) and + <literal>B</literal> (for brief records). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-errno.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-errno.xml diff -u phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-errno.xml Tue Apr 5 12:18:39 2005 @@ -1,28 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-errno"> <refnamediv> <refname>yaz_errno</refname> <refpurpose>Returns error number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>yaz_errno</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns an errornumber for the server (last request) identified by - <parameter>id</parameter>. The error code is either a Z39.50 diagnostic - code (usually a Bib-1 diagnostic) or a client side error code which is - generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc. + Returns an error number for the server (last request) identified by + <parameter>id</parameter>. </para> <para> - <function>yaz_errno</function> should be called after network - activity for each server - (after <function>yaz_wait</function> - returns) to determine the success or failure of the last - operation (e.g. search). To get a text description of the - error, call <function>yaz_error</function>. + <function>yaz_errno</function> should be called after network activity for + each server - (after <function>yaz_wait</function> returns) to determine the + success or failure of the last operation (e.g. search). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an error code. The error code is either a Z39.50 diagnostic code + (usually a Bib-1 diagnostic) or a client side error code which is + generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", + etc. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_error</function></member> + <member><function>yaz_addinfo</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-error.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-error.xml diff -u phpdoc/en/reference/yaz/functions/yaz-error.xml:1.7 phpdoc/en/reference/yaz/functions/yaz-error.xml:1.8 --- phpdoc/en/reference/yaz/functions/yaz-error.xml:1.7 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-error.xml Tue Apr 5 12:18:39 2005 @@ -1,25 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.yaz-error"> <refnamediv> <refname>yaz_error</refname> <refpurpose>Returns error description</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>yaz_error</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> + <function>yaz_error</function> returns an English text message + corresponding to the last error number as returned by + <function>yaz_errno</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an error text message for server (last request), identified by parameter <parameter>id</parameter>. An empty string is returned if the last operation was successful. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - <function>yaz_error</function> returns an English text message - corresponding to the last error number as returned by - <function>yaz_errno</function>. + <simplelist> + <member><function>yaz_errno</function></member> + <member><function>yaz_addinfo</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-es-result.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-es-result.xml diff -u phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.3 --- phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.2 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-es-result.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.yaz-es-result"> <refnamediv> <refname>yaz_es_result</refname> @@ -7,8 +7,8 @@ Inspects Extended Services Result </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>yaz_es_result</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -17,6 +17,21 @@ &warn.undocumented.func; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-get-option.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-get-option.xml diff -u phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.3 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-get-option.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.yaz-get-option"> <refnamediv> <refname>yaz_get_option</refname> <refpurpose>Returns value of option for connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>yaz_get_option</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -14,11 +14,47 @@ </methodsynopsis> <para> Returns the value of the option specified with <parameter>name</parameter>. - If an option is not set, an empty string is returned. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + The option name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the value of the specified option or an empty string if the option + wasn't set. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See the description of <function>yaz_set_option</function> for - available options. + <simplelist> + <member> + The description of <function>yaz_set_option</function> for available + options + </member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-hits.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-hits.xml diff -u phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-hits.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-hits"> <refnamediv> <refname>yaz_hits</refname> <refpurpose>Returns number of hits for last search</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>yaz_hits</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -16,6 +16,28 @@ search. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of hits for the last search or 0 if no search was + performed. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-itemorder.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-itemorder.xml diff -u phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-itemorder.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-itemorder"> <refnamediv> <refname>yaz_itemorder</refname> @@ -7,30 +7,45 @@ Prepares for Z39.50 Item Order with an ILL-Request package </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_itemorder</methodname> + <void/><methodname>yaz_itemorder</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>args</parameter></methodparam> </methodsynopsis> <para> This function prepares for an Extended Services request using the Profile for the Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1). See - <ulink url="&url.yaz.ill;">this</ulink> - and the - <ulink url="&url.yaz.specs;"> - specification</ulink>. - The <parameter>args</parameter> parameter must be a hash array with - information about the Item Order request to be sent. The key of the hash is - the name of the corresponding ASN.1 tag path. For example, the ISBN below - the Item-ID has the key item-id,ISBN. + Transport ILL (Profile/1). See <ulink url="&url.yaz.ill;">this</ulink> + and the <ulink url="&url.yaz.specs;">specification</ulink>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The ILL-Request parameters are: - </para> - <literallayout> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>args</parameter></term> + <listitem> + <para> + Must be an associative array with information about the Item Order + request to be sent. The key of the hash is the name of the + corresponding ASN.1 tag path. For example, the ISBN below the Item-ID + has the key item-id,ISBN. + </para> + <para> + The ILL-Request parameters are: + </para> + <literallayout> protocol-version-num transaction-id,initial-requester-id,person-or-institution-symbol,person transaction-id,initial-requester-id,person-or-institution-symbol,institution @@ -112,19 +127,29 @@ forward-flag requester-note forward-note - </literallayout> - <para> - There are also a few parameters that are part of the Extended - Services Request package and the ItemOrder package: - </para> - <literallayout> + </literallayout> + <para> + There are also a few parameters that are part of the Extended + Services Request package and the ItemOrder package: + </para> + <literallayout> package-name user-id contact-name contact-phone contact-email itemorder-item - </literallayout> + </literallayout> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-present.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-present.xml diff -u phpdoc/en/reference/yaz/functions/yaz-present.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-present.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-present.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-present.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-present"> <refnamediv> <refname>yaz_present</refname> @@ -7,19 +7,38 @@ Prepares for retrieval (Z39.50 present) </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_present</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - This function prepares for retrieval of records after - a successful search. The <function>yaz_range</function> should - be called prior to this function to specify the range of - records to be retrieved. + This function prepares for retrieval of records after a successful search. </para> <para> + The <function>yaz_range</function> function should be called prior to this + function to specify the range of records to be retrieved. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-range.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-range.xml diff -u phpdoc/en/reference/yaz/functions/yaz-range.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-range.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-range.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-range.xml Tue Apr 5 12:18:39 2005 @@ -1,31 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-range"> <refnamediv> <refname>yaz_range</refname> <refpurpose> - Specifies the maximum number of records to retrieve + Specifies a range of records to retrieve </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>yaz_range</methodname> + <void/><methodname>yaz_range</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>start</parameter></methodparam> <methodparam><type>int</type><parameter>number</parameter></methodparam> </methodsynopsis> <para> - This function should be called before either - <function>yaz_search</function> or <function>yaz_present</function> - to specify a range of records to be retrieved. - The parameter <parameter>start</parameter> specifies the position of the - first record to be retrieved and parameter <parameter>number</parameter> is - the number of records. Records in a result set are numbered 1, 2, ... $hits - where $hits is the count returned by <function>yaz_hits</function>. + Specifies a range of records to retrieve. </para> <para> - &return.success; + This function should be called before <function>yaz_search</function> or + <function>yaz_present</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + Specifies the position of the first record to be retrieved. The + records numbers goes from 1 to <function>yaz_hits</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>number</parameter></term> + <listitem> + <para> + Specifies the number of records to be retrieved. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-scan-result.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-scan-result.xml diff -u phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.8 phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.9 --- phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.8 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-scan-result.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.yaz-scan-result"> <refnamediv> <refname>yaz_scan_result</refname> <refpurpose>Returns Scan Response result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>yaz_scan_result</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -16,15 +16,60 @@ <function>yaz_scan_result</function> returns terms and associated information as received from the server in the last performed <function>yaz_scan</function>. - This function returns an array (0..n-1) where n is the number - of terms returned. Each value is a pair where the first item is the - term, and the second item is the result-count. - If the optional parameter <parameter>result</parameter> is given it will be - modified to hold additional information taken from the Scan Response: - <literal>number</literal> (number of entries returned), - <literal>stepsize</literal> (Step-size), - <literal>position</literal> (position of term), - <literal>status</literal> (Scan Status). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + If given, this array will be modified to hold additional information + taken from the Scan Response: + <itemizedlist> + <listitem> + <para> + <literal>number</literal> - Number of entries returned + </para> + </listitem> + <listitem> + <para> + <literal>stepsize</literal> - Step size + </para> + </listitem> + <listitem> + <para> + <literal>position</literal> - Position of term + </para> + </listitem> + <listitem> + <para> + <literal>status</literal> - Scan status + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array (0..n-1) where n is the number of terms returned. Each + value is a pair where the first item is the term, and the second item is + the result-count. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-schema.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-schema.xml diff -u phpdoc/en/reference/yaz/functions/yaz-schema.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-schema.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-schema.xml:1.3 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-schema.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.yaz-schema"> <refnamediv> <refname>yaz_schema</refname> @@ -7,23 +7,53 @@ Specifies schema for retrieval </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_schema</methodname> + <void/><methodname>yaz_schema</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>schema</parameter></methodparam> </methodsynopsis> <para> - The schema must be specified as an OID (Object Identifier) in a - raw dot-notation (like <literal>1.2.840.10003.13.4</literal>) or - as one of the known registered schemas: - <literal>GILS-schema</literal>, <literal>Holdings</literal>, - <literal>Zthes</literal>, ... + <function>yaz_schema</function> specifies the schema for retrieval. + </para> + <para> This function should be called before <function>yaz_search</function> or <function>yaz_present</function>. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + Must be specified as an OID (Object Identifier) in a raw dot-notation + (like <literal>1.2.840.10003.13.4</literal>) or as one of the known + registered schemas: <literal>GILS-schema</literal>, + <literal>Holdings</literal>, <literal>Zthes</literal>, ... + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-sort.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-sort.xml diff -u phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-sort.xml Tue Apr 5 12:18:39 2005 @@ -1,69 +1,125 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-sort"> <refnamediv> <refname>yaz_sort</refname> <refpurpose>Sets sorting criteria</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_sort</methodname> + <void/><methodname>yaz_sort</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>criteria</parameter></methodparam> </methodsynopsis> <para> This function sets sorting criteria and enables Z39.50 Sort. - Call this function <emphasis>before</emphasis> - <function>yaz_search</function>. + </para> + <para> + Call this function <emphasis>before</emphasis> <function>yaz_search</function>. Using this function alone does not have any effect. When used in conjunction with <function>yaz_search</function>, a Z39.50 Sort will be sent after a search response has been received and before any records are retrieved with - Z39.50 Present (<function>yaz_present</function>. The parameter - <parameter>criteria</parameter> takes the form - </para> - <para> - <replaceable>field1 flags1 field2 flags2</replaceable> ... + Z39.50 Present (<function>yaz_present</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - where field1 specifies the primary attributes for sort, field2 seconds, - etc.. The field specifies either a numerical attribute combinations consisting - of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>) - ; or the field may specify a plain string criteria - (e.g. <literal>title</literal>. The flags is a sequence of the following - characters which may not be separated by any white space. - </para> - <variablelist> - <title>Sort Flags</title> - <varlistentry><term><literal>a</literal></term><listitem> - <simpara>Sort ascending</simpara></listitem> - </varlistentry> - <varlistentry><term><literal>d</literal></term><listitem> - <simpara>Sort descending</simpara></listitem> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> </varlistentry> - <varlistentry><term><literal>i</literal></term><listitem> - <simpara>Case insensitive sorting</simpara></listitem> + <varlistentry> + <term><parameter>criteria</parameter></term> + <listitem> + <para> + A string that takes the form <replaceable>field1 flags1 field2 + flags2</replaceable> where field1 specifies the primary attributes for + sort, field2 seconds, etc.. + </para> + <para> + The field specifies either a numerical attribute combinations consisting + of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>) + ; or the field may specify a plain string criteria (e.g. + <literal>title</literal>. The flags is a sequence of the following + characters which may not be separated by any white space. + </para> + <para> + <variablelist> + <title>Sort Flags</title> + <varlistentry> + <term><literal>a</literal></term> + <listitem> + <para> + Sort ascending + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>d</literal></term> + <listitem> + <para> + Sort descending + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>i</literal></term> + <listitem> + <para> + Case insensitive sorting + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>s</literal></term> + <listitem> + <para> + Case sensitive sorting + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> </varlistentry> - <varlistentry><term><literal>s</literal></term><listitem> - <simpara>Case sensitive sorting</simpara></listitem> - </varlistentry> - </variablelist> - <example> - <title>Sort Criterias</title> - <para> - To sort on Bib1 attribute title, case insensitive, - and ascending you would use the following sort criteria: - <screen> - 1=4 ia - </screen> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If the secondary sorting criteria should be author, case sensitive - and ascending you would use: - <screen> - 1=4 ia 1=1003 sa - </screen> + &return.void; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <example> + <title>Sort Criterias</title> + <para> + To sort on Bib1 attribute title, case insensitive, and ascending you + would use the following sort criteria: + <screen> +<![CDATA[ +1=4 ia +]]> + </screen> + </para> + <para> + If the secondary sorting criteria should be author, case sensitive and + ascending you would use: + <screen> +<![CDATA[ +1=4 ia 1=1003 sa +]]> + </screen> + </para> </example> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-syntax.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-syntax.xml diff -u phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-syntax.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-syntax"> <refnamediv> <refname>yaz_syntax</refname> @@ -7,19 +7,51 @@ Specifies the preferred record syntax for retrieval </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_syntax</methodname> + <void/><methodname>yaz_syntax</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>syntax</parameter></methodparam> </methodsynopsis> <para> - The syntax must be specified as an OID (Object Identifier) in a - raw dot-notation (like <literal>1.2.840.10003.5.10</literal>) or - as one of the known registered record syntaxes (sutrs, usmarc, grs1, - xml, etc.). This function should be called before - <function>yaz_search</function> or <function>yaz_present</function>. + <function>yaz_syntax</function> specifies the preferred record syntax for + retrieval + </para> + <para> + This function should be called before <function>yaz_search</function> or + <function>yaz_present</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>syntax</parameter></term> + <listitem> + <para> + The syntax must be specified as an OID (Object Identifier) in a raw + dot-notation (like <literal>1.2.840.10003.5.10</literal>) or as one of + the known registered record syntaxes (sutrs, usmarc, grs1, xml, etc.). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-addinfo.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-addinfo.xml diff -u phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.7 phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.8 --- phpdoc/en/reference/yaz/functions/yaz-addinfo.xml:1.7 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-addinfo.xml Tue Apr 5 12:18:39 2005 @@ -1,24 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.yaz-addinfo"> <refnamediv> <refname>yaz_addinfo</refname> <refpurpose>Returns additional error information</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>yaz_addinfo</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns additional error message for server (last request), identified by - parameter <parameter>id</parameter>. An empty string is returned if the + Returns additional error information for the last request on the server. + </para> + <para> + With some servers, this function may return the same string as + <function>yaz_error</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A string containing additional error information or an empty string if the last operation was successful or if no additional information was provided by the server. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>yaz_error</function>. + <simplelist> + <member><function>yaz_error</function></member> + <member><function>yaz_errno</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.8 phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.9 --- phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml:1.8 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-conf.xml Tue Apr 5 12:18:39 2005 @@ -1,50 +1,96 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.yaz-ccl-conf"> <refnamediv> <refname>yaz_ccl_conf</refname> <refpurpose>Configure CCL parser</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_ccl_conf</methodname> + <void/><methodname>yaz_ccl_conf</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>config</parameter></methodparam> </methodsynopsis> <para> - This function configures the CCL query parser for a server - with definitions of access points (CCL qualifiers) and their - mapping to RPN. To map a specific CCL query to RPN afterwards - call the <function>yaz_ccl_parse</function> function. - Each index of the array <parameter>config</parameter> is the - name of a CCL field and the corresponding value holds a string - that specifies a mapping to RPN. - The mapping is a sequence of attribute-type, attribute-value - pairs. Attribute-type and attribute-value is separated by an equal - sign (<literal>=</literal>). Each pair is separated by white space. + This function configures the CCL query parser for a server with + definitions of access points (CCL qualifiers) and their mapping to RPN. </para> <para> + To map a specific CCL query to RPN afterwards call the + <function>yaz_ccl_parse</function> function. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>config</parameter></term> + <listitem> + <para> + An array of configuration. Each key of the array is the name of a CCL + field and the corresponding value holds a string that specifies a + mapping to RPN. + </para> + <para> + The mapping is a sequence of attribute-type, attribute-value pairs. + Attribute-type and attribute-value is separated by an equal sign + (<literal>=</literal>). Each pair is separated by white space. + </para> + <para> + Additional information can be found on the <ulink + url="&url.yaz-ccl;">CCL</ulink> page. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + In the example below, the CCL parser is configured to support three CCL + fields: <literal>ti</literal>, <literal>au</literal> and + <literal>isbn</literal>. Each field is mapped to their BIB-1 equivalent. + It is assumed that variable <literal>$id</literal> is the connection ID. + </para> <example> - <title>CCL configuration</title> - <simpara> - In the example below, the CCL parser is configured to support - three CCL fields: <literal>ti</literal>, <literal>au</literal> and - <literal>isbn</literal>. Each field is mapped to their BIB-1 - equivalent. It is assumed that variable <literal>$id</literal> is the - connection ID. - </simpara> - <programlisting role="php"> + <title>CCL configuration</title> + <programlisting role="php"> <![CDATA[ <?php -$fields["ti"] = "1=4"; -$fields["au"] = "1=1"; -$fields["isbn"] = "1=7"; +$fields = array( + "ti" => "1=4", + "au" => "1=1", + "isbn" => "1=7" +); yaz_ccl_conf($id, $fields); ?> ]]> - </programlisting> + </programlisting> </example> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_ccl_parse</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml?r1=1.10&r2=1.11&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml diff -u phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.10 phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.11 --- phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml:1.10 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-ccl-parse.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.yaz-ccl-parse"> <refnamediv> <refname>yaz_ccl_parse</refname> <refpurpose>Invoke CCL Parser</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_ccl_parse</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -14,31 +14,87 @@ <methodparam><type>array</type><parameter role="reference">result</parameter></methodparam> </methodsynopsis> <para> - This function invokes a CCL parser. It converts a given - CCL FIND query to an RPN query which may be passed to the - <function>yaz_search</function> function to perform a search. - To define a set of valid CCL fields call - <function>yaz_ccl_conf</function> prior to this function. - If the supplied <parameter>query</parameter> was successfully - converted to RPN, this function returns &true;, and the index - <literal>rpn</literal> of the supplied array - <parameter>result</parameter> holds a valid RPN query. - If the query could not be converted (because of invalid syntax, - unknown field, etc.) this function returns &false; and three - indexes are set in the resulting array to indicate the cause - of failure: <literal>errorcode</literal> CCL error code (integer), - <literal>errorstring</literal> CCL error string, and - <literal>errorpos</literal> approximate position in query of failure - (integer is character position). + This function invokes a CCL parser. It converts a given CCL FIND query to + an RPN query which may be passed to the <function>yaz_search</function> + function to perform a search. </para> + <para> + To define a set of valid CCL fields call <function>yaz_ccl_conf</function> + prior to this function. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>query</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + If the function was executed successfully, this will be an array + containing the valid RPN query under the key <literal>rpn</literal>. + </para> + <para> + Upon failure, three indexes are set in this array to indicate the cause + of failure: + <itemizedlist> + <listitem> + <para> + <literal>errorcode</literal> - the CCL error code (integer) + </para> + </listitem> + <listitem> + <para> + <literal>errorstring</literal> - the CCL error string + </para> + </listitem> + <listitem> + <para> + <literal>errorpos</literal> - approximate position in query of failure + (integer is character position) + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <example> <title>CCL Parsing</title> - <para>We will try to search using CCL. In the example below, + <para> + We will try to search using CCL. In the example below, <literal>$ccl</literal> is a CCL query. </para> <programlisting role="php"> <![CDATA[ <?php + yaz_ccl_conf($id, $fields); // see example for yaz_ccl_conf if (!yaz_ccl_parse($id, $ccl, &$cclresult)) { echo 'Error: ' . $cclresult["errorstring"]; http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-close.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-close.xml diff -u phpdoc/en/reference/yaz/functions/yaz-close.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-close.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-close.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-close.xml Tue Apr 5 12:18:39 2005 @@ -1,23 +1,54 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-close"> <refnamediv> <refname>yaz_close</refname> <refpurpose>Close YAZ connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_close</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> Closes the connection given by parameter <parameter>id</parameter>. - The <parameter>id</parameter> is a connection resource as returned - by a previous call to <function>yaz_connect</function>. </para> + <note> + <para> + This function will only close a non-persistent connection opened by + setting the <literal>persistent</literal> option to &false; with + <function>yaz_connect</function>. + </para> + </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - &return.success; + <simplelist> + <member><function>yaz_connect</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-connect.xml?r1=1.10&r2=1.11&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-connect.xml diff -u phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.10 phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.11 --- phpdoc/en/reference/yaz/functions/yaz-connect.xml:1.10 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-connect.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <refentry id="function.yaz-connect"> <refnamediv> <refname>yaz_connect</refname> @@ -7,8 +7,8 @@ Prepares for a connection to a Z39.50 server </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>yaz_connect</methodname> <methodparam><type>string</type><parameter>zurl</parameter></methodparam> @@ -20,97 +20,12 @@ </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. + Z39.50 server. 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 @@ -119,6 +34,160 @@ </note> </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>zurl</parameter></term> + <listitem> + <para> + A string that takes the form <literal>host[:port][/database]</literal>. + If port is omitted, port 210 is used. If database is omitted + <literal>Default</literal> is used. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>options</parameter></term> + <listitem> + <para> + If given as a string, it is treated as the Z39.50 V2 authentication + string (OpenAuth). + </para> + <para> + If given as an array, the contents of the array serves as options. + <variablelist> + <varlistentry> + <term>user</term> + <listitem> + <para> + Username for authentication. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>group</term> + <listitem> + <para> + Group for authentication. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>password</term> + <listitem> + <para> + Password for authentication. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>cookie</term> + <listitem> + <para> + Cookie for session (YAZ proxy). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>proxy</term> + <listitem> + <para> + Proxy for connection (YAZ proxy). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>persistent</term> + <listitem> + <para> + A boolean. If &true; the connection is persistent; If &false; the + connection is not persistent. By default connections are persistent. + </para> + <note> + <para> + If you open a persistent connection, you won't be able to close + it later with <function>yaz_close</function>. + </para> + </note> + </listitem> + </varlistentry> + <varlistentry> + <term>piggyback</term> + <listitem> + <para> + A boolean. If &true; piggyback is enabled for searches; If &false; + piggyback is disabled. By default piggyback is enabled. + </para> + <para> + 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. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>charset</term> + <listitem> + <para> + 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>. + </para> + <para> + 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. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + A connection resource on success, &false; on error. + </para> + </refsect1> + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.1.0</entry> + <entry> + The parameter <parameter>options</parameter> was added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_close</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-database.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-database.xml diff -u phpdoc/en/reference/yaz/functions/yaz-database.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-database.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-database.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-database.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-database"> <refnamediv> <refname>yaz_database</refname> @@ -7,22 +7,46 @@ Specifies the databases within a session </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_database</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>databases</parameter></methodparam> </methodsynopsis> <para> - This function specifies one or more databases to be used in search, - retrieval, etc. - overriding databases specified in call to - <function>yaz_connect</function>. Multiple databases are - separated by a plus sign <literal>+</literal>. + This function allows you to change databases within a session by + specifying one or more databases to be used in search, retrieval, etc. + - overriding databases specified in call to + <function>yaz_connect</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - This function allows you to change databases within a session. + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>databases</parameter></term> + <listitem> + <para> + A string containing one or more databases. Multiple databases are + separated by a plus sign <literal>+</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-element.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-element.xml diff -u phpdoc/en/reference/yaz/functions/yaz-element.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-element.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-element.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-element.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-element"> <refnamediv> <refname>yaz_element</refname> @@ -7,8 +7,8 @@ Specifies Element-Set Name for retrieval </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_element</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -16,12 +16,46 @@ </methodsynopsis> <para> This function sets the element set name for retrieval. + </para> + <para> Call this function before <function>yaz_search</function> or - <function>yaz_present</function> - to specify the element set name for records to be retrieved. - Most servers support <literal>F</literal> (for full records) and - <literal>B</literal> (for brief records). + <function>yaz_present</function> to specify the element set name for + records to be retrieved. + </para> + <note> + <para> + If this function seems effectless, see the description of the + <literal>piggybacking</literal> option in + <function>yaz_connect</function>. + </para> + </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>elementset</parameter></term> + <listitem> + <para> + Most servers support <literal>F</literal> (for full records) and + <literal>B</literal> (for brief records). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-errno.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-errno.xml diff -u phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-errno.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-errno.xml Tue Apr 5 12:18:39 2005 @@ -1,28 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-errno"> <refnamediv> <refname>yaz_errno</refname> <refpurpose>Returns error number</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>yaz_errno</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - Returns an errornumber for the server (last request) identified by - <parameter>id</parameter>. The error code is either a Z39.50 diagnostic - code (usually a Bib-1 diagnostic) or a client side error code which is - generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", etc. + Returns an error number for the server (last request) identified by + <parameter>id</parameter>. </para> <para> - <function>yaz_errno</function> should be called after network - activity for each server - (after <function>yaz_wait</function> - returns) to determine the success or failure of the last - operation (e.g. search). To get a text description of the - error, call <function>yaz_error</function>. + <function>yaz_errno</function> should be called after network activity for + each server - (after <function>yaz_wait</function> returns) to determine the + success or failure of the last operation (e.g. search). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an error code. The error code is either a Z39.50 diagnostic code + (usually a Bib-1 diagnostic) or a client side error code which is + generated by PHP/YAZ itself, such as "Connect failed", "Init Rejected", + etc. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_error</function></member> + <member><function>yaz_addinfo</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-error.xml?r1=1.7&r2=1.8&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-error.xml diff -u phpdoc/en/reference/yaz/functions/yaz-error.xml:1.7 phpdoc/en/reference/yaz/functions/yaz-error.xml:1.8 --- phpdoc/en/reference/yaz/functions/yaz-error.xml:1.7 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-error.xml Tue Apr 5 12:18:39 2005 @@ -1,25 +1,52 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.yaz-error"> <refnamediv> <refname>yaz_error</refname> <refpurpose>Returns error description</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>yaz_error</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> + <function>yaz_error</function> returns an English text message + corresponding to the last error number as returned by + <function>yaz_errno</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an error text message for server (last request), identified by parameter <parameter>id</parameter>. An empty string is returned if the last operation was successful. </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - <function>yaz_error</function> returns an English text message - corresponding to the last error number as returned by - <function>yaz_errno</function>. + <simplelist> + <member><function>yaz_errno</function></member> + <member><function>yaz_addinfo</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-es-result.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-es-result.xml diff -u phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.2 phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.3 --- phpdoc/en/reference/yaz/functions/yaz-es-result.xml:1.2 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-es-result.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.yaz-es-result"> <refnamediv> <refname>yaz_es_result</refname> @@ -7,8 +7,8 @@ Inspects Extended Services Result </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>yaz_es_result</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -17,6 +17,21 @@ &warn.undocumented.func; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-get-option.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-get-option.xml diff -u phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-get-option.xml:1.3 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-get-option.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.yaz-get-option"> <refnamediv> <refname>yaz_get_option</refname> <refpurpose>Returns value of option for connection</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>yaz_get_option</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -14,11 +14,47 @@ </methodsynopsis> <para> Returns the value of the option specified with <parameter>name</parameter>. - If an option is not set, an empty string is returned. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + The option name. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the value of the specified option or an empty string if the option + wasn't set. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See the description of <function>yaz_set_option</function> for - available options. + <simplelist> + <member> + The description of <function>yaz_set_option</function> for available + options + </member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-hits.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-hits.xml diff -u phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-hits.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-hits.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-hits"> <refnamediv> <refname>yaz_hits</refname> <refpurpose>Returns number of hits for last search</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>yaz_hits</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -16,6 +16,28 @@ search. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of hits for the last search or 0 if no search was + performed. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-itemorder.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-itemorder.xml diff -u phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-itemorder.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-itemorder.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-itemorder"> <refnamediv> <refname>yaz_itemorder</refname> @@ -7,30 +7,45 @@ Prepares for Z39.50 Item Order with an ILL-Request package </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_itemorder</methodname> + <void/><methodname>yaz_itemorder</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>args</parameter></methodparam> </methodsynopsis> <para> This function prepares for an Extended Services request using the Profile for the Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1). See - <ulink url="&url.yaz.ill;">this</ulink> - and the - <ulink url="&url.yaz.specs;"> - specification</ulink>. - The <parameter>args</parameter> parameter must be a hash array with - information about the Item Order request to be sent. The key of the hash is - the name of the corresponding ASN.1 tag path. For example, the ISBN below - the Item-ID has the key item-id,ISBN. + Transport ILL (Profile/1). See <ulink url="&url.yaz.ill;">this</ulink> + and the <ulink url="&url.yaz.specs;">specification</ulink>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The ILL-Request parameters are: - </para> - <literallayout> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>args</parameter></term> + <listitem> + <para> + Must be an associative array with information about the Item Order + request to be sent. The key of the hash is the name of the + corresponding ASN.1 tag path. For example, the ISBN below the Item-ID + has the key item-id,ISBN. + </para> + <para> + The ILL-Request parameters are: + </para> + <literallayout> protocol-version-num transaction-id,initial-requester-id,person-or-institution-symbol,person transaction-id,initial-requester-id,person-or-institution-symbol,institution @@ -112,19 +127,29 @@ forward-flag requester-note forward-note - </literallayout> - <para> - There are also a few parameters that are part of the Extended - Services Request package and the ItemOrder package: - </para> - <literallayout> + </literallayout> + <para> + There are also a few parameters that are part of the Extended + Services Request package and the ItemOrder package: + </para> + <literallayout> package-name user-id contact-name contact-phone contact-email itemorder-item - </literallayout> + </literallayout> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-present.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-present.xml diff -u phpdoc/en/reference/yaz/functions/yaz-present.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-present.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-present.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-present.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-present"> <refnamediv> <refname>yaz_present</refname> @@ -7,19 +7,38 @@ Prepares for retrieval (Z39.50 present) </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>yaz_present</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> - This function prepares for retrieval of records after - a successful search. The <function>yaz_range</function> should - be called prior to this function to specify the range of - records to be retrieved. + This function prepares for retrieval of records after a successful search. </para> <para> + The <function>yaz_range</function> function should be called prior to this + function to specify the range of records to be retrieved. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> &return.success; </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-range.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-range.xml diff -u phpdoc/en/reference/yaz/functions/yaz-range.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-range.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-range.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-range.xml Tue Apr 5 12:18:39 2005 @@ -1,31 +1,64 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-range"> <refnamediv> <refname>yaz_range</refname> <refpurpose> - Specifies the maximum number of records to retrieve + Specifies a range of records to retrieve </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>yaz_range</methodname> + <void/><methodname>yaz_range</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>start</parameter></methodparam> <methodparam><type>int</type><parameter>number</parameter></methodparam> </methodsynopsis> <para> - This function should be called before either - <function>yaz_search</function> or <function>yaz_present</function> - to specify a range of records to be retrieved. - The parameter <parameter>start</parameter> specifies the position of the - first record to be retrieved and parameter <parameter>number</parameter> is - the number of records. Records in a result set are numbered 1, 2, ... $hits - where $hits is the count returned by <function>yaz_hits</function>. + Specifies a range of records to retrieve. </para> <para> - &return.success; + This function should be called before <function>yaz_search</function> or + <function>yaz_present</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>start</parameter></term> + <listitem> + <para> + Specifies the position of the first record to be retrieved. The + records numbers goes from 1 to <function>yaz_hits</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>number</parameter></term> + <listitem> + <para> + Specifies the number of records to be retrieved. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-scan-result.xml?r1=1.8&r2=1.9&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-scan-result.xml diff -u phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.8 phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.9 --- phpdoc/en/reference/yaz/functions/yaz-scan-result.xml:1.8 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-scan-result.xml Tue Apr 5 12:18:39 2005 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.yaz-scan-result"> <refnamediv> <refname>yaz_scan_result</refname> <refpurpose>Returns Scan Response result</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>yaz_scan_result</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> @@ -16,15 +16,60 @@ <function>yaz_scan_result</function> returns terms and associated information as received from the server in the last performed <function>yaz_scan</function>. - This function returns an array (0..n-1) where n is the number - of terms returned. Each value is a pair where the first item is the - term, and the second item is the result-count. - If the optional parameter <parameter>result</parameter> is given it will be - modified to hold additional information taken from the Scan Response: - <literal>number</literal> (number of entries returned), - <literal>stepsize</literal> (Step-size), - <literal>position</literal> (position of term), - <literal>status</literal> (Scan Status). + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>result</parameter></term> + <listitem> + <para> + If given, this array will be modified to hold additional information + taken from the Scan Response: + <itemizedlist> + <listitem> + <para> + <literal>number</literal> - Number of entries returned + </para> + </listitem> + <listitem> + <para> + <literal>stepsize</literal> - Step size + </para> + </listitem> + <listitem> + <para> + <literal>position</literal> - Position of term + </para> + </listitem> + <listitem> + <para> + <literal>status</literal> - Scan status + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array (0..n-1) where n is the number of terms returned. Each + value is a pair where the first item is the term, and the second item is + the result-count. </para> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-schema.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-schema.xml diff -u phpdoc/en/reference/yaz/functions/yaz-schema.xml:1.3 phpdoc/en/reference/yaz/functions/yaz-schema.xml:1.4 --- phpdoc/en/reference/yaz/functions/yaz-schema.xml:1.3 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-schema.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.yaz-schema"> <refnamediv> <refname>yaz_schema</refname> @@ -7,23 +7,53 @@ Specifies schema for retrieval </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_schema</methodname> + <void/><methodname>yaz_schema</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>schema</parameter></methodparam> </methodsynopsis> <para> - The schema must be specified as an OID (Object Identifier) in a - raw dot-notation (like <literal>1.2.840.10003.13.4</literal>) or - as one of the known registered schemas: - <literal>GILS-schema</literal>, <literal>Holdings</literal>, - <literal>Zthes</literal>, ... + <function>yaz_schema</function> specifies the schema for retrieval. + </para> + <para> This function should be called before <function>yaz_search</function> or <function>yaz_present</function>. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>schema</parameter></term> + <listitem> + <para> + Must be specified as an OID (Object Identifier) in a raw dot-notation + (like <literal>1.2.840.10003.13.4</literal>) or as one of the known + registered schemas: <literal>GILS-schema</literal>, + <literal>Holdings</literal>, <literal>Zthes</literal>, ... + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-sort.xml?r1=1.6&r2=1.7&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-sort.xml diff -u phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.6 phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.7 --- phpdoc/en/reference/yaz/functions/yaz-sort.xml:1.6 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-sort.xml Tue Apr 5 12:18:39 2005 @@ -1,69 +1,125 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.yaz-sort"> <refnamediv> <refname>yaz_sort</refname> <refpurpose>Sets sorting criteria</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_sort</methodname> + <void/><methodname>yaz_sort</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>criteria</parameter></methodparam> </methodsynopsis> <para> This function sets sorting criteria and enables Z39.50 Sort. - Call this function <emphasis>before</emphasis> - <function>yaz_search</function>. + </para> + <para> + Call this function <emphasis>before</emphasis> <function>yaz_search</function>. Using this function alone does not have any effect. When used in conjunction with <function>yaz_search</function>, a Z39.50 Sort will be sent after a search response has been received and before any records are retrieved with - Z39.50 Present (<function>yaz_present</function>. The parameter - <parameter>criteria</parameter> takes the form - </para> - <para> - <replaceable>field1 flags1 field2 flags2</replaceable> ... + Z39.50 Present (<function>yaz_present</function>. </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - where field1 specifies the primary attributes for sort, field2 seconds, - etc.. The field specifies either a numerical attribute combinations consisting - of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>) - ; or the field may specify a plain string criteria - (e.g. <literal>title</literal>. The flags is a sequence of the following - characters which may not be separated by any white space. - </para> - <variablelist> - <title>Sort Flags</title> - <varlistentry><term><literal>a</literal></term><listitem> - <simpara>Sort ascending</simpara></listitem> - </varlistentry> - <varlistentry><term><literal>d</literal></term><listitem> - <simpara>Sort descending</simpara></listitem> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> </varlistentry> - <varlistentry><term><literal>i</literal></term><listitem> - <simpara>Case insensitive sorting</simpara></listitem> + <varlistentry> + <term><parameter>criteria</parameter></term> + <listitem> + <para> + A string that takes the form <replaceable>field1 flags1 field2 + flags2</replaceable> where field1 specifies the primary attributes for + sort, field2 seconds, etc.. + </para> + <para> + The field specifies either a numerical attribute combinations consisting + of type=value pairs separated by comma (e.g. <literal>1=4,2=1</literal>) + ; or the field may specify a plain string criteria (e.g. + <literal>title</literal>. The flags is a sequence of the following + characters which may not be separated by any white space. + </para> + <para> + <variablelist> + <title>Sort Flags</title> + <varlistentry> + <term><literal>a</literal></term> + <listitem> + <para> + Sort ascending + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>d</literal></term> + <listitem> + <para> + Sort descending + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>i</literal></term> + <listitem> + <para> + Case insensitive sorting + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>s</literal></term> + <listitem> + <para> + Case sensitive sorting + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </listitem> </varlistentry> - <varlistentry><term><literal>s</literal></term><listitem> - <simpara>Case sensitive sorting</simpara></listitem> - </varlistentry> - </variablelist> - <example> - <title>Sort Criterias</title> - <para> - To sort on Bib1 attribute title, case insensitive, - and ascending you would use the following sort criteria: - <screen> - 1=4 ia - </screen> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - If the secondary sorting criteria should be author, case sensitive - and ascending you would use: - <screen> - 1=4 ia 1=1003 sa - </screen> + &return.void; </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <example> + <title>Sort Criterias</title> + <para> + To sort on Bib1 attribute title, case insensitive, and ascending you + would use the following sort criteria: + <screen> +<![CDATA[ +1=4 ia +]]> + </screen> + </para> + <para> + If the secondary sorting criteria should be author, case sensitive and + ascending you would use: + <screen> +<![CDATA[ +1=4 ia 1=1003 sa +]]> + </screen> + </para> </example> </refsect1> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/yaz/functions/yaz-syntax.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/yaz/functions/yaz-syntax.xml diff -u phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.5 phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.6 --- phpdoc/en/reference/yaz/functions/yaz-syntax.xml:1.5 Tue Apr 5 12:17:59 2005 +++ phpdoc/en/reference/yaz/functions/yaz-syntax.xml Tue Apr 5 12:18:39 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.yaz-syntax"> <refnamediv> <refname>yaz_syntax</refname> @@ -7,19 +7,51 @@ Specifies the preferred record syntax for retrieval </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> - <type>int</type><methodname>yaz_syntax</methodname> + <void/><methodname>yaz_syntax</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>syntax</parameter></methodparam> </methodsynopsis> <para> - The syntax must be specified as an OID (Object Identifier) in a - raw dot-notation (like <literal>1.2.840.10003.5.10</literal>) or - as one of the known registered record syntaxes (sutrs, usmarc, grs1, - xml, etc.). This function should be called before - <function>yaz_search</function> or <function>yaz_present</function>. + <function>yaz_syntax</function> specifies the preferred record syntax for + retrieval + </para> + <para> + This function should be called before <function>yaz_search</function> or + <function>yaz_present</function>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>id</parameter></term> + <listitem> + <para> + The connection resource returned by <function>yaz_connect</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>syntax</parameter></term> + <listitem> + <para> + The syntax must be specified as an OID (Object Identifier) in a raw + dot-notation (like <literal>1.2.840.10003.5.10</literal>) or as one of + the known registered record syntaxes (sutrs, usmarc, grs1, xml, etc.). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; </para> </refsect1> </refentry>