svn: /phpdoc/es/trunk/reference/yaz/functions/ yaz-es.xml

From: Date: Sat, 06 Nov 2010 16:03:15 +0000
Subject: svn: /phpdoc/es/trunk/reference/yaz/functions/ yaz-es.xml
Groups: php.doc.es 
Request: Send a blank email to doc-es+get-3685@lists.php.net to get a copy of this message
yago Sat, 06 Nov 2010 16:03:15 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=305127 Log: Testing SVN Changed paths: A phpdoc/es/trunk/reference/yaz/functions/yaz-es.xml Added: phpdoc/es/trunk/reference/yaz/functions/yaz-es.xml =================================================================== --- phpdoc/es/trunk/reference/yaz/functions/yaz-es.xml (rev 0) +++ phpdoc/es/trunk/reference/yaz/functions/yaz-es.xml 2010-11-06 16:03:15 UTC (rev 305127) @@ -0,0 +1,146 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<refentry xml:id="function.yaz-es" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <refnamediv> + <refname>yaz_es</refname> + <refpurpose> + Prepares for an Extended Service Request + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>void</type><methodname>yaz_es</methodname> + <methodparam> + <type>resource</type><parameter>id</parameter> + </methodparam> + <methodparam> + <type>string</type><parameter>type</parameter> + </methodparam> + <methodparam> + <type>array</type><parameter>args</parameter> + </methodparam> + </methodsynopsis> + <para> + This function prepares for an Extended Service Request. + Extended Services is family of various Z39.50 facilities, such + as Record Update, Item Order, Database administration etc. + </para> + <note> + <para> + Many Z39.50 Servers do not support Extended Services. + </para> + </note> + <para> + The <function>yaz_es</function> creates an Extended Service Request + packages and puts it into a queue of operations. + Use <function>yaz_wait</function> to send the request(s) to the server. + After completion of <function>yaz_wait</function> the result of + the Extended Service operation should be expected with + a call to <function>yaz_es_result</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>type</parameter></term> + <listitem> + <para> + A string which represents the type of the Extended Service: + <literal>itemorder</literal> (Item Order), + <literal>create</literal> (Create Database), + <literal>drop</literal> (Drop Database), + <literal>commit</literal> (Commit Operation), + <literal>update</literal> (Update Record), + <literal>xmlupdate</literal> (XML Update). + Each type is specified in the following section. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><parameter>args</parameter></term> + <listitem> + <para> + An array with extended service options plus + package specific options. The options are identical to + those offered in the C API of ZOOM C. Refer to + the ZOOM <link xlink:href="&url.yaz.zoom.ext;">Extended Services</link>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <example> + <title>Record Update</title> + <programlisting role="php"> +<![CDATA[ +<?php +$con = yaz_connect("myhost/database"); +$args = array ( + "record" => "<gils><title>some title</title></gils>", + "syntax" => "xml", + "action" => "specialUpdate" +); +yaz_es($con, "update", $args); +yaz_wait(); +$result = yaz_es_result($id); +?> +]]> + </programlisting> + </example> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>yaz_es_result</function></member> + </simplelist> + </para> + </refsect1> + +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +indent-tabs-mode:nil +sgml-parent-document:nil +sgml-default-dtd-file:"~/.phpdoc/manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +vim600: syn=xml fen fdm=syntax fdl=2 si +vim: et tw=78 syn=sgml +vi: ts=1 sw=1 +--> Property changes on: phpdoc/es/trunk/reference/yaz/functions/yaz-es.xml ___________________________________________________________________ Added: svn:keywords + Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL Added: svn:eol-style + native

« previous php.doc.es (#3685) next »