Files
Sergey Panteleev 6d43fd64d7 Исправление форматирования
[skip-spellcheck]
[skip-lint]
2022-12-27 03:42:36 +03:00

106 lines
3.6 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="sqlite3stmt.getsql" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3Stmt::getSQL</refname>
<refpurpose>Получить SQL-запрос в виде строки из запроса</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SQLite3Stmt">
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SQLite3Stmt::getSQL</methodname>
<methodparam choice="opt"><type>bool</type><parameter>expand</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Возвращает строковое представление SQL-запроса для подготовленного
запроса. Если параметр <parameter>expand</parameter>
задан как &false;, будет возвращён не модифицированный SQL. Если
же <parameter>expand</parameter> задан как &true;, все
подставляемые параметры запроса будут заменены на конкретные
значения, либо на <literal>NULL</literal>, если значения ещё не были
привязаны.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>expand</parameter></term>
<listitem>
<para>
Заменять ли в возвращаемом SQL-запросе параметры на конкретные
значения. &true; поддерживается только с libsqlite 3.14.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает SQL-запрос из подготовленного запроса&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Если <parameter>expand</parameter> задан как &true;, но версия
libsqlite ниже 3.14, будет вызвана ошибка уровня
<constant>E_WARNING</constant> либо выброшено исключение
<classname>Exception</classname>, в зависимости от настроек
<methodname>SQLite3::enableExceptions</methodname>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="sqlite3stmt.getsql.example.expanded">
<title>Получение расширенного SQL-запроса</title>
<programlisting role="php">
<![CDATA[
<?php
$db = new SQLite3(':memory:');
$stmt = $db->prepare("SELECT :a, ?, :c");
$stmt->bindValue(':a', 'foo');
$answer = 42;
$stmt->bindParam(2, $answer);
var_dump($stmt->getSQL(true));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(24) "SELECT 'foo', '42', NULL"
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->