sqlite3.stub.php

<?php

/** @generate-class-entries */

/**
 * @var int
 * @cvalue PHP_SQLITE3_ASSOC
 */
const SQLITE3_ASSOC = UNKNOWN;
/**
 * @var int
 * @cvalue PHP_SQLITE3_NUM
 */
const SQLITE3_NUM = UNKNOWN;
/**
 * @var int
 * @cvalue PHP_SQLITE3_BOTH
 */
const SQLITE3_BOTH = UNKNOWN;

/**
 * @var int
 * @cvalue SQLITE_INTEGER
 */
const SQLITE3_INTEGER = UNKNOWN;
/**
 * @var int
 * @cvalue SQLITE_FLOAT
 */
const SQLITE3_FLOAT = UNKNOWN;
/**
 * @var int
 * @cvalue SQLITE3_TEXT
 */
const SQLITE3_TEXT = UNKNOWN;
/**
 * @var int
 * @cvalue SQLITE_BLOB
 */
const SQLITE3_BLOB = UNKNOWN;
/**
 * @var int
 * @cvalue SQLITE_NULL
 */
const SQLITE3_NULL = UNKNOWN;

/**
 * @var int
 * @cvalue SQLITE_OPEN_READONLY
 */
const SQLITE3_OPEN_READONLY = UNKNOWN;
/**
 * @var int
 * @cvalue SQLITE_OPEN_READWRITE
 */
const SQLITE3_OPEN_READWRITE = UNKNOWN;
/**
 * @var int
 * @cvalue SQLITE_OPEN_CREATE
 */
const SQLITE3_OPEN_CREATE = UNKNOWN;

#ifdef SQLITE_DETERMINISTIC
/**
 * @var int
 * @cvalue SQLITE_DETERMINISTIC
 */
const SQLITE3_DETERMINISTIC = UNKNOWN;
#endif

/**
 * @strict-properties
 */
class SQLite3Exception extends \Exception
{
}

/** @not-serializable */
class SQLite3
{
    /** @cvalue SQLITE_OK */
    public const int OK = UNKNOWN;

    /* Constants for authorizer return */

    /** @cvalue SQLITE_DENY */
    public const int DENY = UNKNOWN;
    /** @cvalue SQLITE_IGNORE */
    public const int IGNORE = UNKNOWN;

    /* Constants for authorizer actions */

    /** @cvalue SQLITE_CREATE_INDEX */
    public const int CREATE_INDEX = UNKNOWN;
    /** @cvalue SQLITE_CREATE_TABLE */
    public const int CREATE_TABLE = UNKNOWN;
    /** @cvalue SQLITE_CREATE_TEMP_INDEX */
    public const int CREATE_TEMP_INDEX = UNKNOWN;
    /** @cvalue SQLITE_CREATE_TEMP_TABLE */
    public const int CREATE_TEMP_TABLE = UNKNOWN;
    /** @cvalue SQLITE_CREATE_TEMP_TRIGGER */
    public const int CREATE_TEMP_TRIGGER = UNKNOWN;
    /** @cvalue SQLITE_CREATE_TEMP_VIEW */
    public const int CREATE_TEMP_VIEW = UNKNOWN;
    /** @cvalue SQLITE_CREATE_TRIGGER */
    public const int CREATE_TRIGGER = UNKNOWN;
    /** @cvalue SQLITE_CREATE_VIEW */
    public const int CREATE_VIEW = UNKNOWN;
    /** @cvalue SQLITE_DELETE */
    public const int DELETE = UNKNOWN;
    /** @cvalue SQLITE_DROP_INDEX */
    public const int DROP_INDEX = UNKNOWN;
    /** @cvalue SQLITE_DROP_TABLE */
    public const int DROP_TABLE = UNKNOWN;
    /** @cvalue SQLITE_DROP_TEMP_INDEX */
    public const int DROP_TEMP_INDEX = UNKNOWN;
    /** @cvalue SQLITE_DROP_TEMP_TABLE */
    public const int DROP_TEMP_TABLE = UNKNOWN;
    /** @cvalue SQLITE_DROP_TEMP_TRIGGER */
    public const int DROP_TEMP_TRIGGER = UNKNOWN;
    /** @cvalue SQLITE_DROP_TEMP_VIEW */
    public const int DROP_TEMP_VIEW = UNKNOWN;
    /** @cvalue SQLITE_DROP_TRIGGER */
    public const int DROP_TRIGGER = UNKNOWN;
    /** @cvalue SQLITE_DROP_VIEW */
    public const int DROP_VIEW = UNKNOWN;
    /** @cvalue SQLITE_INSERT */
    public const int INSERT = UNKNOWN;
    /** @cvalue SQLITE_PRAGMA */
    public const int PRAGMA = UNKNOWN;
    /** @cvalue SQLITE_READ */
    public const int READ = UNKNOWN;
    /** @cvalue SQLITE_SELECT */
    public const int SELECT = UNKNOWN;
    /** @cvalue SQLITE_TRANSACTION */
    public const int TRANSACTION = UNKNOWN;
    /** @cvalue SQLITE_UPDATE */
    public const int UPDATE = UNKNOWN;
    /** @cvalue SQLITE_ATTACH */
    public const int ATTACH = UNKNOWN;
    /** @cvalue SQLITE_DETACH */
    public const int DETACH = UNKNOWN;
    /** @cvalue SQLITE_ALTER_TABLE */
    public const int ALTER_TABLE = UNKNOWN;
    /** @cvalue SQLITE_REINDEX */
    public const int REINDEX = UNKNOWN;
    /** @cvalue SQLITE_ANALYZE */
    public const int ANALYZE = UNKNOWN;
    /** @cvalue SQLITE_CREATE_VTABLE */
    public const int CREATE_VTABLE = UNKNOWN;
    /** @cvalue SQLITE_DROP_VTABLE */
    public const int DROP_VTABLE = UNKNOWN;
    /** @cvalue SQLITE_FUNCTION */
    public const int FUNCTION = UNKNOWN;
    /** @cvalue SQLITE_SAVEPOINT */
    public const int SAVEPOINT = UNKNOWN;
    /** @cvalue SQLITE_COPY */
    public const int COPY = UNKNOWN;
#ifdef SQLITE_RECURSIVE
    /** @cvalue SQLITE_RECURSIVE */
    public const int RECURSIVE = UNKNOWN;
#endif

