Constants

V_CACHE

V_CACHE

Defines a parameter as "whether to cache"

V_TIME

V_TIME

Defines a parameter as "cache time" in seconds

V_PREFIX

V_PREFIX

Defines a parameter as "cache hash prefix"

V_FETCH_NUM

V_FETCH_NUM

Defines a variable as "whether to fetch as a numeric array instead of assoc"

Properties

$cache_prefix

$cache_prefix : string

The prefix to use for cache keys

Type

string

$last_hash

$last_hash : string

The last cache hash generated

Type

string

$default_settings

$default_settings : array

Default query options

Type

array

$pdo

$pdo : \PDO

The PDO instance

Type

\PDO

Methods

__construct()

__construct(string  $ip = ALO_MYSQL_SERVER, integer  $port = ALO_MYSQL_PORT, string  $user = ALO_MYSQL_USER, string  $pw = ALO_MYSQL_PW, string  $db = ALO_MYSQL_DATABASE, string  $cache = ALO_MYSQL_CACHE, array  $options = null) 

Instantiates the database connection

Parameters

string $ip

The IP address to use

integer $port

The port to use

string $user

The username

string $pw

The password

string $db

The database to use

string $cache

Which cache interface to use

array $options

Connection options

getLastHash()

getLastHash() : string

Returns the last hash generated

Returns

string

prepare()

prepare(string  $sql) : \PDOStatement

Prepares a statement

Parameters

string $sql

A SQL statement to prepare

Returns

\PDOStatement

transactionActive()

transactionActive() : boolean

Checks whether a transaction is active

Returns

boolean

aggregate()

aggregate(string  $sql, array  $params = null, array  $settings = array()) : integer|float

Returns an aggregated one-column result set, e.g. from a count(*) query

Parameters

string $sql

The SQL code

array $params

Bound parameters

array $settings

Optional settings

Returns

integer|float

beginTransaction()

beginTransaction() : \Alo\Db\AbstractDb

Begins a transaction

Returns

\Alo\Db\AbstractDb

rollBack()

rollBack() : \Alo\Db\AbstractDb

Rolls back a transaction

Returns

\Alo\Db\AbstractDb

prepQuery()

prepQuery(string  $sql, array  $params = null, array  $settings = array()) : array|boolean

Executes a prepared query and returns the results

Parameters

string $sql

The SQL code

array $params

Bound parameters

array $settings

Optional settings

Returns

array|boolean —

Result array on SELECT queries, TRUE/FALSE for others

query()

query(string  $sql) : array|boolean

Executes a quick unescaped query without preparing it

Parameters

string $sql

SQL code

Returns

array|boolean —

Result array on SELECT queries, TRUE/FALSE for others

__call()

__call(string  $name, array  $arguments) : mixed

Handles direct calls to PDO

Parameters

string $name

Method name

array $arguments

Array of parameters

Returns

mixed

hash()

hash(string  $sql, array  $params, string  $prefix = null) : string

Creates a query hash for caching

Parameters

string $sql

QUery string

array $params

Query parameters

string $prefix

Optional prefix

Returns

string —

An MD5 hash