<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.yaz-hits.php',
    1 => 'yaz_hits',
    2 => '直近の検索に関するヒット数を返す',
  ),
  'up' => 
  array (
    0 => 'ref.yaz.php',
    1 => 'YAZ 関数',
  ),
  'prev' => 
  array (
    0 => 'function.yaz-get-option.php',
    1 => 'yaz_get_option',
  ),
  'next' => 
  array (
    0 => 'function.yaz-itemorder.php',
    1 => 'yaz_itemorder',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/yaz/functions/yaz-hits.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.yaz-hits" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaz_hits</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_hits</span> &mdash; <span class="dc-title">直近の検索に関するヒット数を返す</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.yaz-hits-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>yaz_hits</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$id</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter reference">&$searchresult</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>yaz_hits()</strong></span> は、直近の検索に関するヒット数を返します。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.yaz-hits-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">id</code></dt>
     <dd>
      <p class="para">
       <span class="function"><a href="function.yaz-connect.php" class="function">yaz_connect()</a></span> が返す接続リソース。
      </p>
     </dd>
    
    
     <dt><code class="parameter">searchresult</code></dt>
     <dd>
      <p class="para">
       詳細な検索結果情報の配列。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.yaz-hits-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   直近の検索に関するヒット数を返します。検索が行われていない場合は
   0 を返します。
  </p>
  <p class="para">
   検索結果配列がもし指定されていた場合、そこには Z39.50 サーバーが返す情報が
   含まれます。この情報の形式は、検索結果の応答の一部である
   SearchResult-1 フォーマットとなります。
   SearchResult-1 フォーマットは、さまざまなクエリ(サブクエリ)のヒット数に
   関する情報を取得するために使用可能です。
   特に、クエリ内の個々の検索語句に関するヒット数を得ることが可能です。
   最初のサブクエリについての情報が $array[0] に、2 番目のサブクエリについての
   情報が $array[1] に、というような形式となります。
  </p>
  <table class="doctable table">
   <caption><strong>検索結果の項目</strong></caption>
   
    <col width="1*" />
    <col width="2*" />
    <thead>
     <tr>
      <th>要素</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td><code class="literal">id</code></td>
      <td>サブクエリの ID2 (string)</td>
     </tr>

     <tr>
      <td><code class="literal">count</code></td>
      <td>結果のカウント / ヒット数 (integer)</td>
     </tr>

     <tr>
      <td><code class="literal">subquery.term</code></td>
      <td>サブクエリの語句 (string)</td>
     </tr>

     <tr>
      <td><code class="literal">interpretation.term</code></td>
      <td>解釈されたサブクエリの語句 (string)</td>
     </tr>

     <tr>
      <td><code class="literal">recommendation.term</code></td>
      <td>推奨されるサブクエリの語句 (string)</td>
     </tr>

    </tbody>
   
  </table>
     
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    SearchResult 機能を使用するには、PECL YAZ 1.0.5 以降
    および YAZ 2.1.9 以降が必要です。
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    SearchResult 機能をサポートしている Z39.50 実装は
    ほとんどありません。
   </p>
  </p></blockquote>
 </div>

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