API Documentation
\

\sql

Class sql

SQL database class

Summary

Methods
Properties
Constants
__construct()
__destruct()
_exit()
get_q_count()
get_db_name()
insert_id()
get_table_prefix()
exe()
debug_dump_params()
query()
escape()
prepare()
bind_param()
bind_value()
bind()
fa_single_column()
fa_single_row()
fetch_single_element()
fa()
nr()
debug_params()
$stmt
No constants found
No protected methods found
No protected properties found
N/A
set_table_prefix()
replace_table_prefix()
$sql_q_count
$table_prefix
$db
$lastsql
$db_name
$db_type
$db_port
N/A

Properties

$stmt

$stmt : boolean

Type

boolean

$sql_q_count

$sql_q_count : integer

Type

integer

$table_prefix

$table_prefix : string

Type

string

$db

$db : boolean|\PDO

Type

boolean|\PDO

$lastsql

$lastsql : string

Type

string

$db_name

$db_name : boolean

Type

boolean

$db_type

$db_type : string

Type

string

$db_port

$db_port : integer

Type

integer

Methods

__construct()

__construct(  $sql_host,   $sql_user,   $sql_pass,   $sql_db, string  $db_type = "mysql", string  $db_port = "", string  $oracle_sid = "xe")

Constructor

Parameters

$sql_host
$sql_user
$sql_pass
$sql_db
string $db_type
string $db_port
string $oracle_sid

__destruct()

__destruct()

Destructor

Close the database connection.

_exit()

_exit()

Exit

Unset the database variable.

get_q_count()

get_q_count() : integer

Get queries count

Return the queries count.

Returns

integer

get_db_name()

get_db_name() : boolean

Get database name

Rerun the database name.

Returns

boolean

insert_id()

insert_id() : string

Insert id

Return the last insert id.

Returns

string

get_table_prefix()

get_table_prefix() : string

Get table prefix

Return the table prefix.

Returns

string

exe()

exe(boolean  $nofatal = false, boolean  $nolog = false, boolean  $exec_array = false) : boolean

Execute

Executes a prepared statement. Check if a statement is set.

Parameters

boolean $nofatal
boolean $nolog
boolean $exec_array

Returns

boolean

debug_dump_params()

debug_dump_params()

Debug dump params

Dump an SQL prepared command.

query()

query(string  $sql, boolean  $nofatal = false, boolean  $nolog = false, integer  $line, integer  $file) : boolean|\PDOStatement

Query

Executes an SQL statement. Increase queries count.

Parameters

string $sql
boolean $nofatal
boolean $nolog
integer $line
integer $file

Returns

boolean|\PDOStatement

escape()

escape(  $sql) : string

Escape

Quotes a string for use in a query.

Parameters

$sql

Returns

string

prepare()

prepare(string  $sql, boolean  $nofatal = false, boolean  $nolog = false, integer  $line, integer  $file) : boolean|\PDOStatement

Prepare

Prepares a statement for execution. Save a statement. Increase queries count.

Parameters

string $sql
boolean $nofatal
boolean $nolog
integer $line
integer $file

Returns

boolean|\PDOStatement

bind_param()

bind_param(  $param,   $var, integer  $data_type = \PDO::PARAM_STR, null  $length = NULL, null  $driver_options = NULL) : boolean

Bind param

Binds a parameter to the specified variable name. Check if statement is set.

Parameters

$param
$var
integer $data_type
null $length
null $driver_options

Returns

boolean

bind_value()

bind_value(  $param,   $var, integer  $data_type = \PDO::PARAM_STR) : boolean

Bind value

Binds a value to a parameter. Check if statement is set.

Parameters

$param
$var
integer $data_type

Returns

boolean

bind()

bind(  $param,   $var, integer  $data_type = \PDO::PARAM_STR, null  $length = NULL, null  $driver_options = NULL)

Bind

Alias for bind_param.

Parameters

$param
$var
integer $data_type
null $length
null $driver_options

fa_single_column()

fa_single_column(boolean  $nofatal = false, boolean  $nolog = false, boolean  $stmt_unset = true) : array|boolean

Fetch single column

Fetch all rows from one column as ASSOC Array. Check if statement is set. Unset statement if needed.

Parameters

boolean $nofatal
boolean $nolog
boolean $stmt_unset

Returns

array|boolean

fa_single_row()

fa_single_row(boolean  $nofatal = false, boolean  $nolog = false, boolean  $stmt_unset = true) : mixed

Fetch single row

Fetches the next row from a result set as ASSOC Array. Check if statement is set. Unset statement if needed.

Parameters

boolean $nofatal
boolean $nolog
boolean $stmt_unset

Returns

mixed

fetch_single_element()

fetch_single_element(  $columnname, boolean  $nofatal = false, boolean  $nolog = false, boolean  $stmt_unset = true) : boolean|mixed

Fetch single element

Fetches one column by key given in $columnname.

Parameters

$columnname
boolean $nofatal
boolean $nolog
boolean $stmt_unset

Returns

boolean|mixed

fa()

fa(string  $fetchmode = "ASSOC", boolean  $nofatal = false, boolean  $nolog = false, boolean  $stmt_unset = true) : mixed

Fetch all

Get all rows returned from database. Default: ASSOC Check if statement is set. Unset statement if needed.

Parameters

string $fetchmode
boolean $nofatal
boolean $nolog
boolean $stmt_unset

Returns

mixed

nr()

nr(boolean  $nofatal = false, boolean  $nolog = false, boolean  $stmt_unset = false) : mixed

Num rows

Returns the number of rows affected by the last SQL statement. Check if statement is set. Unset statement if needed.

Parameters

boolean $nofatal
boolean $nolog
boolean $stmt_unset

Returns

mixed

debug_params()

debug_params(boolean  $nofatal = false, boolean  $nolog = false) : boolean

Debug params

Dump an SQL prepared command. Check if statement is set.

Parameters

boolean $nofatal
boolean $nolog

Returns

boolean

set_table_prefix()

set_table_prefix()

Set table prefix

Save the table prefix in local variable.

replace_table_prefix()

replace_table_prefix(  $statement) : mixed|string

Replace table prefix

Replace the table prefix and mod placeholder. ::prefix:: and ::mod::

Parameters

$statement

Returns

mixed|string