* Optional flags used to determine how to open the SQLite database. By * default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE. *
** SQLITE3_OPEN_READONLY: Open the database for * reading only. *
* @param string $encryptionKey* An optional encryption key used when encrypting and decrypting an * SQLite database. *
* @return void No value is returned. */ #[TentativeType] public function open( #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $filename, #[PhpStormStubsElementAvailable(from: '5.3', to: '5.6')] $flags, #[PhpStormStubsElementAvailable(from: '5.3', to: '5.6')] $encryptionKey, #[PhpStormStubsElementAvailable(from: '7.0')] #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = SQLITE3_OPEN_READWRITE|SQLITE3_OPEN_CREATE, #[PhpStormStubsElementAvailable(from: '7.0')] #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $encryptionKey = null ): void {} /** * Closes the database connection * @link https://php.net/manual/en/sqlite3.close.php * @return bool TRUE on success, FALSE on failure. */ public function close() {} /** * Executes a result-less query against a given database * @link https://php.net/manual/en/sqlite3.exec.php * @param string $query* The SQL query to execute (typically an INSERT, UPDATE, or DELETE * query). *
* @return bool TRUE if the query succeeded, FALSE on failure. */ #[TentativeType] public function exec(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $query): bool {} /** * Returns the SQLite3 library version as a string constant and as a number * @link https://php.net/manual/en/sqlite3.version.php * @return array an associative array with the keys "versionString" and * "versionNumber". */ #[ArrayShape(["versionString" => "string", "versionNumber" => "int"])] #[TentativeType] public static function version(): array {} /** * Returns the row ID of the most recent INSERT into the database * @link https://php.net/manual/en/sqlite3.lastinsertrowid.php * @return int the row ID of the most recent INSERT into the database */ #[TentativeType] public function lastInsertRowID(): int {} /** * Returns the numeric result code of the most recent failed SQLite request * @link https://php.net/manual/en/sqlite3.lasterrorcode.php * @return int an integer value representing the numeric result code of the most * recent failed SQLite request. */ #[TentativeType] public function lastErrorCode(): int {} /** * Returns English text describing the most recent failed SQLite request * @link https://php.net/manual/en/sqlite3.lasterrormsg.php * @return string an English string describing the most recent failed SQLite request. */ #[TentativeType] public function lastErrorMsg(): string {} /** * Sets the busy connection handler * @link https://php.net/manual/en/sqlite3.busytimeout.php * @param int $milliseconds* The milliseconds to sleep. Setting this value to a value less than * or equal to zero, will turn off an already set timeout handler. *
* @return bool TRUE on success, FALSE on failure. * @since 5.3.3 */ #[TentativeType] public function busyTimeout(#[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $milliseconds): bool {} /** * Attempts to load an SQLite extension library * @link https://php.net/manual/en/sqlite3.loadextension.php * @param string $name* The name of the library to load. The library must be located in the * directory specified in the configure option sqlite3.extension_dir. *
* @return bool TRUE if the extension is successfully loaded, FALSE on failure. */ #[TentativeType] public function loadExtension(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $name): bool {} /** * Returns the number of database rows that were changed (or inserted or * deleted) by the most recent SQL statement * @link https://php.net/manual/en/sqlite3.changes.php * @return int an integer value corresponding to the number of * database rows changed (or inserted or deleted) by the most recent SQL * statement. */ #[TentativeType] public function changes(): int {} /** * Returns a string that has been properly escaped * @link https://php.net/manual/en/sqlite3.escapestring.php * @param string $string* The string to be escaped. *
* @return string a properly escaped string that may be used safely in an SQL * statement. */ #[TentativeType] public static function escapeString(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $string): string {} /** * Prepares an SQL statement for execution * @link https://php.net/manual/en/sqlite3.prepare.php * @param string $query* The SQL query to prepare. *
* @return SQLite3Stmt|false an SQLite3Stmt object on success or FALSE on failure. */ #[TentativeType] public function prepare(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $query): SQLite3Stmt|false {} /** * Executes an SQL query * @link https://php.net/manual/en/sqlite3.query.php * @param string $query* The SQL query to execute. *
* @return SQLite3Result|false an SQLite3Result object, or FALSE on failure. */ #[TentativeType] public function query(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $query): SQLite3Result|false {} /** * Executes a query and returns a single result * @link https://php.net/manual/en/sqlite3.querysingle.php * @param string $query* The SQL query to execute. *
* @param bool $entireRow [optional]* By default, querySingle returns the value of the * first column returned by the query. If * entire_row is TRUE, then it returns an array * of the entire first row. *
* @return mixed the value of the first column of results or an array of the entire * first row (if entire_row is TRUE). * ** If the query is valid but no results are returned, then NULL will be * returned if entire_row is FALSE, otherwise an * empty array is returned. *
** Invalid or failing queries will return FALSE. */ #[TentativeType] public function querySingle( #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $query, #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $entireRow = false ): mixed {} /** * Registers a PHP function for use as an SQL scalar function * @link https://php.net/manual/en/sqlite3.createfunction.php * @param string $name
* Name of the SQL function to be created or redefined. *
* @param mixed $callback* The name of a PHP function or user-defined function to apply as a * callback, defining the behavior of the SQL function. *
* @param int $argCount* The number of arguments that the SQL function takes. If * this parameter is negative, then the SQL function may take * any number of arguments. *
* @param int $flags *A bitwise conjunction of flags. * Currently, only SQLITE3_DETERMINISTIC is supported, which specifies that the function always returns * the same result given the same inputs within a single SQL statement.
* @return bool TRUE upon successful creation of the function, FALSE on failure. */ #[TentativeType] public function createFunction( #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $name, #[LanguageLevelTypeAware(['8.0' => 'callable'], default: '')] $callback, #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $argCount = -1, #[PhpStormStubsElementAvailable(from: '7.1')] int $flags = 0 ): bool {} /** * Registers a PHP function for use as an SQL aggregate function * @link https://php.net/manual/en/sqlite3.createaggregate.php * @param string $name* Name of the SQL aggregate to be created or redefined. *
* @param mixed $stepCallback* The name of a PHP function or user-defined function to apply as a * callback for every item in the aggregate. *
* @param mixed $finalCallback* The name of a PHP function or user-defined function to apply as a * callback at the end of the aggregate data. *
* @param int $argCount [optional]* The number of arguments that the SQL aggregate takes. If * this parameter is negative, then the SQL aggregate may take * any number of arguments. *
* @return bool TRUE upon successful creation of the aggregate, FALSE on * failure. */ #[TentativeType] public function createAggregate( #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $name, #[LanguageLevelTypeAware(['8.0' => 'callable'], default: '')] $stepCallback, #[LanguageLevelTypeAware(['8.0' => 'callable'], default: '')] $finalCallback, #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $argCount = -1 ): bool {} /** * Registers a PHP function for use as an SQL collating function * @link https://php.net/manual/en/sqlite3.createcollation.php * @param string $name* Name of the SQL collating function to be created or redefined *
* @param callable $callback* The name of a PHP function or user-defined function to apply as a * callback, defining the behavior of the collation. It should accept two * strings and return as strcmp does, i.e. it should * return -1, 1, or 0 if the first string sorts before, sorts after, or is * equal to the second. *
* @return bool TRUE on success or FALSE on failure. * @since 5.3.11 */ #[TentativeType] public function createCollation(#[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $name, callable $callback): bool {} /** * Opens a stream resource to read a BLOB * @link https://php.net/manual/en/sqlite3.openblob.php * @param string $tableThe table name.
* @param string $columnThe column name.
* @param int $rowidThe row ID.
* @param string $database [optional]The symbolic name of the DB
* @param int $flags [optional] *Either SQLITE3_OPEN_READONLY or SQLITE3_OPEN_READWRITE to open the stream for reading only, or for reading and writing, respectively.
* @return resource|false Returns a stream resource, or FALSE on failure. */ public function openBlob( #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $table, #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $column, #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $rowid, #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $database = 'main', #[PhpStormStubsElementAvailable(from: '7.2')] int $flags = SQLITE3_OPEN_READONLY ) {} /** * Enable throwing exceptions * @link https://www.php.net/manual/en/sqlite3.enableexceptions * @param bool $enable * @return bool Returns the old value; true if exceptions were enabled, false otherwise. */ #[TentativeType] public function enableExceptions( #[PhpStormStubsElementAvailable(from: '5.3', to: '5.6')] $enable, #[PhpStormStubsElementAvailable(from: '7.0')] #[LanguageLevelTypeAware(['8.0' => 'bool'], default: '')] $enable = false ): bool {} /** * Instantiates an SQLite3 object and opens an SQLite 3 database * @link https://php.net/manual/en/sqlite3.construct.php * @param string $filename* Path to the SQLite database, or :memory: to use in-memory database. *
* @param int $flags* Optional flags used to determine how to open the SQLite database. By * default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE. *
** SQLITE3_OPEN_READONLY: Open the database for * reading only. *
* @param string $encryptionKey* An optional encryption key used when encrypting and decrypting an * SQLite database. *
*/ public function __construct( #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $filename, #[PhpStormStubsElementAvailable(from: '5.3', to: '5.6')] $flags, #[PhpStormStubsElementAvailable(from: '5.3', to: '5.6')] $encryptionKey, #[PhpStormStubsElementAvailable(from: '7.0')] #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $flags = SQLITE3_OPEN_READWRITE|SQLITE3_OPEN_CREATE, #[PhpStormStubsElementAvailable(from: '7.0')] #[LanguageLevelTypeAware(['8.0' => 'string'], default: '')] $encryptionKey = null ) {} /** * @return int * @since 7.4 */ #[TentativeType] public function lastExtendedErrorCode(): int {} /** * @param bool $enable * @since 7.4 */ #[TentativeType] public function enableExtendedResultCodes( #[PhpStormStubsElementAvailable(from: '7.4', to: '7.4')] bool $enable, #[PhpStormStubsElementAvailable(from: '8.0')] bool $enable = true ): bool {} /** * @param SQLite3 $destination * @param string $sourceDatabase * @param string $destinationDatabase * @return bool * @since 7.4 */ #[TentativeType] public function backup(SQLite3 $destination, string $sourceDatabase = 'main', string $destinationDatabase = 'main'): bool {} /** * @param null|callable $callback * @return bool * @since 8.0 */ #[TentativeType] public function setAuthorizer(?callable $callback): bool {} } /** * A class that handles prepared statements for the SQLite 3 extension. * @link https://php.net/manual/en/class.sqlite3stmt.php */ class SQLite3Stmt { /** * Returns the number of parameters within the prepared statement * @link https://php.net/manual/en/sqlite3stmt.paramcount.php * @return int the number of parameters within the prepared statement. */ #[TentativeType] public function paramCount(): int {} /** * Closes the prepared statement * @link https://php.net/manual/en/sqlite3stmt.close.php * @return bool TRUE */ #[TentativeType] public function close(): bool {} /** * Resets the prepared statement * @link https://php.net/manual/en/sqlite3stmt.reset.php * @return bool TRUE if the statement is successfully reset, FALSE on failure. */ #[TentativeType] public function reset(): bool {} /** * Clears all current bound parameters * @link https://php.net/manual/en/sqlite3stmt.clear.php * @return bool TRUE on successful clearing of bound parameters, FALSE on * failure. */ #[TentativeType] public function clear(): bool {} /** * Executes a prepared statement and returns a result set object * @link https://php.net/manual/en/sqlite3stmt.execute.php * @return SQLite3Result|false an SQLite3Result object on successful execution of the prepared * statement, FALSE on failure. */ #[TentativeType] public function execute(): SQLite3Result|false {} /** * Binds a parameter to a statement variable * @link https://php.net/manual/en/sqlite3stmt.bindparam.php * @param string $param* An string identifying the statement variable to which the * parameter should be bound. *
* @param mixed &$var* The parameter to bind to a statement variable. *
* @param int $type [optional]* The data type of the parameter to bind. *
** SQLITE3_INTEGER: The value is a signed integer, * stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of * the value. *
* @return bool TRUE if the parameter is bound to the statement variable, FALSE * on failure. */ #[TentativeType] public function bindParam( #[LanguageLevelTypeAware(['8.0' => 'string|int'], default: '')] $param, #[LanguageLevelTypeAware(['8.0' => 'mixed'], default: '')] &$var, #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $type = SQLITE3_TEXT ): bool {} /** * Binds the value of a parameter to a statement variable * @link https://php.net/manual/en/sqlite3stmt.bindvalue.php * @param string $param* An string identifying the statement variable to which the * value should be bound. *
* @param mixed $value* The value to bind to a statement variable. *
* @param int $type [optional]* The data type of the value to bind. *
** SQLITE3_INTEGER: The value is a signed integer, * stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of * the value. *
* @return bool TRUE if the value is bound to the statement variable, FALSE * on failure. */ #[TentativeType] public function bindValue( #[LanguageLevelTypeAware(['8.0' => 'string|int'], default: '')] $param, #[LanguageLevelTypeAware(['8.0' => 'mixed'], default: '')] $value, #[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $type = SQLITE3_TEXT ): bool {} #[TentativeType] public function readOnly(): bool {} /** * @param SQLite3 $sqlite3 * @param string $query */ private function __construct( #[LanguageLevelTypeAware(['8.0' => 'SQLite3'], default: '')] $sqlite3, #[PhpStormStubsElementAvailable(from: '8.0')] string $query ) {} /** * Retrieves the SQL of the prepared statement. If expanded is FALSE, the unmodified SQL is retrieved. * If expanded is TRUE, all query parameters are replaced with their bound values, or with an SQL NULL, if not already bound. * @param bool $expand Whether to retrieve the expanded SQL. Passing TRUE is only supported as of libsqlite 3.14. * @return string|false Returns the SQL of the prepared statement, or FALSE on failure. * @since 7.4 */ #[TentativeType] public function getSQL(bool $expand = false): string|false {} } /** * A class that handles result sets for the SQLite 3 extension. * @link https://php.net/manual/en/class.sqlite3result.php */ class SQLite3Result { /** * Returns the number of columns in the result set * @link https://php.net/manual/en/sqlite3result.numcolumns.php * @return int the number of columns in the result set. */ #[TentativeType] public function numColumns(): int {} /** * Returns the name of the nth column * @link https://php.net/manual/en/sqlite3result.columnname.php * @param int $column* The numeric zero-based index of the column. *
* @return string|false the string name of the column identified by * column_number. */ #[TentativeType] public function columnName(#[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $column): string|false {} /** * Returns the type of the nth column * @link https://php.net/manual/en/sqlite3result.columntype.php * @param int $column* The numeric zero-based index of the column. *
* @return int|false the data type index of the column identified by * column_number (one of * SQLITE3_INTEGER, SQLITE3_FLOAT, * SQLITE3_TEXT, SQLITE3_BLOB, or * SQLITE3_NULL). */ #[TentativeType] public function columnType(#[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $column): int|false {} /** * Fetches a result row as an associative or numerically indexed array or both * @link https://php.net/manual/en/sqlite3result.fetcharray.php * @param int $mode [optional]* Controls how the next row will be returned to the caller. This value * must be one of either SQLITE3_ASSOC, * SQLITE3_NUM, or SQLITE3_BOTH. *
** SQLITE3_ASSOC: returns an array indexed by column * name as returned in the corresponding result set *
* @return array|false a result row as an associatively or numerically indexed array or * both. Alternately will return FALSE if there are no more rows. */ #[TentativeType] public function fetchArray(#[LanguageLevelTypeAware(['8.0' => 'int'], default: '')] $mode = SQLITE3_BOTH): array|false {} /** * Resets the result set back to the first row * @link https://php.net/manual/en/sqlite3result.reset.php * @return bool TRUE if the result set is successfully reset * back to the first row, FALSE on failure. */ #[TentativeType] public function reset(): bool {} /** * Closes the result set * @link https://php.net/manual/en/sqlite3result.finalize.php * @return bool TRUE. */ public function finalize() {} private function __construct() {} } /** * Specifies that the Sqlite3Result::fetchArray * method shall return an array indexed by column name as returned in the * corresponding result set. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_ASSOC', 1); /** * Specifies that the Sqlite3Result::fetchArray * method shall return an array indexed by column number as returned in the * corresponding result set, starting at column 0. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_NUM', 2); /** * Specifies that the Sqlite3Result::fetchArray * method shall return an array indexed by both column name and number as * returned in the corresponding result set, starting at column 0. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_BOTH', 3); /** * Represents the SQLite3 INTEGER storage class. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_INTEGER', 1); /** * Represents the SQLite3 REAL (FLOAT) storage class. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_FLOAT', 2); /** * Represents the SQLite3 TEXT storage class. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_TEXT', 3); /** * Represents the SQLite3 BLOB storage class. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_BLOB', 4); /** * Represents the SQLite3 NULL storage class. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_NULL', 5); /** * Specifies that the SQLite3 database be opened for reading only. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_OPEN_READONLY', 1); /** * Specifies that the SQLite3 database be opened for reading and writing. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_OPEN_READWRITE', 2); /** * Specifies that the SQLite3 database be created if it does not already * exist. * @link https://php.net/manual/en/sqlite3.constants.php */ define('SQLITE3_OPEN_CREATE', 4); /** * Specifies that a function created with {@see SQLite3::createFunction()} is deterministic, * i.e. it always returns the same result given the same inputs within a single SQL statement. * @since 7.1.4 * @link https://php.net/manual/en/sqlite.constants.php */ define('SQLITE3_DETERMINISTIC', 2048); // End of sqlite3 v.0.7-dev