    /** @implementation-alias SQLite3::open */
    public function __construct(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = "") {}

    /**
     * @tentative-return-type
     * @todo SQLite3::open should really be static
     */
    public function open(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = ""): void {}

    /** @tentative-return-type */
    public function close(): bool {}

    /** @tentative-return-type */
    public static function version(): array {}

    /** @tentative-return-type */
    public function lastInsertRowID(): int {}

    /** @tentative-return-type */
    public function lastErrorCode(): int {}

    /** @tentative-return-type */
    public function lastExtendedErrorCode(): int {}

    /** @tentative-return-type */
    public function lastErrorMsg(): string {}

    /** @tentative-return-type */
    public function changes(): int {}

    /** @tentative-return-type */
    public function busyTimeout(int $milliseconds): bool {}

#ifndef SQLITE_OMIT_LOAD_EXTENSION
    /** @tentative-return-type */
    public function loadExtension(string $name): bool {}
#endif

#if SQLITE_VERSION_NUMBER >= 3006011
    /** @tentative-return-type */
    public function backup(SQLite3 $destination, string $sourceDatabase = "main", string $destinationDatabase = "main"): bool {}
#endif

    /** @tentative-return-type */
    public static function escapeString(string $string): string {}

    /** @tentative-return-type */
    public function prepare(string $query): SQLite3Stmt|false {}

    /** @tentative-return-type */
    public function exec(string $query): bool {}

    /** @tentative-return-type */
    public function query(string $query): SQLite3Result|false {}

    /** @tentative-return-type */
    public function querySingle(string $query, bool $entireRow = false): mixed {}

    /** @tentative-return-type */
    public function createFunction(string $name, callable $callback, int $argCount = -1, int $flags = 0): bool {}

    /** @tentative-return-type */
    public function createAggregate(string $name, callable $stepCallback, callable $finalCallback, int $argCount = -1): bool {}

    /** @tentative-return-type */
    public function createCollation(string $name, callable $callback): bool {}

    /** @return resource|false */
    public function openBlob(string $table, string $column, int $rowid, string $database = "main", int $flags = SQLITE3_OPEN_READONLY) {}

    /** @tentative-return-type */
    public function enableExceptions(bool $enable = false): bool {}

    /** @tentative-return-type */
    public function enableExtendedResultCodes(bool $enable = true): bool {}

    /** @tentative-return-type */
    public function setAuthorizer(?callable $callback): bool {}
}

/** @not-serializable */
class SQLite3Stmt
{
    private function __construct(SQLite3 $sqlite3, string $query) {}

    /** @tentative-return-type */
    public function bindParam(string|int $param, mixed &$var, int $type = SQLITE3_TEXT): bool {}

    /** @tentative-return-type */
    public function bindValue(string|int $param, mixed $value, int $type = SQLITE3_TEXT): bool {}

    /** @tentative-return-type */
    public function clear(): bool {}

    /** @tentative-return-type */
    public function close(): true {}

    /** @tentative-return-type */
    public function execute(): SQLite3Result|false {}

    /** @tentative-return-type */
    public function getSQL(bool $expand = false): string|false {}

    /** @tentative-return-type */
    public function paramCount(): int {}

    /** @tentative-return-type */
    public function readOnly(): bool {}

    /** @tentative-return-type */
    public function reset(): bool {}
}

/** @not-serializable */
class SQLite3Result
{
    private function __construct() {}

    /** @tentative-return-type */
    public function numColumns(): int {}

    /** @tentative-return-type */
    public function columnName(int $column): string|false {}

    /** @tentative-return-type */
    public function columnType(int $column): int|false {}

    /** @tentative-return-type */
    public function fetchArray(int $mode = SQLITE3_BOTH): array|false {}

    /** @tentative-return-type */
    public function reset(): bool {}

    /** @tentative-return-type */
    public function finalize(): true {}
}