Class AkDbAdapter

(line 25)

Description

AkObject
   |
   --AkDbAdapter

Located in File: /AkActiveRecord/AkDbAdapter.php

Allows for __construct and __destruct to be used in PHP4.

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this one gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()


Classes extended from AkDbAdapter:
AkSqliteDbAdapter
AkPgsqlDbAdapter
AkMysqlDbAdapter

Class Variables

Summary:
mixed $connection
mixed $debug
mixed $dictionary
mixed $logger
mixed $settings

$connection (line 28)

Data type : mixed

$debug = false (line 31)

Data type : mixed

$dictionary (line 30)

Data type : mixed

$logger (line 32)

Data type : mixed

$settings (line 29)

Data type : mixed

Class Constants

Summary:

Method Detail

Summary:
static AkDbAdapter &getInstance ([ $database_specifications = AK_DEFAULT_DATABASE_PROFILE], [ $auto_connect = true], array $database_settings)
AkDbAdapter __construct (array $database_settings, [ $auto_connect = false])
void __destruct ()
void addLimitAndOffset ( &$sql,  $options)
void availableTables ()
void connect ()
void connected ()
void debug ([ $on = 'switch'])
void delete ( $sql, [ $message = ''])
void escape_blob ( $value)
void execute ( $sql, [ $message = 'SQL'])
void failTransaction ()
void getAffectedRows ()
void getColumnDetails ( $table_name)
void &getDictionary ()
void getIndexes ( $table_name)
void getLastInsertedId ( $table,  $pk)
void hasTransactionFailed ()
void incrementsPrimaryKeyAutomatically ()
void insert ( $sql, [ $id = null], [ $pk = null], [ $table = null], [ $message = ''])
void quote_date ( $value)
void quote_datetime ( $value)
void quote_string ( $value)
void renameColumn ( $table_name,  $column_name,  $new_name)
void select ( $sql, [ $message = ''])
void selectAll ( $sql)
void selectOne ( $sql)
void selectValue ( $sql)
void selectValues ( $sql)
void startTransaction ()
void stopTransaction ()
void type ()
void unescape_blob ( $value)
void update ( $sql, [ $message = ''])
string _constructDsn (array $database_settings)
void _getDbSettingsFromDsn ( $dsn)
string _hash (array $settings)
void _log ( $message)

Static Method getInstance (line 87)

AkDbAdapter &getInstance( [ $database_specifications = AK_DEFAULT_DATABASE_PROFILE], [ $auto_connect = true], array $database_settings)

Parameters

  • array $database_settings:
  • $database_specifications:
  • $auto_connect:

Info

Constructor __construct (line 37)

AkDbAdapter __construct( array $database_settings, [ $auto_connect = false])

Overrides : AkObject::__construct() Class constructor, overriden in descendant classes

Parameters

  • array $database_settings:
  • $auto_connect:

Info

Destructor __destruct (line 48)

void __destruct( )

Overrides : AkObject::__destruct() Class destructor, overriden in descendant classes

Info

Method addLimitAndOffset (line 200)

void addLimitAndOffset( &$sql, $options)

Overridden in child classes as:

AkMysqlDbAdapter::addLimitAndOffset()

Parameters

  • &$sql:
  • $options:

Info

Method availableTables (line 359)

void availableTables( )

Overridden in child classes as:

AkPgsqlDbAdapter::availableTables()
AkMysqlDbAdapter::availableTables()

Info

Method connect (line 52)

void connect( )

Info

Method connected (line 76)

void connected( )

Info

Method debug (line 182)

void debug( [ $on = 'switch'])

Parameters

  • $on:

Info

Method delete (line 261)

void delete( $sql, [ $message = ''])

Parameters

  • $sql:
  • $message:

Info

Method escape_blob (line 392)

void escape_blob( $value)

Parameters

  • $value:

Info

Method execute (line 213)

void execute( $sql, [ $message = 'SQL'])

Parameters

  • $sql:
  • $message:

Info

Method failTransaction (line 340)

void failTransaction( )

Info

Method getAffectedRows (line 241)

void getAffectedRows( )

Info

Method getColumnDetails (line 364)

void getColumnDetails( $table_name)

Parameters

  • $table_name:

