php-internal-docs 8.4.8
Unofficial docs for php/php-src
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
SQLite3 Class Reference

Public Member Functions

 __construct (string $filename, int $flags=SQLITE3_OPEN_READWRITE|SQLITE3_OPEN_CREATE, string $encryptionKey="")
 
 open (string $filename, int $flags=SQLITE3_OPEN_READWRITE|SQLITE3_OPEN_CREATE, string $encryptionKey="")
 
 close ()
 
 lastInsertRowID ()
 
 lastErrorCode ()
 
 lastExtendedErrorCode ()
 
 lastErrorMsg ()
 
 changes ()
 
 busyTimeout (int $milliseconds)
 
 loadExtension (string $name)
 
 backup (SQLite3 $destination, string $sourceDatabase="main", string $destinationDatabase="main")
 
 prepare (string $query)
 
 exec (string $query)
 
 query (string $query)
 
 querySingle (string $query, bool $entireRow=false)
 
 createFunction (string $name, callable $callback, int $argCount=-1, int $flags=0)
 
 createAggregate (string $name, callable $stepCallback, callable $finalCallback, int $argCount=-1)
 
 createCollation (string $name, callable $callback)
 
 openBlob (string $table, string $column, int $rowid, string $database="main", int $flags=SQLITE3_OPEN_READONLY)
 
 enableExceptions (bool $enable=false)
 
 enableExtendedResultCodes (bool $enable=true)
 
 setAuthorizer (?callable $callback)
 

Static Public Member Functions

static version ()
 
static escapeString (string $string)
 

Data Fields

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

Detailed Description

@not-serializable

Definition at line 79 of file sqlite3.stub.php.

Constructor & Destructor Documentation

◆ __construct()

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

@implementation-alias SQLite3\open

Definition at line 165 of file sqlite3.stub.php.

Member Function Documentation

◆ backup()

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

@tentative-return-type

Definition at line 204 of file sqlite3.stub.php.

◆ busyTimeout()

SQLite3::busyTimeout ( int $milliseconds)

@tentative-return-type

Definition at line 195 of file sqlite3.stub.php.

◆ changes()

SQLite3::changes ( )

@tentative-return-type

Definition at line 192 of file sqlite3.stub.php.

◆ close()

SQLite3::close ( )

@tentative-return-type

Definition at line 174 of file sqlite3.stub.php.

◆ createAggregate()

SQLite3::createAggregate ( string $name,
callable $stepCallback,
callable $finalCallback,
int $argCount = -1 )

@tentative-return-type

Definition at line 226 of file sqlite3.stub.php.

◆ createCollation()

SQLite3::createCollation ( string $name,
callable $callback )

@tentative-return-type

Definition at line 229 of file sqlite3.stub.php.

◆ createFunction()

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

@tentative-return-type

Definition at line 223 of file sqlite3.stub.php.

◆ enableExceptions()

SQLite3::enableExceptions ( bool $enable = false)

@tentative-return-type

Definition at line 235 of file sqlite3.stub.php.

◆ enableExtendedResultCodes()

SQLite3::enableExtendedResultCodes ( bool $enable = true)

@tentative-return-type

Definition at line 238 of file sqlite3.stub.php.

◆ escapeString()

static SQLite3::escapeString ( string $string)
static

@tentative-return-type

Definition at line 208 of file sqlite3.stub.php.

◆ exec()

SQLite3::exec ( string $query)

@tentative-return-type

Definition at line 214 of file sqlite3.stub.php.

◆ lastErrorCode()

SQLite3::lastErrorCode ( )

@tentative-return-type

Definition at line 183 of file sqlite3.stub.php.

◆ lastErrorMsg()

SQLite3::lastErrorMsg ( )

@tentative-return-type

Definition at line 189 of file sqlite3.stub.php.

◆ lastExtendedErrorCode()

SQLite3::lastExtendedErrorCode ( )

@tentative-return-type

Definition at line 186 of file sqlite3.stub.php.

◆ lastInsertRowID()

SQLite3::lastInsertRowID ( )

@tentative-return-type

Definition at line 180 of file sqlite3.stub.php.

◆ loadExtension()

SQLite3::loadExtension ( string $name)

@tentative-return-type

Definition at line 199 of file sqlite3.stub.php.

◆ open()

