pgsql.stub.php

Go to the documentation of this file.

<?php

 
namespace {
    /* libpq version */

    const PGSQL_LIBPQ_VERSION = UNKNOWN;
    const PGSQL_LIBPQ_VERSION_STR = UNKNOWN;
 
    /* For connection option */

    const PGSQL_CONNECT_FORCE_NEW = UNKNOWN;
    const PGSQL_CONNECT_ASYNC = UNKNOWN;
 
    /* For pg_fetch_array() */

    const PGSQL_ASSOC = UNKNOWN;
    const PGSQL_NUM = UNKNOWN;
    const PGSQL_BOTH = UNKNOWN;
 
    /* For pg_last_notice() */

    const PGSQL_NOTICE_LAST = UNKNOWN;
    const PGSQL_NOTICE_ALL = UNKNOWN;
    const PGSQL_NOTICE_CLEAR = UNKNOWN;
 
    /* For pg_connection_status() */

    const PGSQL_CONNECTION_BAD = UNKNOWN;
    const PGSQL_CONNECTION_OK = UNKNOWN;
    const PGSQL_CONNECTION_STARTED = UNKNOWN;
    const PGSQL_CONNECTION_MADE = UNKNOWN;
    const PGSQL_CONNECTION_AWAITING_RESPONSE = UNKNOWN;
    const PGSQL_CONNECTION_AUTH_OK = UNKNOWN;
#ifdef CONNECTION_SSL_STARTUP
    const PGSQL_CONNECTION_SSL_STARTUP = UNKNOWN;
#endif
    const PGSQL_CONNECTION_SETENV = UNKNOWN;
 
    /* For pg_connect_poll() */
    const PGSQL_POLLING_FAILED = UNKNOWN;
    const PGSQL_POLLING_READING = UNKNOWN;
    const PGSQL_POLLING_WRITING = UNKNOWN;
    const PGSQL_POLLING_OK = UNKNOWN;
    const PGSQL_POLLING_ACTIVE = UNKNOWN;
 
    /* For pg_transaction_status() */

    const PGSQL_TRANSACTION_IDLE = UNKNOWN;
    const PGSQL_TRANSACTION_ACTIVE = UNKNOWN;
    const PGSQL_TRANSACTION_INTRANS = UNKNOWN;
    const PGSQL_TRANSACTION_INERROR = UNKNOWN;
    const PGSQL_TRANSACTION_UNKNOWN = UNKNOWN;
 
    /* For pg_set_error_verbosity() */

    const PGSQL_ERRORS_TERSE = UNKNOWN;
    const PGSQL_ERRORS_DEFAULT = UNKNOWN;
    const PGSQL_ERRORS_VERBOSE = UNKNOWN;
    #ifdef HAVE_PQERRORS_SQLSTATE
    const PGSQL_ERRORS_SQLSTATE = UNKNOWN;
    #else
    const PGSQL_ERRORS_SQLSTATE = UNKNOWN;
    #endif
 
    /* For lo_seek() */

    const PGSQL_SEEK_SET = UNKNOWN;
    const PGSQL_SEEK_CUR = UNKNOWN;
    const PGSQL_SEEK_END = UNKNOWN;
 
    /* For pg_result_status() return value type */

    const PGSQL_STATUS_LONG = UNKNOWN;
    const PGSQL_STATUS_STRING = UNKNOWN;
 
    /* For pg_result_status() return value */

    const PGSQL_EMPTY_QUERY = UNKNOWN;
    const PGSQL_COMMAND_OK = UNKNOWN;
    const PGSQL_TUPLES_OK = UNKNOWN;
#ifdef HAVE_PG_SET_CHUNKED_ROWS_SIZE
    const PGSQL_TUPLES_CHUNK = UNKNOWN;
#endif
    const PGSQL_COPY_OUT = UNKNOWN;
    const PGSQL_COPY_IN = UNKNOWN;
    const PGSQL_BAD_RESPONSE = UNKNOWN;
    const PGSQL_NONFATAL_ERROR = UNKNOWN;
    const PGSQL_FATAL_ERROR = UNKNOWN;
 
    /* For pg_result_error_field() field codes */

    const PGSQL_DIAG_SEVERITY = UNKNOWN;
    const PGSQL_DIAG_SQLSTATE = UNKNOWN;
    const PGSQL_DIAG_MESSAGE_PRIMARY = UNKNOWN;
    const PGSQL_DIAG_MESSAGE_DETAIL = UNKNOWN;
    const PGSQL_DIAG_MESSAGE_HINT = UNKNOWN;
    const PGSQL_DIAG_STATEMENT_POSITION = UNKNOWN;
#ifdef PG_DIAG_INTERNAL_POSITION
    const PGSQL_DIAG_INTERNAL_POSITION = UNKNOWN;
#endif
#ifdef PG_DIAG_INTERNAL_QUERY
    const PGSQL_DIAG_INTERNAL_QUERY = UNKNOWN;
#endif
    const PGSQL_DIAG_CONTEXT = UNKNOWN;
    const PGSQL_DIAG_SOURCE_FILE = UNKNOWN;
    const PGSQL_DIAG_SOURCE_LINE = UNKNOWN;
    const PGSQL_DIAG_SOURCE_FUNCTION = UNKNOWN;
#ifdef PG_DIAG_SCHEMA_NAME
    const PGSQL_DIAG_SCHEMA_NAME = UNKNOWN;
#endif
#ifdef PG_DIAG_TABLE_NAME
    const PGSQL_DIAG_TABLE_NAME = UNKNOWN;
#endif
#ifdef PG_DIAG_COLUMN_NAME
    const PGSQL_DIAG_COLUMN_NAME = UNKNOWN;
#endif
#ifdef PG_DIAG_DATATYPE_NAME
    const PGSQL_DIAG_DATATYPE_NAME = UNKNOWN;
#endif
#ifdef PG_DIAG_CONSTRAINT_NAME
    const PGSQL_DIAG_CONSTRAINT_NAME = UNKNOWN;
#endif
#ifdef PG_DIAG_SEVERITY_NONLOCALIZED
    const PGSQL_DIAG_SEVERITY_NONLOCALIZED = UNKNOWN;
#endif
 
    /* pg_convert options */

    const PGSQL_CONV_IGNORE_DEFAULT = UNKNOWN;
    const PGSQL_CONV_FORCE_NULL = UNKNOWN;
    const PGSQL_CONV_IGNORE_NOT_NULL = UNKNOWN;
 
    /* pg_insert/update/delete/select options */

    const PGSQL_DML_ESCAPE = UNKNOWN;
    const PGSQL_DML_NO_CONV = UNKNOWN;
    const PGSQL_DML_EXEC = UNKNOWN;
    const PGSQL_DML_ASYNC = UNKNOWN;
    const PGSQL_DML_STRING = UNKNOWN;
#ifdef PQTRACE_SUPPPRESS_TIMESTAMPS
    const PGSQL_TRACE_SUPPRESS_TIMESTAMPS = UNKNOWN;
#endif
#ifdef PQTRACE_REGRESS_MODE
    const PGSQL_TRACE_REGRESS_MODE = UNKNOWN;
#endif
 
    /* For pg_set_error_context_visibility() */

    const PGSQL_SHOW_CONTEXT_NEVER = UNKNOWN;
    const PGSQL_SHOW_CONTEXT_ERRORS = UNKNOWN;
    const PGSQL_SHOW_CONTEXT_ALWAYS = UNKNOWN;
 
    function pg_connect(string $connection_string, int $flags = 0): PgSql\Connection|false {}
 
    function pg_pconnect(string $connection_string, int $flags = 0): PgSql\Connection|false {}
 
    function pg_connect_poll(PgSql\Connection $connection): int {}
 
    function pg_close(?PgSql\Connection $connection = null): true {}

    function pg_dbname(?PgSql\Connection $connection = null): string {}
 
