<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.yaz.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.yaz-scan.php',
    1 => 'yaz_scan',
    2 => 'Pr&eacute;pare un scan YAZ',
  ),
  'up' => 
  array (
    0 => 'ref.yaz.php',
    1 => 'YAZ Fonctions',
  ),
  'prev' => 
  array (
    0 => 'function.yaz-record.php',
    1 => 'yaz_record',
  ),
  'next' => 
  array (
    0 => 'function.yaz-scan-result.php',
    1 => 'yaz_scan_result',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/yaz/functions/yaz-scan.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.yaz-scan" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaz_scan</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.5, PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_scan</span> &mdash; <span class="dc-title">Prépare un scan YAZ</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="methodname"><strong>yaz_scan</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$id</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$type</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$startterm</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$flags</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>yaz_scan()</strong></span> prépare une requête 
   <code class="literal">&quot;Z39.50 Scan Request&quot;</code> sur la connexion YAZ spécifiée.
  </p>
  <p class="para">
   Pour réellement transférer la requête <code class="literal">&quot;Scan Request&quot;</code>
   au serveur et recevoir le <code class="literal">&quot;Scan Response&quot;</code>, 
   la fonction <span class="function"><a href="function.yaz-wait.php" class="function">yaz_wait()</a></span> doit être appelée. 
   Après la fin de <span class="function"><a href="function.yaz-wait.php" class="function">yaz_wait()</a></span>, appelez
   <span class="function"><a href="function.yaz-error.php" class="function">yaz_error()</a></span> et <span class="function"><a href="function.yaz-scan-result.php" class="function">yaz_scan_result()</a></span>
   pour connaître la réponse.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.yaz-scan-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">id</code></dt>
     <dd>
      <p class="para">
       La ressource de connexion retournée par
       <span class="function"><a href="function.yaz-connect.php" class="function">yaz_connect()</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">type</code></dt>
     <dd>
      <p class="para">
       Actuellement seulement le type <code class="literal">rpn</code> est supporté.
      </p>
     </dd>
    
    
     <dt><code class="parameter">startterm</code></dt>
     <dd>
      <p class="para">
       Point de départ du scan.
      </p>
      <p class="para">
       La forme dans laquelle le terme de départ est spécifié est donnée par
       le paramètre <code class="parameter">type</code>.
      </p>
      <p class="para">
       La syntaxe de ce paramètre est similaire à la requête RPN comme décrite
       dans <span class="function"><a href="function.yaz-search.php" class="function">yaz_search()</a></span>. Cela consiste à aucune ou
       plusieurs spécifications d&#039;opérateur <code class="literal">@attr</code>, ensuite
       suivies par exactement une seule marque.
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       Ce paramètre optionnel spécifie des informations supplémentaires pour
       contrôler le comportement de la requête de scan. Trois index sont
       actuellement lus à partir du tableau d&#039;options :
       <code class="literal">number</code> (nombre de termes demandés),
       <code class="literal">position</code> (position préférée du terme) et
       <code class="literal">stepSize</code> (grandeur de pas préférée).
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.yaz-scan-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Aucune valeur n&#039;est retournée.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.yaz-scan-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Fonction PHP qui analyse les titres sur un serveur YAZ</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">=&gt; </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"> "</span><span style="color: #007700">;<br />    }<br />    echo </span><span style="color: #DD0000">'&lt;br /&gt;&lt;table&gt;'</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">"&lt;tr&gt;&lt;td&gt;</span><span style="color: #0000BB">$term</span><span style="color: #DD0000">&lt;/td&gt;&lt;td&gt;</span><span style="color: #0000BB">$tcount</span><span style="color: #DD0000">&lt;/td&gt;&lt;/tr&gt;"</span><span style="color: #007700">;<br />    }<br />    echo </span><span style="color: #DD0000">'&lt;/table&gt;'</span><span style="color: #007700">;<br />  } else {<br />    echo </span><span style="color: #DD0000">"Erreur de Scan. Erreur : " </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">"&lt;br /&gt;"</span><span style="color: #007700">;<br />  }<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>

</div><?php manual_footer($setup); ?>