uTools-Manuals/docs/php/yaz_es.html
2019-04-08 23:22:26 +08:00

143 lines
6.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Prepares for an Extended Service Request</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.yaz-es" class="refentry">
<div class="refnamediv">
<h1 class="refname">yaz_es</h1>
<p class="verinfo">(PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_es</span> &mdash; <span class="dc-title">
Prepares for an Extended Service Request
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.yaz-es-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>yaz_es</strong></span>
( <span class="methodparam">
<span class="type">resource</span> <code class="parameter">$id</code>
</span>
, <span class="methodparam">
<span class="type">string</span> <code class="parameter">$type</code>
</span>
, <span class="methodparam">
<span class="type">array</span> <code class="parameter">$args</code>
</span>
) : <span class="type"><span class="type void">void</span></span></div>
<p class="para rdfs-comment">
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.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Many Z39.50 Servers do not support Extended Services.
</p>
</p></blockquote>
<p class="para">
The <span class="function"><strong>yaz_es()</strong></span> creates an Extended Service Request
packages and puts it into a queue of operations.
Use <span class="function"><a href="yaz_wait.html" class="function">yaz_wait()</a></span> to send the request(s) to the server.
After completion of <span class="function"><a href="yaz_wait.html" class="function">yaz_wait()</a></span> the result of
the Extended Service operation should be expected with
a call to <span class="function"><a href="yaz_es_result.html" class="function">yaz_es_result()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.yaz-es-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">id</code></dt>
<dd>
<p class="para">
The connection resource returned by <span class="function"><a href="yaz_connect.html" class="function">yaz_connect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">type</code></dt>
<dd>
<p class="para">
A string which represents the type of the Extended Service:
<em>itemorder</em> (Item Order),
<em>create</em> (Create Database),
<em>drop</em> (Drop Database),
<em>commit</em> (Commit Operation),
<em>update</em> (Update Record),
<em>xmlupdate</em> (XML Update).
Each type is specified in the following section.
</p>
</dd>
<dt>
<code class="parameter">args</code></dt>
<dd>
<p class="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 <a href="http://www.indexdata.dk/yaz/doc/zoom.tkl" class="link external">&raquo;&nbsp;Extended Services</a>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.yaz-es-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
没有返回值。
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.yaz-es-examples">
<h3 class="title">范例</h3>
<div class="example" id="example-5686">
<p><strong>Example #1 Record Update</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$con&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">yaz_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"myhost/database"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$args&nbsp;</span><span style="color: #007700">=&nbsp;array&nbsp;(<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"record"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"&lt;gils&gt;&lt;title&gt;some&nbsp;title&lt;/title&gt;&lt;/gils&gt;"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"syntax"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"xml"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">"action"&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">"specialUpdate"<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">yaz_es</span><span style="color: #007700">(</span><span style="color: #0000BB">$con</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"update"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$args</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">yaz_wait</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$result&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">yaz_es_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-function.yaz-es-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="yaz_es_result.html" class="function" rel="rdfs-seeAlso">yaz_es_result()</a> - Inspects Extended Services Result</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>