    function pg_last_error(?PgSql\Connection $connection = null): string {}

    #[\Deprecated(since: '8.0', message: 'use pg_last_error() instead')]
    function pg_errormessage(?PgSql\Connection $connection = null): string {}

    function pg_options(?PgSql\Connection $connection = null): string {}

    function pg_port(?PgSql\Connection $connection = null): string {}

    function pg_tty(?PgSql\Connection $connection = null): string {}

    function pg_host(?PgSql\Connection $connection = null): string {}

    function pg_version(?PgSql\Connection $connection = null): array {}

    function pg_jit(?PgSql\Connection $connection = null): array {}

    function pg_parameter_status($connection, string $name = UNKNOWN): string|false {}
 
    function pg_ping(?PgSql\Connection $connection = null): bool {}

    function pg_query($connection, string $query = UNKNOWN): PgSql\Result|false {}

    function pg_exec($connection, string $query = UNKNOWN): PgSql\Result|false {}

    function pg_query_params($connection, $query, array $params = UNKNOWN): PgSql\Result|false {}

    function pg_prepare($connection, string $statement_name, string $query = UNKNOWN): PgSql\Result|false {}

    function pg_execute($connection, $statement_name, array $params = UNKNOWN): PgSql\Result|false {}
 
    function pg_num_rows(PgSql\Result $result): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_num_rows() instead')]
    function pg_numrows(PgSql\Result $result): int {}
 
    function pg_num_fields(PgSql\Result $result): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_num_fields() instead')]
    function pg_numfields(PgSql\Result $result): int {}
 
    function pg_affected_rows(PgSql\Result $result): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_affected_rows() instead')]
    function pg_cmdtuples(PgSql\Result $result): int {}
 
    function pg_last_notice(PgSql\Connection $connection, int $mode = PGSQL_NOTICE_LAST): array|string|bool {}
 
    function pg_field_table(PgSql\Result $result, int $field, bool $oid_only = false): string|int|false {}

    function pg_field_name(PgSql\Result $result, int $field): string {}

    #[\Deprecated(since: '8.0', message: 'use pg_field_name() instead')]
    function pg_fieldname(PgSql\Result $result, int $field): string {}
 
    function pg_field_size(PgSql\Result $result, int $field): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_field_size() instead')]
    function pg_fieldsize(PgSql\Result $result, int $field): int {}
 
    function pg_field_type(PgSql\Result $result, int $field): string {}

    #[\Deprecated(since: '8.0', message: 'use pg_field_type() instead')]
    function pg_fieldtype(PgSql\Result $result, int $field): string {}

    function pg_field_type_oid(PgSql\Result $result, int $field): string|int {}
 
    function pg_field_num(PgSql\Result $result, string $field): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_field_num() instead')]
    function pg_fieldnum(PgSql\Result $result, string $field): int {}

    function pg_fetch_result(PgSql\Result $result, $row, string|int $field = UNKNOWN): string|false|null {}

    #[\Deprecated(since: '8.0', message: 'use pg_fetch_result() instead')]
    function pg_result(PgSql\Result $result, $row, string|int $field = UNKNOWN): string|false|null {}

    function pg_fetch_row(PgSql\Result $result, ?int $row = null, int $mode = PGSQL_NUM): array|false {}

    function pg_fetch_assoc(PgSql\Result $result, ?int $row = null): array|false {}

    function pg_fetch_array(PgSql\Result $result, ?int $row = null, int $mode = PGSQL_BOTH): array|false {}

    function pg_fetch_object(PgSql\Result $result, ?int $row = null, string $class = "stdClass", array $constructor_args = []): object|false {}

    function pg_fetch_all(PgSql\Result $result, int $mode = PGSQL_ASSOC): array {}

    function pg_fetch_all_columns(PgSql\Result $result, int $field = 0): array {}
 
    function pg_result_seek(PgSql\Result $result, int $row): bool {}

    function pg_field_prtlen(PgSql\Result $result, $row, string|int $field = UNKNOWN): int|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_field_prtlen() instead')]
    function pg_fieldprtlen(PgSql\Result $result, $row, string|int $field = UNKNOWN): int|false {}

    function pg_field_is_null(PgSql\Result $result, $row, string|int $field = UNKNOWN): int|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_field_is_null() instead')]
    function pg_fieldisnull(PgSql\Result $result, $row, string|int $field = UNKNOWN): int|false {}
 
    function pg_free_result(PgSql\Result $result): bool {}

    #[\Deprecated(since: '8.0', message: 'use pg_free_result() instead')]
    function pg_freeresult(PgSql\Result $result): bool {}

    function pg_last_oid(PgSql\Result $result): string|int|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_last_oid() instead')]
    function pg_getlastoid(PgSql\Result $result): string|int|false {}
 
    function pg_trace(string $filename, string $mode = "w", ?PgSql\Connection $connection = null, int $trace_mode = 0): bool {}
 
    function pg_untrace(?PgSql\Connection $connection = null): true {}

    function pg_lo_create($connection = UNKNOWN, $oid = UNKNOWN): string|int|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_create() instead')]
    function pg_locreate($connection = UNKNOWN, $oid = UNKNOWN): string|int|false {}

