AloFramework documentation
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Namespaces

  • Alo
    • Cache
    • CLI
    • Controller
    • Db
    • Exception
    • FileSystem
    • Session
    • Statics
    • Test
    • Validators
    • Windows
  • Controller
  • None
  • PHP

Classes

  • AbstractDb
  • MySQL

Class AbstractDb

The framework database interface

Direct known subclasses

Alo\Db\MySQL

Abstract
Namespace: Alo\Db
Package: Database
Author: Art <a.molcanovas@gmail.com>
Located at sys/class/alo/db/abstractdb.php

Methods summary

public
# __construct( string $cache )

Instantiates the database connection

Instantiates the database connection

Parameters

$cache
string
$cache Which cache interface to use

Author

Art <a.molcanovas@gmail.com>
public string
# getLastHash( )

Returns the last hash generated

Returns the last hash generated

Returns

string

Author

Art <a.molcanovas@gmail.com>
abstract public PDOStatement
# prepare( string $sql )

Prepares a statement

Prepares a statement

Parameters

$sql
string
$sql A SQL statement to prepare

Returns

PDOStatement

Author

Art <a.molcanovas@gmail.com>
abstract public boolean
# transactionActive( )

Checks whether a transaction is active

Checks whether a transaction is active

Returns

boolean

Author

Art <a.molcanovas@gmail.com>
abstract public integer|float
# aggregate( string $sql, array $params = null, array $settings = [] )

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

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

Parameters

$sql
string
$sql The SQL code
$params
array
$params Bound parameters
$settings
array
$settings Optional settings

Returns

integer|float

Author

Art <a.molcanovas@gmail.com>
abstract public Alo\Db\AbstractDb
# beginTransaction( )

Begins a transaction

Begins a transaction

Returns

Alo\Db\AbstractDb

Author

Art <a.molcanovas@gmail.com>
abstract public Alo\Db\AbstractDb
# rollBack( )

Rolls back a transaction

Rolls back a transaction

Returns

Alo\Db\AbstractDb

Author

Art <a.molcanovas@gmail.com>
abstract public Alo\Db\AbstractDb
# commit( )

Commits a transaction

Commits a transaction

Returns

Alo\Db\AbstractDb

Author

Art <a.molcanovas@gmail.com>
abstract public array|boolean
# prepQuery( string $sql, array $params = null, array $settings = [] )

Executes a prepared query and returns the results

Executes a prepared query and returns the results

Parameters

$sql
string
$sql The SQL code
$params
array
$params Bound parameters
$settings
array
$settings Optional settings

Returns

array|boolean
Result array on SELECT queries, TRUE/FALSE for others

Author

Art <a.molcanovas@gmail.com>
abstract public array|boolean
# query( string $sql )

Executes a quick unescaped query without preparing it

Executes a quick unescaped query without preparing it

Parameters

$sql
string
$sql SQL code

Returns

array|boolean
Result array on SELECT queries, TRUE/FALSE for others

Author

Art <a.molcanovas@gmail.com>
protected string
# hash( string $sql, array $params, string $prefix = null )

Creates a query hash for caching

Creates a query hash for caching

Parameters

$sql
string
$sql QUery string
$params
array
$params Query parameters
$prefix
string
$prefix Optional prefix

Returns

string
An MD5 hash

Author

Art <a.molcanovas@gmail.com>

Magic methods summary

Constants summary

string V_CACHE 'c'
#

Defines a parameter as "whether to cache"

Defines a parameter as "whether to cache"

string V_TIME 't'
#

Defines a parameter as "cache time" in seconds

Defines a parameter as "cache time" in seconds

string V_PREFIX 'p'
#

Defines a parameter as "cache hash prefix"

Defines a parameter as "cache hash prefix"

string V_FETCH_NUM 'n'
#

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

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

Properties summary

protected static array $default_settings
#

Default query options

Default query options

protected Alo\Cache\AbstractCache $cache
#

The cache object in use

The cache object in use

protected string $cache_prefix
#

The prefix to use for cache keys

The prefix to use for cache keys

protected string $last_hash
#

The last cache hash generated

The last cache hash generated

AloFramework documentation API documentation generated by ApiGen 2.8.0