<?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 => 'ru',
  ),
  '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' => 'ru',
    '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>. В этом случае третий аргумент определяет запрос Type-1
       в префиксной нотации запросов.
      </p>
     </dd>
    
    
     <dt><code class="parameter">query</code></dt>
     <dd>
      <p class="para">
       Запрос RPN является текстовым представлением запроса Type-1, как указано
       в стандарте Z39.50. Тем не менее в текстовом представлении, используемом
       в YAZ, применяется префиксная нотация, т.е. оператор предшествует операнду.
       Строка запроса представляет собой последовательность лексем(токенов), в которой
       игнорируются пробельные символы, кроме тех, что находятся между двойными кавычками.
       Лексемы, которые начинаются с символа <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>
           определяет набор атрибутов <code class="literal">set</code> для
           запроса <code class="literal">query</code>. Эта конструкция доступна
           только один раз - в самом начале запроса.
          </td>
         </tr>

         <tr>
          <td><code class="literal">@attr</code> [set] type=value query</td>
          <td>
           устанавливает атрибуты запроса. Значения <code class="literal">type</code> и
           <code class="literal">value</code> - целочисленные и определяют тип атрибута и
           тип значения соответственно.
           Значение <code class="literal">set</code>, если оно задано, определяет настройку атрибутов.
          </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>
    Запрос содержит два атрибута для одной фразы.
    <div class="example-contents screen">@attr 1=1003 @attr 4=1 &quot;knuth donald&quot;</div>
    Первый атрибут имеет тип 1 (используется Bib-1), значение которого равно
    1003(Автор).
    Второй атрибут имеет тип 4 (структура), со значением 1 (фраза). Таким
    образом данный запрос будет искать документы автор которых 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 или b) и ((c или d) и не
    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. Запрос ищет
    документы, где <code class="literal">art</code> встречается в заглавии (GILS,BIB-1)
    и <code class="literal">company</code> в поставщиках.
   </p></div>
  </div>
 </div>

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