PHPXRef 0.7.1 : phpBB-3.3.14-deutsch : Detail view of driver

Gets the exact number of rows in a specified table.

param: string $table_name Table name
return: string Exact number of rows in $table_name.

get_estimated_row_count($table_name) X-Ref

Gets the estimated number of rows in a specified table.

param: string $table_name Table name
return: string Number of rows in $table_name.

sql_lower_text($column_name) X-Ref

Run LOWER() on DB column of type text (i.e. neither varchar nor char).

param: string $column_name The column name to use
return: string A SQL statement like "LOWER($column_name)"

sql_error($sql = '') X-Ref

Display sql error page

param: string $sql The SQL query causing the error
return: mixed Returns the full error message, if $this->return_on_error

sql_buffer_nested_transactions() X-Ref

Returns whether results of a query need to be buffered to run a
transaction while iterating over them.

return: bool Whether buffering is required.

sql_bit_or($column_name, $bit, $compare = '') X-Ref

Run binary OR operator on DB column.

param: string    $column_name    The column name to use
param: int    $bit            The value to use for the OR operator,
param: string    $compare    Any custom SQL code after the check (e.g. "= 0")
return: string    A SQL statement like "$column | (1 << $bit) {$compare}"

sql_server_info($raw = false, $use_cache = true) X-Ref

Version information about used database

param: bool $raw Only return the fetched sql_server_version
param: bool $use_cache Is it safe to retrieve the value from the cache
return: string sql server version

sql_return_on_error($fail = false) X-Ref

Return on error or display error message

param: bool $fail Should we return on errors, or stop
return: null