SQLite3::open ( string $filename,
int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE,
string $encryptionKey = "" )

@tentative-return-type

Todo
SQLite3\open should really be static

Definition at line 171 of file sqlite3.stub.php.

◆ openBlob()

SQLite3::openBlob ( string $table,
string $column,
int $rowid,
string $database = "main",
int $flags = SQLITE3_OPEN_READONLY )
Returns
resource|false

Definition at line 232 of file sqlite3.stub.php.

◆ prepare()

SQLite3::prepare ( string $query)

@tentative-return-type

Definition at line 211 of file sqlite3.stub.php.

◆ query()

SQLite3::query ( string $query)

@tentative-return-type

Definition at line 217 of file sqlite3.stub.php.

◆ querySingle()

SQLite3::querySingle ( string $query,
bool $entireRow = false )

@tentative-return-type

Definition at line 220 of file sqlite3.stub.php.

◆ setAuthorizer()

SQLite3::setAuthorizer ( ?callable $callback)

@tentative-return-type

Definition at line 241 of file sqlite3.stub.php.

◆ version()

static SQLite3::version ( )
static

@tentative-return-type

Definition at line 177 of file sqlite3.stub.php.

Field Documentation

◆ ALTER_TABLE

const int SQLite3::ALTER_TABLE = UNKNOWN

@cvalue SQLITE_ALTER_TABLE

Definition at line 144 of file sqlite3.stub.php.

◆ ANALYZE

const int SQLite3::ANALYZE = UNKNOWN

@cvalue SQLITE_ANALYZE

Definition at line 148 of file sqlite3.stub.php.

◆ ATTACH

const int SQLite3::ATTACH = UNKNOWN

@cvalue SQLITE_ATTACH

Definition at line 140 of file sqlite3.stub.php.

◆ COPY

const int SQLite3::COPY = UNKNOWN

@cvalue SQLITE_COPY

Definition at line 158 of file sqlite3.stub.php.

◆ CREATE_INDEX

const int SQLite3::CREATE_INDEX = UNKNOWN

@cvalue SQLITE_CREATE_INDEX

Definition at line 94 of file sqlite3.stub.php.

◆ CREATE_TABLE

const int SQLite3::CREATE_TABLE = UNKNOWN

@cvalue SQLITE_CREATE_TABLE

Definition at line 96 of file sqlite3.stub.php.

◆ CREATE_TEMP_INDEX

const int SQLite3::CREATE_TEMP_INDEX = UNKNOWN

@cvalue SQLITE_CREATE_TEMP_INDEX

Definition at line 98 of file sqlite3.stub.php.

◆ CREATE_TEMP_TABLE

const int SQLite3::CREATE_TEMP_TABLE = UNKNOWN

@cvalue SQLITE_CREATE_TEMP_TABLE

Definition at line 100 of file sqlite3.stub.php.

◆ CREATE_TEMP_TRIGGER

const int SQLite3::CREATE_TEMP_TRIGGER = UNKNOWN

@cvalue SQLITE_CREATE_TEMP_TRIGGER

Definition at line 102 of file sqlite3.stub.php.

◆ CREATE_TEMP_VIEW

const int SQLite3::CREATE_TEMP_VIEW = UNKNOWN

@cvalue SQLITE_CREATE_TEMP_VIEW

Definition at line 104 of file sqlite3.stub.php.

◆ CREATE_TRIGGER

const int SQLite3::CREATE_TRIGGER = UNKNOWN

@cvalue SQLITE_CREATE_TRIGGER

Definition at line 106 of file sqlite3.stub.php.

◆ CREATE_VIEW

const int SQLite3::CREATE_VIEW = UNKNOWN

@cvalue SQLITE_CREATE_VIEW

Definition at line 108 of file sqlite3.stub.php.

◆ CREATE_VTABLE

const int SQLite3::CREATE_VTABLE = UNKNOWN

@cvalue SQLITE_CREATE_VTABLE

Definition at line 150 of file sqlite3.stub.php.

◆ DELETE

const int SQLite3::DELETE = UNKNOWN

@cvalue SQLITE_DELETE

Definition at line 110 of file sqlite3.stub.php.

◆ DENY

const int SQLite3::DENY = UNKNOWN

@cvalue SQLITE_DENY

Definition at line 87 of file sqlite3.stub.php.

