<?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-search.php',
    1 => 'yaz_search',
    2 => '検索を準備する',
  ),
  'up' => 
  array (
    0 => 'ref.yaz.php',
    1 => 'YAZ 関数',
  ),
  'prev' => 
  array (
    0 => 'function.yaz-schema.php',
    1 => 'yaz_schema',
  ),
  'next' => 
  array (
    0 => 'function.yaz-set-option.php',
    1 => 'yaz_set_option',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/yaz/functions/yaz-search.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.yaz-search" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaz_search</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_search</span> &mdash; <span class="dc-title">検索を準備する</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.yaz-search-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>yaz_search</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.string.php" class="type string">string</a></span> <code class="parameter">$type</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$query</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>yaz_search()</strong></span> は、指定した接続で検索を行う準備をします。
  </p>
  <p class="para">
   <span class="function"><a href="function.yaz-connect.php" class="function">yaz_connect()</a></span> と同様にこの関数は非ブロックモードで
   動作し、後で <span class="function"><a href="function.yaz-wait.php" class="function">yaz_wait()</a></span> がコールされたときのために
   検索の準備をするだけです。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.yaz-search-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">type</code></dt>
     <dd>
      <p class="para">
       クエリの型を表します。現在は <code class="literal">&quot;rpn&quot;</code> のみがサポート
       されており、この場合 3 番目の引数には Type-1 クエリを前置表記で
       指定します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">query</code></dt>
     <dd>
      <p class="para">
       RPN クエリは、Z39.50 規格により定義された Type-1 クエリのテキスト
       表現です。しかし、YAZ により使用されるテキスト表現では、演算子が
       オペランドの前にある前置表記が使用されます。クエリ文字列はトークンの
       並びであり、このトークンでは 2 重引用符で括られない限り空白文字は
       無視されます。アットマーク(<code class="literal">@</code>)で始まるトークンは
       演算子とみなされ、そうでない場合は検索項目として処理されます。
      </p>
      <table class="doctable table">
       <caption><strong>RPN 演算子</strong></caption>
       
        <col width="1*" />
        <col width="2*" />
        <thead>
         <tr>
          <th>構文</th>
          <th>説明</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td><code class="literal">@and</code> query1 query2</td>
          <td>
           query1 および query2 の積集合
          </td>
         </tr>

         <tr>
          <td><code class="literal">@or</code> query1 query2</td>
          <td>
           query1 および query2 の和集合
          </td>
         </tr>

         <tr>
          <td><code class="literal">@not</code> query1 query2</td>
          <td>
           query1 であり、query2 でない
          </td>
         </tr>

         <tr>
          <td><code class="literal">@set</code> name</td>
          <td>
           結果セットへのリファレンス
          </td>
         </tr>

         <tr>
          <td><code class="literal">@attrset</code> set query</td>
          <td>
           クエリの属性セットを指定します。この構造が使用できるのは
           全てのクエリの始めに一回だけです。
          </td>
         </tr>

         <tr>
          <td><code class="literal">@attr</code> [set] type=value query</td>
          <td>
           クエリに属性を適用します。型と値は属性型と属性値をそれぞれ指定する
           整数です。この組みが指定された場合、属性の組を指定します。
          </td>
         </tr>

        </tbody>
       
      </table>
     
      <p class="para">
       属性についての情報は
       <a href="http://www.loc.gov/z3950/agency/defns/bib1.html" class="link external">&raquo;&nbsp;Z39.50 Maintenance Agency</a>
       サイトにあります。
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        もう少しわかりやすい記法を利用したい場合は、CCL パーサー関数 -
        <span class="function"><a href="function.yaz-ccl-conf.php" class="function">yaz_ccl_conf()</a></span> および
        <span class="function"><a href="function.yaz-ccl-parse.php" class="function">yaz_ccl_parse()</a></span> を使用してください。
       </p>
      </p></blockquote>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.yaz-search-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.yaz-search-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 クエリの例</strong></p>
   <div class="example-contents"><p>
    単純な検索は以下のように行います。
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">computer</pre>
</div>
    </div>
    は、&quot;computer&quot; を含む文書にマッチします。属性は指定されていません。
   </p></div>
   <div class="example-contents"><p>
    クエリ
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">&quot;knuth donald&quot;</pre>
</div>
    </div>
    は、&quot;knuth donald&quot; を含む文書にマッチします（サーバーが複数の単語による
    検索をサポートしている場合）。
   </p></div>
   <div class="example-contents"><p>
    このクエリは、同じフレーズに対して 2 つの属性を適用しています。
    <div class="example-contents screen">@attr 1=1003 @attr 4=1 &quot;knuth donald&quot;</div>
    最初の属性は type 1 (Bib-1 use) で、その値は 1003
    (Author) です。
    2 番目の属性は type 4 (structure) で、その値は 1 (phrase)
    です。つまりこれは、Donald Knuth が著者である文書にマッチする
    ことになります。
   </p></div>
   <div class="example-contents"><p>
    クエリ
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">@and @or a b @not @or c d e</pre>
</div>
    </div>
    は、次のような意味になります。<code class="literal">(a or b) and ((c or d) not 
    e)</code>
   </p></div>
   <div class="example-contents"><p>
    さらに複雑な例です。
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">@attrset gils @and @attr 1=4 art @attr 1=2000 company</pre>
</div>
    </div>
    このクエリは GILS 属性セットをすべて使用しています。このクエリは
    表題（Title）に <code class="literal">art</code> が含まれ（GILS,BIB-1）、
    配布者（Distributor）に <code class="literal">company</code> が含まれる（GILS）
    文書にマッチします。
   </p></div>
  </div>
 </div>

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