Skip to content

Document SQLite3Stmt::EXPLAIN_MODE_* class constants (PHP 8.5) #5668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lacatoire wants to merge 1 commit into from
Closed

Document SQLite3Stmt::EXPLAIN_MODE_* class constants (PHP 8.5) #5668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions reference/sqlite3/sqlite3stmt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,26 @@
<classname>SQLite3Stmt</classname>
</ooclass>

<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="sqlite3stmt.constants.explain-mode-prepared">SQLite3Stmt::EXPLAIN_MODE_PREPARED</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="sqlite3stmt.constants.explain-mode-explain">SQLite3Stmt::EXPLAIN_MODE_EXPLAIN</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="sqlite3stmt.constants.explain-mode-explain-query-plan">SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN</varname>
<initializer>2</initializer>
</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sqlite3stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SQLite3Stmt'])">
<xi:fallback/>
Expand All @@ -36,6 +56,47 @@

</section>

<!-- {{{ SQLite3Stmt constants -->
<section xml:id="sqlite3stmt.constants">
&reftitle.constants;
<variablelist>

<varlistentry xml:id="sqlite3stmt.constants.explain-mode-prepared">
<term><constant>SQLite3Stmt::EXPLAIN_MODE_PREPARED</constant></term>
<listitem>
<para>

Check failure on line 67 in reference/sqlite3/sqlite3stmt.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (en) 

sqlite3stmt.xml: <para> contains only inline content and should be <simpara>.
The statement operates in normal prepared statement mode (no <literal>EXPLAIN</literal>).
Available as of PHP 8.5.0.
</para>
</listitem>
</varlistentry>

<varlistentry xml:id="sqlite3stmt.constants.explain-mode-explain">
<term><constant>SQLite3Stmt::EXPLAIN_MODE_EXPLAIN</constant></term>
<listitem>
<para>

Check failure on line 77 in reference/sqlite3/sqlite3stmt.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (en) 

sqlite3stmt.xml: <para> contains only inline content and should be <simpara>.
The statement operates as if prefixed with <literal>EXPLAIN</literal>,
returning opcode information from the virtual machine.
Available as of PHP 8.5.0.
</para>
</listitem>
</varlistentry>

<varlistentry xml:id="sqlite3stmt.constants.explain-mode-explain-query-plan">
<term><constant>SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN</constant></term>
<listitem>
<para>

Check failure on line 88 in reference/sqlite3/sqlite3stmt.xml

View workflow job for this annotation

GitHub Actions / DocBook Style Check (en) 

sqlite3stmt.xml: <para> contains only inline content and should be <simpara>.
The statement operates as if prefixed with <literal>EXPLAIN QUERY PLAN</literal>,
returning high-level query plan information.
Available as of PHP 8.5.0.
</para>
</listitem>
</varlistentry>

</variablelist>
</section>
<!-- }}} -->

</partintro>

&reference.sqlite3.entities.sqlite3stmt;
Expand Down
3 changes: 3 additions & 0 deletions reference/sqlite3/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
<function name="SQLite3Exception" from="PHP 8 &gt;= 8.3.0"/>

<function name="SQLite3Stmt" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="SQLite3Stmt::EXPLAIN_MODE_PREPARED" from="PHP 8 &gt;= 8.5.0"/>
<function name="SQLite3Stmt::EXPLAIN_MODE_EXPLAIN" from="PHP 8 &gt;= 8.5.0"/>
<function name="SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN" from="PHP 8 &gt;= 8.5.0"/>
<function name="SQLite3Stmt::__construct" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="SQLite3Stmt::bindParam" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
<function name="SQLite3Stmt::bindValue" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
Expand Down
Loading