◆ DETACH

const int SQLite3::DETACH = UNKNOWN

@cvalue SQLITE_DETACH

Definition at line 142 of file sqlite3.stub.php.

◆ DROP_INDEX

const int SQLite3::DROP_INDEX = UNKNOWN

@cvalue SQLITE_DROP_INDEX

Definition at line 112 of file sqlite3.stub.php.

◆ DROP_TABLE

const int SQLite3::DROP_TABLE = UNKNOWN

@cvalue SQLITE_DROP_TABLE

Definition at line 114 of file sqlite3.stub.php.

◆ DROP_TEMP_INDEX

const int SQLite3::DROP_TEMP_INDEX = UNKNOWN

@cvalue SQLITE_DROP_TEMP_INDEX

Definition at line 116 of file sqlite3.stub.php.

◆ DROP_TEMP_TABLE

const int SQLite3::DROP_TEMP_TABLE = UNKNOWN

@cvalue SQLITE_DROP_TEMP_TABLE

Definition at line 118 of file sqlite3.stub.php.

◆ DROP_TEMP_TRIGGER

const int SQLite3::DROP_TEMP_TRIGGER = UNKNOWN

@cvalue SQLITE_DROP_TEMP_TRIGGER

Definition at line 120 of file sqlite3.stub.php.

◆ DROP_TEMP_VIEW

const int SQLite3::DROP_TEMP_VIEW = UNKNOWN

@cvalue SQLITE_DROP_TEMP_VIEW

Definition at line 122 of file sqlite3.stub.php.

◆ DROP_TRIGGER

const int SQLite3::DROP_TRIGGER = UNKNOWN

@cvalue SQLITE_DROP_TRIGGER

Definition at line 124 of file sqlite3.stub.php.

◆ DROP_VIEW

const int SQLite3::DROP_VIEW = UNKNOWN

@cvalue SQLITE_DROP_VIEW

Definition at line 126 of file sqlite3.stub.php.

◆ DROP_VTABLE

const int SQLite3::DROP_VTABLE = UNKNOWN

@cvalue SQLITE_DROP_VTABLE

Definition at line 152 of file sqlite3.stub.php.

◆ FUNCTION

const int SQLite3::FUNCTION = UNKNOWN

@cvalue SQLITE_FUNCTION

Definition at line 154 of file sqlite3.stub.php.

◆ IGNORE

const int SQLite3::IGNORE = UNKNOWN

@cvalue SQLITE_IGNORE

Definition at line 89 of file sqlite3.stub.php.

◆ INSERT

const int SQLite3::INSERT = UNKNOWN

@cvalue SQLITE_INSERT

Definition at line 128 of file sqlite3.stub.php.

◆ OK

const int SQLite3::OK = UNKNOWN

@cvalue SQLITE_OK

Definition at line 82 of file sqlite3.stub.php.

◆ PRAGMA

const int SQLite3::PRAGMA = UNKNOWN

@cvalue SQLITE_PRAGMA

Definition at line 130 of file sqlite3.stub.php.

◆ READ

const int SQLite3::READ = UNKNOWN

@cvalue SQLITE_READ

Definition at line 132 of file sqlite3.stub.php.

◆ RECURSIVE

const int SQLite3::RECURSIVE = UNKNOWN

@cvalue SQLITE_RECURSIVE

Definition at line 161 of file sqlite3.stub.php.

◆ REINDEX

const int SQLite3::REINDEX = UNKNOWN

@cvalue SQLITE_REINDEX

Definition at line 146 of file sqlite3.stub.php.

◆ SAVEPOINT

const int SQLite3::SAVEPOINT = UNKNOWN

@cvalue SQLITE_SAVEPOINT

Definition at line 156 of file sqlite3.stub.php.

◆ SELECT

const int SQLite3::SELECT = UNKNOWN

@cvalue SQLITE_SELECT

Definition at line 134 of file sqlite3.stub.php.

◆ TRANSACTION

const int SQLite3::TRANSACTION = UNKNOWN

@cvalue SQLITE_TRANSACTION

Definition at line 136 of file sqlite3.stub.php.

◆ UPDATE

const int SQLite3::UPDATE = UNKNOWN

@cvalue SQLITE_UPDATE

Definition at line 138 of file sqlite3.stub.php.

The documentation for this class was generated from the following file: