📄 function.yaz-scan.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Prepares for a scan</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.yaz-scan-result.html">yaz_scan_result</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.yaz-schema.html">yaz_schema</a></div> <div class="up"><a href="ref.yaz.html">YAZ Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.yaz-scan" class="refentry"> <div class="refnamediv"> <h1 class="refname">yaz_scan</h1> <p class="verinfo">(PHP 4 >= 4.0.5, PECL yaz:0.9-1.0.9)</p><p class="refpurpose"><span class="refname">yaz_scan</span> — <span class="dc-title">Prepares for a scan</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type void">void</span></span> <span class="methodname"><b><b>yaz_scan</b></b></span> ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$id</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$type</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$startterm</tt></span> [, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$flags</tt></span> ] )</div> <p class="para rdfs-comment"> This function prepares for a Z39.50 Scan Request on the specified connection. </p> <p class="para"> To actually transfer the Scan Request to the server and receive the Scan Response, <a href="function.yaz-wait.html" class="function">yaz_wait()</a> must be called. Upon completion of <a href="function.yaz-wait.html" class="function">yaz_wait()</a> call <a href="function.yaz-error.html" class="function">yaz_error()</a> and <a href="function.yaz-scan-result.html" class="function">yaz_scan_result()</a> to handle the response. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">id</tt></i></span> <dd> <p class="para"> The connection resource returned by <a href="function.yaz-connect.html" class="function">yaz_connect()</a>. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">type</tt></i></span> <dd> <p class="para"> Currently only type <i>rpn</i> is supported. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">startterm</tt></i></span> <dd> <p class="para"> Starting term point for the scan. </p> <p class="para"> The form in which the starting term is specified is given by parameter <i><tt class="parameter">type</tt></i>. </p> <p class="para"> The syntax this parameter is similar to the RPN query as described in <a href="function.yaz-search.html" class="function">yaz_search()</a>. It consists of zero or more <i>@attr</i>-operator specifications, then followed by exactly one token. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">flags</tt></i></span> <dd> <p class="para"> This optional parameter specifies additional information to control the behaviour of the scan request. Three indexes are currently read from the flags array: <i>number</i> (number of terms requested), <i>position</i> (preferred position of term) and <i>stepSize</i> (preferred step size). </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 PHP function that scans titles</b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">scan_titles</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">, </span><span style="color: #0000BB">$startterm</span><span style="color: #007700">) <br />{<br /> </span><span style="color: #0000BB">yaz_scan</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">, </span><span style="color: #DD0000">"rpn"</span><span style="color: #007700">, </span><span style="color: #DD0000">"@attr 1=4 " </span><span style="color: #007700">. </span><span style="color: #0000BB">$startterm</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">yaz_wait</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$errno </span><span style="color: #007700">= </span><span style="color: #0000BB">yaz_errno</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$errno </span><span style="color: #007700">== </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$ar </span><span style="color: #007700">= </span><span style="color: #0000BB">yaz_scan_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">, &</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">'Scan ok; '</span><span style="color: #007700">;<br /> foreach (</span><span style="color: #0000BB">$options </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"$key = $val &nbsp;"</span><span style="color: #007700">;<br /> }<br /> echo </span><span style="color: #DD0000">'<br /><table>'</span><span style="color: #007700">;<br /> while (list(</span><span style="color: #0000BB">$key</span><span style="color: #007700">, list(</span><span style="color: #0000BB">$k</span><span style="color: #007700">, </span><span style="color: #0000BB">$term</span><span style="color: #007700">, </span><span style="color: #0000BB">$tcount</span><span style="color: #007700">)) = </span><span style="color: #0000BB">each</span><span style="color: #007700">(</span><span style="color: #0000BB">$ar</span><span style="color: #007700">)) {<br /> if (empty(</span><span style="color: #0000BB">$k</span><span style="color: #007700">)) continue;<br /> echo </span><span style="color: #DD0000">"<tr><td>$term</td><td>$tcount</td></tr>"</span><span style="color: #007700">;<br /> }<br /> echo </span><span style="color: #DD0000">'</table>'</span><span style="color: #007700">;<br /> } else {<br /> echo </span><span style="color: #DD0000">"Scan failed. Error: " </span><span style="color: #007700">. </span><span style="color: #0000BB">yaz_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">) . </span><span style="color: #DD0000">"<br />"</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </div> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.yaz-scan-result.html">yaz_scan_result</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.yaz-schema.html">yaz_schema</a></div> <div class="up"><a href="ref.yaz.html">YAZ Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -