<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.sqlite3stmt.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'sqlite3stmt.setexplain.php',
    1 => 'SQLite3Stmt::setExplain',
    2 => 'Changes the explain mode of the statement',
  ),
  'up' => 
  array (
    0 => 'class.sqlite3stmt.php',
    1 => 'SQLite3Stmt',
  ),
  'prev' => 
  array (
    0 => 'sqlite3stmt.reset.php',
    1 => 'SQLite3Stmt::reset',
  ),
  'next' => 
  array (
    0 => 'class.sqlite3result.php',
    1 => 'SQLite3Result',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/sqlite3/sqlite3stmt/setexplain.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="sqlite3stmt.setexplain" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SQLite3Stmt::setExplain</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.5.0)</p><p class="refpurpose"><span class="refname">SQLite3Stmt::setExplain</span> &mdash; <span class="dc-title">Changes the explain mode of the statement</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-sqlite3stmt.setexplain-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>SQLite3Stmt::setExplain</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mode</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Changes the explain mode of the statement, so that it behaves as if its SQL
   was prefixed with <code class="literal">EXPLAIN</code> or
   <code class="literal">EXPLAIN QUERY PLAN</code>, or as an ordinary statement again.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-sqlite3stmt.setexplain-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <p class="simpara">
      One of <strong><code>SQLite3Stmt::EXPLAIN_MODE_PREPARED</code></strong>,
      <strong><code>SQLite3Stmt::EXPLAIN_MODE_EXPLAIN</code></strong>, or
      <strong><code>SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN</code></strong>.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-sqlite3stmt.setexplain-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   成功时返回 <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 errors" id="refsect1-sqlite3stmt.setexplain-errors">
  <h3 class="title">错误／异常</h3>
  <p class="simpara">
   A <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> is thrown if <code class="parameter">mode</code>
   is not one of the <strong><code>SQLite3Stmt::EXPLAIN_MODE_*</code></strong> constants.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-sqlite3stmt.setexplain-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="sqlite3stmt.explain.php" class="methodname" rel="rdfs-seeAlso">SQLite3Stmt::explain()</a> - Returns the explain mode of the statement</span></li>
   <li><span class="methodname"><a href="sqlite3stmt.execute.php" class="methodname" rel="rdfs-seeAlso">SQLite3Stmt::execute()</a> - Executes a prepared statement and returns a result set object</span></li>
  </ul>
 </div>


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