<!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 a scan</title>
</head>
<body><div class="manualnavbar" 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.0)</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" id="refsect1-function.yaz-scan-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>yaz_scan</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">string</span> <code class="parameter">$startterm</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$flags</code></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, <span class="function"><a href="function.yaz-wait.html" class="function">yaz_wait()</a></span> must be called. Upon
completion of <span class="function"><a href="function.yaz-wait.html" class="function">yaz_wait()</a></span> call
<span class="function"><a href="function.yaz-error.html" class="function">yaz_error()</a></span> and <span class="function"><a href="function.yaz-scan-result.html" class="function">yaz_scan_result()</a></span> to
handle the response.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.yaz-scan-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">id</code></em></span>
<dd>
<p class="para">
The connection resource returned by <span class="function"><a href="function.yaz-connect.html" class="function">yaz_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
Currently only type <em>rpn</em> is supported.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">startterm</code></em></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
<em><code class="parameter">type</code></em>.
</p>
<p class="para">
The syntax this parameter is similar to the RPN query as described in
<span class="function"><a href="function.yaz-search.html" class="function">yaz_search()</a></span>. It consists of zero or more
<em>@attr</em>-operator specifications, then followed by
exactly one token.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></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:
<em>number</em> (number of terms requested),
<em>position</em> (preferred position of term) and
<em>stepSize</em> (preferred step size).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.yaz-scan-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.yaz-scan-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4684">
<p><strong>Example #1 PHP function that scans titles</strong></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">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> = </span><span style="color: #0000BB">$val</span><span style="color: #DD0000"> &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></span><span style="color: #0000BB">$term</span><span style="color: #DD0000"></td><td></span><span style="color: #0000BB">$tcount</span><span style="color: #DD0000"></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 class="manualnavbar" 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>
