The SQLite3 class

Introduction

A class that interfaces SQLite 3 databases.

Class synopsis

SQLite3

/* Constants */

public const int SQLite3::OK;

public const int SQLite3::DENY;

public const int SQLite3::IGNORE;

public const int SQLite3::CREATE_INDEX;

public const int SQLite3::CREATE_TABLE;

public const int SQLite3::CREATE_TEMP_INDEX;

public const int SQLite3::CREATE_TEMP_TABLE;

public const int SQLite3::CREATE_TEMP_TRIGGER;

public const int SQLite3::CREATE_TEMP_VIEW;

public const int SQLite3::CREATE_TRIGGER;

public const int SQLite3::CREATE_VIEW;

public const int SQLite3::DELETE;

public const int SQLite3::DROP_INDEX;

public const int SQLite3::DROP_TABLE;

public const int SQLite3::DROP_TEMP_INDEX;

public const int SQLite3::DROP_TEMP_TABLE;

public const int SQLite3::DROP_TEMP_TRIGGER;

public const int SQLite3::DROP_TEMP_VIEW;

public const int SQLite3::DROP_TRIGGER;

public const int SQLite3::DROP_VIEW;

public const int SQLite3::INSERT;

public const int SQLite3::PRAGMA;

public const int SQLite3::READ;

public const int SQLite3::SELECT;

public const int SQLite3::TRANSACTION;

public const int SQLite3::UPDATE;

public const int SQLite3::ATTACH;

public const int SQLite3::DETACH;

public const int SQLite3::ALTER_TABLE;

public const int SQLite3::REINDEX;

public const int SQLite3::ANALYZE;

public const int SQLite3::CREATE_VTABLE;

public const int SQLite3::DROP_VTABLE;

public const int SQLite3::FUNCTION;

public const int SQLite3::SAVEPOINT;

public const int SQLite3::COPY;

public const int SQLite3::RECURSIVE;

/* Methods */

public __construct(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = "")

public bool backup(SQLite3 $destination, string $sourceDatabase = "main", string $destinationDatabase = "main")

public bool busyTimeout(int $milliseconds)

public int changes()

public bool close()

public bool createAggregate(
    string $name,
    callable $stepCallback,
    callable $finalCallback,
    int $argCount = -1
)

public bool createCollation(string $name, callable $callback)

public bool createFunction(
    string $name,
    callable $callback,
    int $argCount = -1,
    int $flags = 0
)

public bool enableExceptions(bool $enable = false)

public static string escapeString(string $string)

public bool exec(string $query)

public int lastErrorCode()

public string lastErrorMsg()

public int lastInsertRowID()

public bool loadExtension(string $name)

public void open(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = "")

public resourcefalse openBlob(
    string $table,
    string $column,
    int $rowid,
    string $database = "main",
    int $flags = SQLITE3_OPEN_READONLY
)

public SQLite3Stmtfalse prepare(string $query)

public SQLite3Resultfalse query(string $query)

public mixed querySingle(string $query, bool $entireRow = false)

public bool setAuthorizer(callablenull $callback)

public static array version()

Predefined Constants

SQLite3::OK
SQLite3::DENY
SQLite3::IGNORE
SQLite3::CREATE_INDEX
SQLite3::CREATE_TABLE
SQLite3::CREATE_TEMP_INDEX
SQLite3::CREATE_TEMP_TABLE
SQLite3::CREATE_TEMP_TRIGGER
SQLite3::CREATE_TEMP_VIEW
SQLite3::CREATE_TRIGGER
SQLite3::CREATE_VIEW
SQLite3::DELETE
SQLite3::DROP_INDEX
SQLite3::DROP_TABLE
SQLite3::DROP_TEMP_INDEX
SQLite3::DROP_TEMP_TABLE
SQLite3::DROP_TEMP_TRIGGER
SQLite3::DROP_TEMP_VIEW
SQLite3::DROP_TRIGGER
SQLite3::DROP_VIEW
SQLite3::INSERT
SQLite3::PRAGMA
SQLite3::READ
SQLite3::SELECT
SQLite3::TRANSACTION
SQLite3::UPDATE
SQLite3::ATTACH
SQLite3::DETACH
SQLite3::ALTER_TABLE
SQLite3::REINDEX
SQLite3::ANALYZE
SQLite3::CREATE_VTABLE
SQLite3::DROP_VTABLE
SQLite3::FUNCTION
SQLite3::SAVEPOINT
SQLite3::COPY
SQLite3::RECURSIVE

Table of Contents

SQLite3::backup — Backup one database to another database
SQLite3::busyTimeout — Sets the busy connection handler
SQLite3::changes — Returns the number of database rows that were changed (or inserted or deleted) by the most recent SQL statement
SQLite3::close — Closes the database connection
SQLite3::__construct — Instantiates an SQLite3 object and opens an SQLite 3 database
SQLite3::createAggregate — Registers a PHP function for use as an SQL aggregate function
SQLite3::createCollation — Registers a PHP function for use as an SQL collating function
SQLite3::createFunction — Registers a PHP function for use as an SQL scalar function
SQLite3::enableExceptions — Enable throwing exceptions
SQLite3::escapeString — Returns a string that has been properly escaped
SQLite3::exec — Executes a result-less query against a given database
SQLite3::lastErrorCode — Returns the numeric result code of the most recent failed SQLite request
SQLite3::lastErrorMsg — Returns English text describing the most recent failed SQLite request
SQLite3::lastInsertRowID — Returns the row ID of the most recent INSERT into the database
SQLite3::loadExtension — Attempts to load an SQLite extension library
SQLite3::open — Opens an SQLite database
SQLite3::openBlob — Opens a stream resource to read a BLOB
SQLite3::prepare — Prepares an SQL statement for execution
SQLite3::query — Executes an SQL query
SQLite3::querySingle — Executes a query and returns a single result
SQLite3::setAuthorizer — Configures a callback to be used as an authorizer to limit what a statement can do
SQLite3::version — Returns the SQLite3 library version as a string constant and as a number