array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'class.sqlite3stmt.php', 1 => 'SQLite3Stmt', 2 => 'The SQLite3Stmt class', ), 'up' => array ( 0 => 'book.sqlite3.php', 1 => 'SQLite3', ), 'prev' => array ( 0 => 'class.sqlite3exception.php', 1 => 'SQLite3Exception', ), 'next' => array ( 0 => 'sqlite3stmt.bindparam.php', 1 => 'SQLite3Stmt::bindParam', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/sqlite3/sqlite3stmt.xml', ), 'history' => array ( ), 'extra_header_links' => array ( 'rel' => 'alternate', 'href' => '/manual/en/feeds/class.sqlite3stmt.atom', 'type' => 'application/atom+xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

The SQLite3Stmt class

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

Introduction

A class that handles prepared statements for the SQLite 3 extension. Instances are obtained from SQLite3::prepare(). Calling SQLite3Stmt::execute() runs the query and returns a SQLite3Result for result sets.

Class synopsis

class SQLite3Stmt {
/* Constants */
public const int EXPLAIN_MODE_PREPARED = 0;
public const int EXPLAIN_MODE_EXPLAIN = 1;
public const int EXPLAIN_MODE_EXPLAIN_QUERY_PLAN = 2;
/* Methods */
private function __construct(SQLite3 $sqlite3, string $query)
public function bindParam(string|int $param, mixed &$var, int $type = SQLITE3_TEXT): bool
public function bindValue(string|int $param, mixed $value, int $type = SQLITE3_TEXT): bool
public function busy(): bool
public function clear(): bool
public function close(): true
public function execute(): SQLite3Result|false
public function explain(): int
public function getSQL(bool $expand = false): string|false
public function paramCount(): int
public function readOnly(): bool
public function reset(): bool
public function setExplain(int $mode): bool
}

Predefined Constants

SQLite3Stmt::EXPLAIN_MODE_PREPARED

The statement operates in normal prepared statement mode (no EXPLAIN). Available as of PHP 8.5.0, when compiled against libsqlite >= 3.43.0.

SQLite3Stmt::EXPLAIN_MODE_EXPLAIN

The statement operates as if prefixed with EXPLAIN, returning opcode information from the virtual machine. Available as of PHP 8.5.0, when compiled against libsqlite >= 3.43.0.

SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN

The statement operates as if prefixed with EXPLAIN QUERY PLAN, returning high-level query plan information. Available as of PHP 8.5.0, when compiled against libsqlite >= 3.43.0.

Table of Contents