<?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-ccl-parse.php',
    1 => 'yaz_ccl_parse',
    2 => 'CCL パーサーを起動する',
  ),
  'up' => 
  array (
    0 => 'ref.yaz.php',
    1 => 'YAZ 関数',
  ),
  'prev' => 
  array (
    0 => 'function.yaz-ccl-conf.php',
    1 => 'yaz_ccl_conf',
  ),
  'next' => 
  array (
    0 => 'function.yaz-close.php',
    1 => 'yaz_close',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/yaz/functions/yaz-ccl-parse.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.yaz-ccl-parse" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaz_ccl_parse</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.5, PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_ccl_parse</span> &mdash; <span class="dc-title">CCL パーサーを起動する</span></p>

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

  <p class="para rdfs-comment">
   この関数は、CCL パーサーを起動します。パーサーは、指定された CCL FIND クエリを
   RPN クエリに変換します。これは検索を実行する <span class="function"><a href="function.yaz-search.php" class="function">yaz_search()</a></span>
   関数に渡すためのものです。
  </p>
  <p class="para">
   有効な CCL フィールドの組を定義するには、この関数の前に
   <span class="function"><a href="function.yaz-ccl-conf.php" class="function">yaz_ccl_conf()</a></span> をコールします。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.yaz-ccl-parse-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">query</code></dt>
     <dd>
      <p class="para">
       CCL FIND クエリ。
      </p>
     </dd>
    
    
     <dt><code class="parameter">result</code></dt>
     <dd>
      <p class="para">
       関数が成功した場合、キー <code class="literal">rpn</code> に有効な
       RPN クエリを含む配列となります。
      </p>
      <p class="para">
       失敗した場合は、以下の 3 つの添え字を含む配列となり、失敗の原因を示します。
       <ul class="itemizedlist">
        <li class="listitem">
         <p class="para">
          <code class="literal">errorcode</code> - CCL エラーコード（整数）
         </p>
        </li> 
        <li class="listitem">
         <p class="para">
          <code class="literal">errorstring</code> - CCL エラー文字列
         </p>
        </li> 
        <li class="listitem">
         <p class="para">
          <code class="literal">errorpos</code> - クエリが失敗したおおよその位置
          （文字の位置を整数で表す）
         </p>
        </li> 
       </ul>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.yaz-ccl-parse-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-ccl-parse-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 CCL のパース</strong></p>
   <div class="example-contents"><p>
    CCL を利用して検索します。以下の例で、<code class="literal">$ccl</code>
    は CCL クエリです。
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />yaz_ccl_conf</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">, </span><span style="color: #0000BB">$fields</span><span style="color: #007700">);  </span><span style="color: #FF8000">// yaz_ccl_conf のサンプルを参照ください<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">yaz_ccl_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$id</span><span style="color: #007700">, </span><span style="color: #0000BB">$ccl</span><span style="color: #007700">, </span><span style="color: #0000BB">$cclresult</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">'Error: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$cclresult</span><span style="color: #007700">[</span><span style="color: #DD0000">"errorstring"</span><span style="color: #007700">];<br />} else {<br />    </span><span style="color: #0000BB">$rpn </span><span style="color: #007700">= </span><span style="color: #0000BB">$cclresult</span><span style="color: #007700">[</span><span style="color: #DD0000">"rpn"</span><span style="color: #007700">];<br />    </span><span style="color: #0000BB">yaz_search</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: #0000BB">$rpn</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>

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