Info

Method getDictionary (line 137)

void &getDictionary( )

Info

Method getIndexes (line 369)

void getIndexes( $table_name)

Parameters

  • $table_name:

Info

Method getLastInsertedId (line 236)

void getLastInsertedId( $table, $pk)

Parameters

  • $table:
  • $pk:

Info

Method hasTransactionFailed (line 345)

void hasTransactionFailed( )

Info

Method incrementsPrimaryKeyAutomatically (line 231)

void incrementsPrimaryKeyAutomatically( )

Overridden in child classes as:

AkSqliteDbAdapter::incrementsPrimaryKeyAutomatically()

Info

Method insert (line 246)

void insert( $sql, [ $id = null], [ $pk = null], [ $table = null], [ $message = ''])

Parameters

  • $sql:
  • $id:
  • $pk:
  • $table:
  • $message:

Info

Method quote_date (line 386)

void quote_date( $value)

Parameters

  • $value:

Info

Method quote_datetime (line 381)

void quote_datetime( $value)

Parameters

  • $value:

Info

Method quote_string (line 376)

void quote_string( $value)

Overridden in child classes as:

AkSqliteDbAdapter::quote_string()
AkPgsqlDbAdapter::quote_string()
AkMysqlDbAdapter::quote_string()

Parameters

  • $value:

Info

Method renameColumn (line 352)

void renameColumn( $table_name, $column_name, $new_name)

Overridden in child classes as:

AkPgsqlDbAdapter::renameColumn()
AkMysqlDbAdapter::renameColumn()

Parameters

  • $table_name:
  • $column_name:
  • $new_name:

Info

Method select (line 313)

void select( $sql, [ $message = ''])

Returns an array of record hashes with the column names as keys and column values as values.

Parameters

  • $sql:
  • $message:

Info

Method selectAll (line 304)

void selectAll( $sql)

alias for select

Parameters

  • $sql:

Info

Method selectOne (line 295)

void selectOne( $sql)

Returns a record array of the first row with the column names as keys and column values as values.

Parameters

  • $sql:

Info

Method selectValue (line 270)

void selectValue( $sql)

Returns a single value, the first column from the first row, from a record

Parameters

  • $sql:

Info

Method selectValues (line 280)

void selectValues( $sql)

Returns an array of the values of the first column in a select:

sqlSelectValues("SELECT id FROM companies LIMIT 3") => array(1,2,3)

Parameters

  • $sql:

Info

Method startTransaction (line 330)

void startTransaction( )

Info

Method stopTransaction (line 335)

void stopTransaction( )

Info

Method type (line 177)

void type( )

Overridden in child classes as:

AkSqliteDbAdapter::type()
AkPgsqlDbAdapter::type()
AkMysqlDbAdapter::type()

Info

Method unescape_blob (line 398)

void unescape_blob( $value)

Parameters

  • $value:

Info

Method update (line 255)

void update( $sql, [ $message = ''])

Parameters

  • $sql:
  • $message:

Info

Method _constructDsn (line 153)

string _constructDsn( array $database_settings)

Overridden in child classes as:

AkSqliteDbAdapter::_constructDsn()
AkMysqlDbAdapter::_constructDsn()

Parameters

  • array $database_settings:

Info

Method _getDbSettingsFromDsn (line 168)

void _getDbSettingsFromDsn( $dsn)

Parameters

  • $dsn:

Info

Method _hash (line 126)

string _hash( array $settings)

Parameters

  • array $settings:

Info

Method _log (line 192)

void _log( $message)

Parameters

  • $message:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary

Inherited From Class AkObject

AkObject::AkObject() - A hack to support __construct() on PHP 4

AkObject::__construct() - Class constructor, overriden in descendant classes

AkObject::freeMemory() - Unsets circular reference children that are not freed from memory when calling unset() or when the parent object is garbage collected.

AkObject::log() -

AkObject::toString() - Object-to-string conversion

AkObject::__clone() - Clone class (Zend Engine 2 compatibility trick)

AkObject::__destruct() - Class destructor, overriden in descendant classes

AkObject::__toString() -


Documentation generated on Tue, 17 Jun 2008 14:25:06 +0200 by phpDocumentor 1.3.2