sql_build_array($query, $assoc_ary = array() X-Ref

Build sql statement from an array

param: string    $query        Should be on of the following strings:
param: array    $assoc_ary    Array with "column => value" pairs
return: string        A SQL statement like "c1 = 'a' AND c2 = 'b'"

sql_fetchrowset($query_id = false) X-Ref

Fetch all rows

param: mixed $query_id Already executed query to get the rows from,
return: mixed Nested array if the query had rows, false otherwise

sql_transaction($status = 'begin') X-Ref

SQL Transaction

param: string $status Should be one of the following strings:
return: mixed Buffered, seekable result handle, false on error

sql_concatenate($expr1, $expr2) X-Ref

Build a concatenated expression

param: string    $expr1        Base SQL expression where we append the second one
param: string    $expr2        SQL expression that is appended to the first expression
return: string        Concatenated string

sql_case($condition, $action_true, $action_false = false) X-Ref

Build a case expression

Note: The two statements action_true and action_false must have the same
data type (int, vchar, ...) in the database!

param: string    $condition        The condition which must be true,
param: string    $action_true    SQL expression that is used, if the condition is true
param: mixed    $action_false    SQL expression that is used, if the condition is false
return: string        CASE expression including the condition and statements

sql_build_query($query, $array) X-Ref

Build sql statement from array for select and select distinct statements

Possible query values: SELECT, SELECT_DISTINCT

param: string    $query    Should be one of: SELECT, SELECT_DISTINCT
param: array    $array    Array with the query data:
return: string        A SQL statement ready for execution

sql_fetchfield($field, $rownum = false, $query_id = false) X-Ref

Fetch field
if rownum is false, the current row is used, else it is pointing to the row (zero-based)

param: string    $field        Name of the column
param: mixed    $rownum        Row number, if false the current row will be used
param: mixed    $query_id    Already executed query to get the rows from,
return: mixed        String value of the field in the selected row,

sql_fetchrow($query_id = false) X-Ref

Fetch current row

param: mixed $query_id Already executed query to get the rows from,
return: mixed Array with the current row,

cast_expr_to_bigint($expression) X-Ref

Returns SQL string to cast a string expression to an int.

param: string $expression An expression evaluating to string
return: string Expression returning an int

sql_nextid() X-Ref

Gets the ID of the **last** inserted row immediately after an INSERT
statement.

**Note**: Despite the name, the returned ID refers to the row that has
just been inserted, rather than the hypothetical ID of the next row if a
new one was to be inserted.

The returned value can be used for selecting the item that has just been
inserted or for updating another table with an ID pointing to that item.

Alias of `sql_last_inserted_id`.

return: string|false Auto-incremented value of the last inserted row

sql_last_inserted_id() X-Ref

Gets the ID of the last inserted row immediately after an INSERT
statement. The returned value can be used for selecting the item that has
just been inserted or for updating another table with an ID pointing to
that item.

return: string|false Auto-incremented value of the last inserted row

sql_add_num_queries($cached = false) X-Ref

Add to query count

param: bool $cached Is this query cached?
return: null

sql_query_limit($query, $total, $offset = 0, $cache_ttl = 0) X-Ref

Build LIMIT query

param: string    $query        The SQL query to execute
param: int        $total        The number of rows to select
param: int        $offset
param: int        $cache_ttl    Either 0 to avoid caching or
return: mixed    Buffered, seekable result handle, false on error

sql_query($query = '', $cache_ttl = 0) X-Ref

Base query method

param: string    $query        The SQL query to execute
param: int        $cache_ttl    Either 0 to avoid caching or
return: mixed    Buffered, seekable result handle, false on error

cast_expr_to_string($expression) X-Ref

Returns SQL string to cast an integer expression to a string.

param: string $expression An expression evaluating to int
return: string Expression returning a string

sql_connect($sqlserver, $sqluser, $sqlpassword, $database, $port = false, $persistency = false, $new_link = false) X-Ref

Connect to server

param: string    $sqlserver        Address of the database server
param: string    $sqluser        User name of the SQL user
param: string    $sqlpassword    Password of the SQL user
param: string    $database        Name of the database
param: mixed    $port            Port of the database server
param: bool    $persistency
param: bool    $new_link        Should a new connection be established
return: mixed    Connection ID on success, string error message otherwise

sql_bit_and($column_name, $bit, $compare = '') X-Ref

Run binary AND operator on DB column.
Results in sql statement: "{$column_name} & (1 << {$bit}) {$compare}"

param: string    $column_name    The column name to use
param: int    $bit            The value to use for the AND operator,
param: string    $compare        Any custom SQL code after the check (for example "= 0")
return: string    A SQL statement like: "{$column} & (1 << {$bit}) {$compare}"

sql_freeresult($query_id = false) X-Ref

Free sql result

param: mixed $query_id Already executed query result,
return: null

sql_num_queries($cached = false) X-Ref

Return number of sql queries and cached sql queries used

param: bool $cached Should we return the number of cached or normal queries?
return: int Number of queries that have been executed

sql_multi_insert($table, $sql_ary) X-Ref

Run more than one insert statement.

param: string    $table        Table name to run the statements on
param: array    $sql_ary    Multi-dimensional array holding the statement data
return: bool        false if no statements were executed.

sql_affectedrows() X-Ref

Return number of affected rows

return: mixed Number of the affected rows by the last query

sql_close() X-Ref

DBAL garbage collection, close SQL connection

return: mixed False if no connection was opened before,

sql_rowseek($rownum, &$query_id) X-Ref

Seek to given row number

param: mixed    $rownum        Row number the curser should point to
param: mixed    $query_id    ID of the query to set the row cursor on
return: bool        False if something went wrong

sql_escape($msg) X-Ref

Escape string used in sql query

param: string $msg String to be escaped
return: string Escaped version of $msg

sql_like_expression($expression) X-Ref

Correctly adjust LIKE expression for special characters
Some DBMS are handling them in a different way

param: string $expression The expression to use. Every wildcard is
return: string A SQL statement like: "LIKE 'bertie_%'"

sql_not_like_expression($expression) X-Ref

Correctly adjust NOT LIKE expression for special characters
Some DBMS are handling them in a different way

param: string $expression The expression to use. Every wildcard is
return: string A SQL statement like: "NOT LIKE 'bertie_%'"

sql_report($mode, $query = '') X-Ref

Explain queries

param: string    $mode        Available modes: display, start, stop,
param: string    $query        The Query that should be explained
return: mixed        Either a full HTML page, boolean or null

sql_in_set($field, $array, $negate = false, $allow_empty_set = false) X-Ref

Build IN or NOT IN sql comparison string, uses <> or = on single element
arrays to improve comparison speed

param: string    $field            Name of the sql column that shall be compared
param: array    $array            Array of values that are (not) allowed
param: bool    $negate            true for NOT IN (), false for IN ()
param: bool    $allow_empty_set    If true, allow $array to be empty,
return: string    A SQL statement like: "IN (1, 2, 3, 4)" or "= 1"

sql_quote($msg) X-Ref

Quote identifiers used in sql query

param: string $msg String to be quoted
return: string Quoted version of $msg

clean_query_id($query_id) X-Ref

Ensure query ID can be used by cache

param: resource|int|string $query_id Mixed type query id
return: int|string Query id in string or integer format

Copyright:	(c) phpBB Limited
License:	GNU General Public License, version 2 (GPL-2.0)
File Size:	506 lines (15 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of phpBB-3.3.14-deutsch

/phpbb/db/driver/ -> driver_interface.php (summary)

Defines 1 class