    function pg_lo_unlink($connection, $oid = UNKNOWN): bool {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_unlink() instead')]
    function pg_lounlink($connection, $oid = UNKNOWN): bool {}

    function pg_lo_open($connection, $oid = UNKNOWN, string $mode = UNKNOWN): PgSql\Lob|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_open() instead')]
    function pg_loopen($connection, $oid = UNKNOWN, string $mode = UNKNOWN): PgSql\Lob|false {}
 
    function pg_lo_close(PgSql\Lob $lob): bool {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_close() instead')]
    function pg_loclose(PgSql\Lob $lob): bool {}

    function pg_lo_read(PgSql\Lob $lob, int $length = 8192): string|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_read() instead')]
    function pg_loread(PgSql\Lob $lob, int $length = 8192): string|false {}
 
    function pg_lo_write(PgSql\Lob $lob, string $data, ?int $length = null): int|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_write() instead')]
    function pg_lowrite(PgSql\Lob $lob, string $data, ?int $length = null): int|false {}
 
    function pg_lo_read_all(PgSql\Lob $lob): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_read_all() instead')]
    function pg_loreadall(PgSql\Lob $lob): int {}

    function pg_lo_import($connection, $filename = UNKNOWN, $oid = UNKNOWN): string|int|false {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_import() instead')]
    function pg_loimport($connection, $filename = UNKNOWN, $oid = UNKNOWN): string|int|false {}

    function pg_lo_export($connection, $oid = UNKNOWN, $filename = UNKNOWN): bool {}

    #[\Deprecated(since: '8.0', message: 'use pg_lo_export() instead')]
    function pg_loexport($connection, $oid = UNKNOWN, $filename = UNKNOWN): bool {}
 
    function pg_lo_seek(PgSql\Lob $lob, int $offset, int $whence = SEEK_CUR): bool {}
 
    function pg_lo_tell(PgSql\Lob $lob): int {}
 
    function pg_lo_truncate(PgSql\Lob $lob, int $size): bool {}

    function pg_set_error_verbosity($connection, int $verbosity = UNKNOWN): int|false {}

    function pg_set_client_encoding($connection, string $encoding = UNKNOWN): int {}

    #[\Deprecated(since: '8.0', message: 'use pg_set_client_encoding() instead')]
    function pg_setclientencoding($connection, string $encoding = UNKNOWN): int {}
 
    function pg_client_encoding(?PgSql\Connection $connection = null): string {}

    #[\Deprecated(since: '8.0', message: 'use pg_client_encoding() instead')]
    function pg_clientencoding(?PgSql\Connection $connection = null): string {}
 
    function pg_end_copy(?PgSql\Connection $connection = null): bool {}

    function pg_put_line($connection, string $query = UNKNOWN): bool {}

    function pg_copy_to(PgSql\Connection $connection, string $table_name, string $separator = "\t", string $null_as = "\\\\N"): array|false {}
 
    function pg_copy_from(PgSql\Connection $connection, string $table_name, array $rows, string $separator = "\t", string $null_as = "\\\\N"): bool {}

    function pg_escape_string($connection, string $string = UNKNOWN): string {}

    function pg_escape_bytea($connection, string $string = UNKNOWN): string {}

    function pg_unescape_bytea(string $string): string {}

    function pg_escape_literal($connection, string $string = UNKNOWN): string|false {}

    function pg_escape_identifier($connection, string $string = UNKNOWN): string|false {}

    function pg_result_error(PgSql\Result $result): string|false {}

    function pg_result_error_field(PgSql\Result $result, int $field_code): string|false|null {}
 
    function pg_connection_status(PgSql\Connection $connection): int {}
 
    function pg_transaction_status(PgSql\Connection $connection): int {}
 
    function pg_connection_reset(PgSql\Connection $connection): bool {}
 
    function pg_cancel_query(PgSql\Connection $connection): bool {}
 
    function pg_connection_busy(PgSql\Connection $connection): bool {}
 
    function pg_send_query(PgSql\Connection $connection, string $query): int|bool {}
 
    function pg_send_query_params(PgSql\Connection $connection, string $query, array $params): int|bool {}
 
    function pg_send_prepare(PgSql\Connection $connection, string $statement_name, string $query): int|bool {}
 
    function pg_send_execute(PgSql\Connection $connection, string $statement_name, array $params): int|bool {}

    function pg_get_result(PgSql\Connection $connection): PgSql\Result|false {}

    function pg_result_status(PgSql\Result $result, int $mode = PGSQL_STATUS_LONG): string|int {}

    function pg_get_notify(PgSql\Connection $connection, int $mode = PGSQL_ASSOC): array|false {}
 
    function pg_get_pid(PgSql\Connection $connection): int {}

    function pg_socket(PgSql\Connection $connection) {}
 
    function pg_consume_input(PgSql\Connection $connection): bool {}
 
    function pg_flush(PgSql\Connection $connection): int|bool {}

    function pg_meta_data(PgSql\Connection $connection, string $table_name, bool $extended = false): array|false {}

    function pg_convert(PgSql\Connection $connection, string $table_name, array $values, int $flags = 0): array|false {}

    function pg_insert(PgSql\Connection $connection, string $table_name, array $values, int $flags = PGSQL_DML_EXEC): PgSql\Result|string|bool {}

    function pg_update(PgSql\Connection $connection, string $table_name, array $values, array $conditions, int $flags = PGSQL_DML_EXEC): string|bool {}

    function pg_delete(PgSql\Connection $connection, string $table_name, array $conditions, int $flags = PGSQL_DML_EXEC): string|bool {}

    function pg_select(PgSql\Connection $connection, string $table_name, array $conditions = [], int $flags = PGSQL_DML_EXEC, int $mode = PGSQL_ASSOC): array|string|false {}
 
    function pg_set_error_context_visibility(PgSql\Connection $connection, int $visibility): int {}
 
#ifdef HAVE_PG_RESULT_MEMORY_SIZE
    function pg_result_memory_size(PgSql\Result $result): int {}
#endif
 
    function pg_change_password(PgSql\Connection $connection, string $user, #[\SensitiveParameter] string $password): bool {}
 
    function pg_put_copy_data(PgSql\Connection $connection, string $cmd): int {}
    function pg_put_copy_end(PgSql\Connection $connection, ?string $error = null): int {}

    function pg_socket_poll($socket, int $read, int $write, int $timeout = -1): int {}
 
#ifdef HAVE_PG_SET_CHUNKED_ROWS_SIZE
    function pg_set_chunked_rows_size(PgSql\Connection $connection, int $size): bool {}
#endif
}
 
namespace PgSql {
    final class Connection
    {
    }

    final class Result
    {
    }

    final class Lob
    {
    }
 
}