Docs For Class atkDb

Child Class	Description
atkClusterDb	ATK driver for clustered databases. This class proxies queries to correct read/write slaves.
atkMockDb	A mock database driver.
atkMysqlDb	Driver for MySQL databases.
atkOci8Db	Driver for Oracle 8i databases.
atkPgsqlDb	Database driver for PostgreSQL.

[ Top ]

Property Summary

int	$m_affected_rows	number of affected rows after an update/delete/insert query
boolean	$m_auto_free	Auto free result upon next query.
String	$m_charset	The character set.
String	$m_collate	The collate.
String	$m_connection	The current connection name.
String	$m_database	The name of the database/schema to use.
int	$m_errno	Contains error number, in case an error occurred.
String	$m_error	Contains textual error message, in case an error occurred.
mixed	$m_errorLookup	Internal use; error messages from language files are cached here
boolean	$m_haltonerror	If true, an atkerror is raised when an error occurred.
String	$m_host	The hostname/ip to connect to.
unknown_type	$m_identifierQuoting	Indentifier Quoting
Resource	$m_link_id	The connection is stored in this variable.
String	$m_mode	The mode for the connection.
String	$m_password	The password for the connection.
String	$m_port	The port for the connection.
Resource	$m_query_id	The query statement is stored in this variable.
array	$m_record	Contains the current record from the result set.
int	$m_row	Current row number
array	$m_tableMeta	array to cache meta-information about tables.
String	$m_type	Driver name.
String	$m_user	The username for the connection.
array	$m_user_error	List of error codes that could be caused by an end-user.
String	$m_vendor	Vendor.

[ Top ]

Method Summary

static void	clearMapping()	Clear the current database mapping.
static atkDb	&getInstance()	Get database instance.
static mixed	getMapping()	Returns the current database mapping.
static void	getTranslatedDatabaseName()	Returns the real database name. If a mapping
static void	useMapping()	Use the given mapping to translate database requests from one database to another database. This can be used for test purposes.
static mixed	_getOrUseMapping()	Get or set the database mapping
int	affected_rows()	Retrieve the number of rows affected by the last query.
void	cloneAll()	Clones the database structure of the given database to this database. This also means the complete database is emptied beforehand.
void	commit()	Commit the current transaction.
int	connect()	Connect to the database.
atkDDL	&createDDL()	Create an atkDDL object for constructing ddl queries.
atkQuery	&createQuery()	Create an atkQuery object for constructing queries.
void	deleteAll()	Empty all database tables.
void	disconnect()	Disconnect from database
void	doConnect()	Connect to the database
void	dropAll()	Drop all database tables.
string	errorLookup()	Looks up the error
String	escapeSQL()	escapes quotes for use in SQL: ' -> '' (and sometimes % -> %%)
unknown	func_concat()	Get CONCAT() equivalent for the current database.
string	func_concat_ws()	Get CONCAT_WS() equivalent for the current database.
String	func_datetimetochar()	Get TO_CHAR() equivalent for the current database.
String	func_datetochar()	Get TO_CHAR() equivalent for the current database.
void	func_now()	get NOW() or SYSDATE() equivalent for the current database
void	func_substring()	get SUBSTRING() equivalent for the current database.
int	getAtkDbErrno()	Get generic atk errorccode
mixed	getDbErrno()	Get vendor-dependent database error number.
String	getDbError()	Get vendor-dependent database error message.
DB_SUCCESS	getDbStatus()	Check if current db is present and acceptable for current user
String	getErrorMsg()	Get localized error message (for display in the application)
String	getErrorType()	Determine whether an error that occurred is a recoverable (user) error or a system error.
string	getQueryMode()	Returns the query mode
array	getrows()	Get all rows that are the result of a certain specified query
array	getSearchModes()	This function indicates what searchmodes the database supports.
String	getType()	Get the database driver type.
mixed	getValue()	Get a single value (first row, first column) from a certain specified query
array	getValues()	Get an array with all the values in the (first) column.
void	halt()	If haltonerror is set, this will raise an atkerror. If not, it will place the error in atkdebug and continue.
void	hasError()	Has error?
bool	hasMode()	Check if the current instance has the given mode
atkDb	init()	(Re)Initialise a database driver with a connection
Connection	link_id()	Get the current connection.
boolean	lock()	Lock a table in the database.
Integer	maxIdentifierLength()	Returns the maximum length an identifier (tablename, columnname, etc) may have
array	metadata()	Return the meta data of a certain table HIE GEBLEVEN
int	nextid()	Get the next sequence number of a certain sequence.
mixed	next_record()	Retrieve the next record in the resultset.
void	query()	Parse and execute a query.
Resource	query_id()	Get the current query statement resource id.
string	quoteIdentifier()	Quote Indentifier
void	rollback()	Rollback the current transaction.
void	savepoint()	Set savepoint with the given name.
void	setHaltOnError()	Halt on error or not?
void	&setInstance()	Replace the current instance of a named connection at runtime with a different connection. This is useful for example for replacing a named database instance with a mock object for testing purposes.
void	setSequenceValue()	Set database sequence value.
void	setUserError()	Define custom user error codes.
bool	tableExists()	This function checks the database for a table with the provide name
array	tableMeta()	Fetches table meta data from database
array	table_names()	Return the available table names
void	toggleForeignKeys()	Enable/disable all foreign key constraints.
boolean	unlock()	Relieve all locks.
String	vendorDateFormat()	Convert a php date() format specifier to a vendor specific format specifier.
array	_getTableMetaFromCache()	If cached it'll return the table metadata from cache.
array	_getTableMetaFromDb()	Returns the tablemetadata directly from db
int	_translateError()	Translate database-vendor dependent error messages into an ATK generic error code.

[ Top ]

Properties

int $m_affected_rows = 0 [line 194]

number of affected rows after an update/delete/insert query

API Tags:

Access:

private

[ Top ]

boolean $m_auto_free = true [line 225]

Auto free result upon next query.

When set to true, the previous results are cleared when a new query is executed. It should generally not be necessary to put this to false.

API Tags:

Access:

private

[ Top ]

String $m_charset = "" [line 104]

The character set.

API Tags:

Access:

private

[ Top ]

String $m_collate = "" [line 111]

The collate.

API Tags:

Access:

private

[ Top ]

String $m_connection = "" [line 125]

The current connection name.

API Tags:

Access:

private

[ Top ]

String $m_database = "" [line 76]

The name of the database/schema to use.

API Tags:

Access:

private

[ Top ]

int $m_errno = 0 [line 146]

Contains error number, in case an error occurred.

API Tags:

Access:

private

[ Top ]

String $m_error = "" [line 153]

Contains textual error message, in case an error occurred.

API Tags:

Access:

private

[ Top ]

mixed $m_errorLookup = array() [line 241]

Internal use; error messages from language files are cached here

API Tags:

Access:

private

[ Top ]

boolean $m_haltonerror = true [line 165]

If true, an atkerror is raised when an error occurred.

The calling script can use this to stop execution and rollback. If false, the error will be ignored and script execution continues. Use this only for queries that may fail but still be valid.

API Tags:

Access:

private

[ Top ]

String $m_host = "" [line 69]

The hostname/ip to connect to.

API Tags:

Access:

private

[ Top ]

unknown_type $m_identifierQuoting = array('start' => '"', 'end' => '"', 'escape' => '"') [line 248]

Indentifier Quoting

API Tags:

Access:

protected

Redefined in descendants as:

atkMysqlDb::$m_identifierQuoting

[ Top ]

Resource $m_link_id = 0 [line 208]

The connection is stored in this variable.

API Tags:

Access:

private

[ Top ]

String $m_mode = "" [line 118]

The mode for the connection.

API Tags:

Access:

private

[ Top ]

String $m_password = "" [line 90]

The password for the connection.

API Tags:

Access:

private

[ Top ]

String $m_port = "" [line 97]

The port for the connection.

API Tags:

Access:

private

Redefined in descendants as:

atkOci9Db::$m_port

[ Top ]

Resource $m_query_id = 0 [line 215]

The query statement is stored in this variable.

API Tags:

Access:

private

[ Top ]

array $m_record = array() [line 132]

Contains the current record from the result set.

API Tags:

Access:

private

[ Top ]

int $m_row = 0 [line 139]

Current row number

API Tags:

Access:

private

[ Top ]

array $m_tableMeta = array() [line 201]

array to cache meta-information about tables.

API Tags:

Access:

private

[ Top ]

String $m_type = "" [line 176]

Driver name.

Derived classes should add their own m_type var to the class definition and put the correct name in it. (e.g. "mysql" etc.)

API Tags:

Abstract:
Access:	private

Redefined in descendants as:

[ Top ]

String $m_user = "" [line 83]

The username for the connection.

API Tags:

Access:

private

[ Top ]

array $m_user_error = array() [line 235]

List of error codes that could be caused by an end-user.

This type of errors is 'recoverable'. An example is a violation of a unique constraint.

API Tags:

Access:

private

[ Top ]

String $m_vendor = "" [line 187]

Vendor.

This is mainly used to retrieve things like error messages that are common for a vendor (i.e., they do not differ between versions).

API Tags:

Abstract:
Access:	private

Redefined in descendants as:

[ Top ]

Methods

static method clearMapping [line 293]

static void clearMapping(
)

Clear the current database mapping.

Redefined in descendants as:

atkClusterDb::clearMapping()

[ Top ]

static method getInstance [line 1153]

static atkDb &getInstance(
[String
$conn = "default"], [Bool
$reset = false], [String
$mode = "rw"] 
)

Get database instance.

This method instantiates and returns the correct (vendor specific) database instance, depending on the configuration.

Parameters:

String	$conn:	The name of the connection as defined in the config.inc.php file (defaults to 'default')
Bool	$reset:	Reset the instance to force the creation of a new instance
String	$mode:	The mode to connect with the database

API Tags:

Return:	Instance of the database class.
Access:	public

Redefined in descendants as:

atkClusterDb::getInstance()

[ Top ]

static method getMapping [line 283]

static mixed getMapping(
)

Returns the current database mapping.

NULL if no mapping is active.

API Tags:

Return:

current database mapping (null if inactive)

Redefined in descendants as:

atkClusterDb::getMapping()

[ Top ]

static method getTranslatedDatabaseName [line 308]

static void getTranslatedDatabaseName(
string
$name 
)

Returns the real database name. If a mapping

exists the mapping is used to translate the database name to it's real database name. If the database name is not part of the mapping or no mapping is set the given name will be returned.

Parameters:

string

$name:

database name

Redefined in descendants as:

atkClusterDb::getTranslatedDatabaseName()

[ Top ]

static method useMapping [line 271]

static void useMapping(
array
$mapping 
)

Use the given mapping to translate database requests from one database to another database. This can be used for test purposes.

Parameters:

array

$mapping:

database mapping

Redefined in descendants as:

atkClusterDb::useMapping()

[ Top ]

static method _getOrUseMapping [line 321]

static mixed _getOrUseMapping(
[array
$mapping = "get"] 
)

Get or set the database mapping

Parameters:

array

$mapping:

database mapping

API Tags:

Return:

current database mapping (null if inactive)

Redefined in descendants as:

atkClusterDb::_getOrUseMapping()

[ Top ]

affected_rows [line 679]

int affected_rows(
)

Retrieve the number of rows affected by the last query.

After calling query() to perform an update statement, this method will return the number of rows that was updated.

API Tags:

Return:	The number of affected rows
Abstract:

Redefined in descendants as:

atkClusterDb::affected_rows()
atkMysqlDb::affected_rows() : Evaluate the result; which rows were affected by the query.
atkMsSqlDb::affected_rows() : Evaluate the result; which rows were affected by the query.
atkMysqliDb::affected_rows() : Evaluate the result; which rows were affected by the query.
atkOci8Db::affected_rows() : Retrieve the number of rows affected by the last query.
atkPgsqlDb::affected_rows() : Evaluate the result; which rows were affected by the query.

[ Top ]

cloneAll [line 1114]

void cloneAll(

&$otherDb, atkDb
$otherDb 
)

Clones the database structure of the given database to this database. This also means the complete database is emptied beforehand.

Parameters:

atkDb	$otherDb:	other database instance
	&$otherDb:

Redefined in descendants as:

atkClusterDb::cloneAll()

[ Top ]

commit [line 590]

void commit(
)

Commit the current transaction.

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::commit()
atkMsSqlDb::commit() : Commit the current transaction.
atkMysqliDb::commit() : Commit the current transaction.
atkOci8Db::commit() : Commit the current transaction.

[ Top ]

connect [line 538]

int connect(
[String
$mode = "rw"] 
)

Connect to the database.

Parameters:

String

$mode:

The mode to connect

API Tags:

Return:	Connection status
Abstract:

Redefined in descendants as:

atkClusterDb::connect() : Connects to a cluster node and sets the node as "current node"
atkMockDb::connect() : Connect to the database.
atkMsSqlDb::connect() : Connect to the database
atkOci8Db::connect() : Connect to the database.
atkOci9Db::connect() : Connect to the database
atkPgsqlDb::connect() : Connect to the database

[ Top ]

createDDL [line 1132]

atkDDL &createDDL(
)

Create an atkDDL object for constructing ddl queries.

API Tags:

Return:

DDL object

Redefined in descendants as:

atkClusterDb::createDDL() : Creates a new new atkDDL based on current cluster nodes type

[ Top ]

createQuery [line 1047]

atkQuery &createQuery(
)

Create an atkQuery object for constructing queries.

API Tags:

Return:

Query class.

Redefined in descendants as:

atkClusterDb::createQuery() : Creates a new a new query object based on the current nodes type

[ Top ]

deleteAll [line 1067]

void deleteAll(
)

Empty all database tables.

Redefined in descendants as:

atkClusterDb::deleteAll()

[ Top ]

disconnect [line 582]

void disconnect(
)

Disconnect from database

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::disconnect()
atkMysqlDb::disconnect() : Disconnect from database
atkMsSqlDb::disconnect() : Disconnect from database
atkMysqliDb::disconnect() : Disconnect from database
atkOci8Db::disconnect() : Disconnect from database.
atkPgsqlDb::disconnect() : Disconnect from database, we use a persistent

[ Top ]

doConnect [line 558]

void doConnect(
string
$host, string
$user, string
$password, string
$database, int
$port, string
$charset 
)

Connect to the database

Parameters:

string	$host:	The host to connect to
string	$user:	The user to connect with
string	$password:	The password to connect with
string	$database:	The database to connect to
int	$port:	The portnumber to use for connecting
string	$charset:	The charset to use

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::doConnect()
atkMysqlDb::doConnect() : Connect to the database
atkMysqliDb::doConnect() : Connect to the database

[ Top ]

dropAll [line 1098]

void dropAll(
)

Drop all database tables.

Redefined in descendants as:

atkClusterDb::dropAll()
atkMysqlDb::dropAll() : Drop all database tables.

[ Top ]

errorLookup [line 443]

string errorLookup(
integer
$errno 
)

Looks up the error

Parameters:

integer

$errno:

Error number

API Tags:

Return:

The translation for the error

Redefined in descendants as:

atkClusterDb::errorLookup()

[ Top ]

escapeSQL [line 1035]

String escapeSQL(
String
$string, [Bool
$wildcard = false] 
)

escapes quotes for use in SQL: ' -> '' (and sometimes % -> %%)

Parameters:

String	$string:	The string to escape
Bool	$wildcard:	Use wildcards?

API Tags:

Return:

The escaped SQL string

Redefined in descendants as:

atkClusterDb::escapeSQL()
atkOci8Db::escapeSQL() : Escape a string for use in SQL queries.

[ Top ]

func_concat [line 952]

unknown func_concat(
array
$fields 
)

Get CONCAT() equivalent for the current database.

Parameters:

array

$fields:

Redefined in descendants as:

atkClusterDb::func_concat()
atkOci8Db::func_concat() : Retrieve this drivers' specific SQL implementation of a concat() function.

[ Top ]

func_concat_ws [line 968]

string func_concat_ws(
array
$fields, string
$separator, [boolean
$remove_all_spaces = false] 
)

Get CONCAT_WS() equivalent for the current database.

Parameters:

array	$fields:
string	$separator:
boolean	$remove_all_spaces:	remove all spaces in result (atkAggrecatedColumns searches for string without spaces)

Redefined in descendants as:

atkClusterDb::func_concat_ws()

[ Top ]

func_datetimetochar [line 1013]

String func_datetimetochar(
String
$fieldname 
)

Get TO_CHAR() equivalent for the current database.

TODO/FIXME: add format parameter. Current format is always yyyy-mm-dd hh:mi.

Parameters:

String

$fieldname:

The field to generate the to_char for.

API Tags:

Return:

Piece of sql query that converts a datetime field to char for the current database

Redefined in descendants as:

atkClusterDb::func_datetimetochar()
atkMysqlDb::func_datetimetochar() : Get TO_CHAR() equivalent for the current database.

[ Top ]

func_datetochar [line 940]

String func_datetochar(
String
$fieldname, [String
$format = ""] 
)

Get TO_CHAR() equivalent for the current database.

Each database driver should override this method to perform vendor specific conversion.

Parameters:

String	$fieldname:	The field to generate the to_char for.
String	$format:	Format specifier. The format is compatible with php's date() function (http://www.php.net/date) The default is what's specified by $config_date_to_char, or "Y-m-d" if not set in the configuration.

API Tags:

Return:

Piece of sql query that converts a date field to char for the current database

Redefined in descendants as:

atkClusterDb::func_datetochar()
atkMysqlDb::func_datetochar() : Get TO_CHAR() equivalent for the current database.

[ Top ]

func_now [line 909]

void func_now(
)

get NOW() or SYSDATE() equivalent for the current database

Every database has it's own implementation to get the current date

Redefined in descendants as:

atkClusterDb::func_now()
atkOci8Db::func_now() : Retrieve this drivers' specific SQL implementation of a now() function.

[ Top ]

func_substring [line 921]

void func_substring(
String
$fieldname, [Integer
$startat = 0], [Integer
$length = 0] 
)

get SUBSTRING() equivalent for the current database.

Parameters:

String	$fieldname:	The database fieldname
Integer	$startat:	The position to start from
Integer	$length:	The number of characters

Redefined in descendants as:

atkClusterDb::func_substring()
atkOci8Db::func_substring() : Retrieve this drivers' specific SQL implementation of a substring function.

[ Top ]

getAtkDbErrno [line 373]

int getAtkDbErrno(
)

Get generic atk errorccode

API Tags:

Return:

One of the ATK DB_* codes.

Redefined in descendants as:

atkClusterDb::getAtkDbErrno()
atkOci8Db::getAtkDbErrno() : Get last error code.

[ Top ]

getDbErrno [line 385]

mixed getDbErrno(
)

Get vendor-dependent database error number.

Applications should not rely on this method, if they want to be database independent.

API Tags:

Return:

Database dependent error code.

Redefined in descendants as:

atkClusterDb::getDbErrno()

[ Top ]

getDbError [line 397]

String getDbError(
)

Get vendor-dependent database error message.

Applications should not rely on this method, if they want to be database independent.

API Tags:

Return:

Database dependent error message.

Redefined in descendants as:

atkClusterDb::getDbError()

[ Top ]

getDbStatus [line 1259]

DB_SUCCESS getDbStatus(
)

Check if current db is present and acceptable for current user

API Tags:

Return:

Redefined in descendants as:

atkClusterDb::getDbStatus()

[ Top ]

getErrorMsg [line 462]

String getErrorMsg(
)

Get localized error message (for display in the application)

API Tags:

Return:

Error message

Redefined in descendants as:

atkClusterDb::getErrorMsg()
atkMsSqlDb::getErrorMsg() : Get localized error message (for display in the application)

[ Top ]

getErrorType [line 360]

String getErrorType(
)

Determine whether an error that occurred is a recoverable (user) error or a system error.

API Tags:

Return:

"user" or "system"

Redefined in descendants as:

atkClusterDb::getErrorType()
atkMysqlDb::getErrorType() : Determine whether an error that occurred is a recoverable (user) error or a system error.

[ Top ]

getQueryMode [line 421]

string getQueryMode(
string
$query 
)

Returns the query mode

Parameters:

string

$query:

API Tags:

Return:

Return r or w mode

Redefined in descendants as:

atkClusterDb::getQueryMode()

[ Top ]

getrows [line 766]

array getrows(
string
$query, [int
$offset = -1], [int
$limit = -1] 
)

Get all rows that are the result of a certain specified query

Note: This is not an efficient way to retrieve records, as this will load all records into one array into memory. If you retrieve a lot of records, you might hit the memory_limit and your script will die.

Parameters:

string	$query:	The query
int	$offset:	The offset to use
int	$limit:	The limit to use

API Tags:

Return:

array with rows

Redefined in descendants as:

atkClusterDb::getrows()
atkMockDb::getrows() : Get all rows that are the result of a certain specified query
atkMsSqlDb::getrows() : Get all rows that are the result of a certain specified query

[ Top ]

getSearchModes [line 825]

array getSearchModes(
)

This function indicates what searchmodes the database supports.

API Tags:

Return:

with search modes

Redefined in descendants as:

atkClusterDb::getSearchModes()
atkMysqlDb::getSearchModes() : This function indicates what searchmodes the database supports.
atkPgsqlDb::getSearchModes() : This function indicates what searchmodes the database supports.

[ Top ]

getType [line 333]

String getType(
)

Get the database driver type.

API Tags:

Return:

driver type

Redefined in descendants as:

atkClusterDb::getType()

[ Top ]

getValue [line 785]

mixed getValue(
string
$query, [mixed
$default = null] 
)

Get a single value (first row, first column) from a certain specified query

Parameters:

string	$query:	The query
mixed	$default:	A default value which will be returned if the query doesn't return a result

API Tags:

Return:

Either the result of the query or the default value

Redefined in descendants as:

atkClusterDb::getValue()

[ Top ]

getValues [line 808]

array getValues(
string
$query, [string
$key = 0], [int
$offset = -1], [int
$limit = -1] 
)

Get an array with all the values in the (first) column.

Parameters:

string	$query:	The query
string	$key:	You can change the returning column using this parameter
int	$offset:	The offset to use
int	$limit:	The limit to use

API Tags:

Return:

array with rows

Redefined in descendants as:

atkClusterDb::getValues()

[ Top ]

halt [line 504]

void halt(
[String
$message = ""] 
)

If haltonerror is set, this will raise an atkerror. If not, it will place the error in atkdebug and continue.

Parameters:

String

$message:

API Tags:

Access:

protected

Redefined in descendants as:

atkClusterDb::halt()

[ Top ]

hasError [line 350]

void hasError(
)

Has error?

Redefined in descendants as:

atkClusterDb::hasError()

[ Top ]

hasMode [line 1215]

bool hasMode(
string
$mode 
)

Check if the current instance has the given mode

Parameters:

string

$mode:

The mode we want to check

API Tags:

Return:	True or False
Access:	public

Redefined in descendants as:

atkClusterDb::hasMode() : Returns nodes that have a specific mode set

[ Top ]

init [line 1189]

atkDb init(
[String
$connectionname = 'default'], [String
$mode = 'r'] 
)

(Re)Initialise a database driver with a connection

Parameters:

String	$connectionname:	The connectionname
String	$mode:	The mode to connect with

API Tags:

Access:

public

Redefined in descendants as:

atkClusterDb::init() : Initialize the atkClusterDb

[ Top ]

link_id [line 342]

Connection link_id(
)

Get the current connection.

API Tags:

Return:

resource id

Redefined in descendants as:

atkClusterDb::link_id()

[ Top ]

lock [line 654]

boolean lock(
String
$table, [String
$mode = "write"] 
)

Lock a table in the database.

Parameters:

String	$table:	The name of the table to lock.
String	$mode:	The lock type.

API Tags:

Return:	True if succesful, false if not.
Abstract:

Redefined in descendants as:

atkClusterDb::lock()
atkMysqlDb::lock() : Lock a certain table in the database
atkMsSqlDb::lock() : Lock a certain table in the database
atkMysqliDb::lock() : Lock a certain table in the database
atkOci8Db::lock() : Lock a table in the database.
atkPgsqlDb::lock() : Lock a certain table in the database

[ Top ]

maxIdentifierLength [line 1023]

Integer maxIdentifierLength(
)

Returns the maximum length an identifier (tablename, columnname, etc) may have

API Tags:

Return:

The maximum identifier length

Redefined in descendants as:

atkClusterDb::maxIdentifierLength()
atkOci8Db::maxIdentifierLength() : Returns the maximum length an identifier (tablename, columnname, etc) for this driver may have.

[ Top ]

metadata [line 724]

array metadata(
string
$table, [bool
$full = false] 
)

Return the meta data of a certain table HIE GEBLEVEN

depending on $full, metadata returns the following values: -full is false (default): $result[]: [0]["table"] table name [0]["name"] field name [0]["type"] field type [0]["len"] field length [0]["flags"] field flags

-full is true: $result[]: ["num_fields"] number of metadata records [0]["table"] table name [0]["name"] field name [0]["type"] field type [0]["len"] field length [0]["flags"] field flags ["meta"][field name] index of field named "field name" The last one is used, if you have a field name, but no index.

Parameters:

string	$table:	the table name
bool	$full:	all meta data or not

API Tags:

Return:

with meta data

Redefined in descendants as:

atkClusterDb::metadata()
atkMysqlDb::metadata() : Return the meta data of a certain table
atkMsSqlDb::metadata() : Return the meta data of a certain table
atkMysqliDb::metadata() : Return the meta data of a certain table
atkOci8Db::metadata() : Return the meta data of a certain table
atkPgsqlDb::metadata() : Return the meta data of a certain table

[ Top ]

nextid [line 693]

int nextid(
string
$sequence 
)

Get the next sequence number of a certain sequence.

If the sequence does not exist, it is created automatically.

Parameters:

string

$sequence:

The sequence name

API Tags:

Return:	The next sequence value
Abstract:

Redefined in descendants as:

atkClusterDb::nextid() : Gets the next available id
atkMockDb::nextid() : returns nextid When the sequence isn't set the value 1 is returned.
atkMysqlDb::nextid() : Get the next sequence number of a certain sequence.
atkMsSqlDb::nextid() : Get the next sequence number of a certain sequence.
atkMysqliDb::nextid() : Get the next sequence number of a certain sequence.
atkOci8Db::nextid() : Get the next sequence number of a certain sequence.
atkPgsqlDb::nextid() : Get the next sequence number of a certain sequence.

[ Top ]

next_record [line 641]

mixed next_record(
)

Retrieve the next record in the resultset.

API Tags:

Return:	An array containing the record, or 0 if there are no more records to retrieve.
Abstract:

Redefined in descendants as:

atkClusterDb::next_record()
atkMysqlDb::next_record() : Goto the next record in the result set
atkMsSqlDb::next_record() : Goto the next record in the result set
atkMysqliDb::next_record() : Goto the next record in the result set
atkOci8Db::next_record() : Retrieve the next record in the resultset.
atkPgsqlDb::next_record() : Goto the next record in the result set

[ Top ]

query [line 630]

void query(
String
$query, [int
$offset = -1], [int
$limit = -1] 
)

Parse and execute a query.

If the query is a select query, the rows can be retrieved using the next_record() method.

Parameters:

String	$query:	The SQL query to execute
int	$offset:	Retrieve the results starting at the specified record number. Pass -1 or 0 to start at the first record.
int	$limit:	Indicates how many rows to retrieve. Pass -1 to retrieve all rows.

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::query() : Query method, first detects the query mode (read/write) and connects to the proper database before executing the query on it.
atkMockDb::query() : Parse and execute a query.
atkMysqlDb::query() : Performs a query
atkMsSqlDb::query() : Performs a query
atkMysqliDb::query() : Performs a query
atkOci8Db::query() : Parse and execute a query.
atkOci9Db::query() : Performs a query
atkPgsqlDb::query() : Performs a query

[ Top ]

query_id [line 526]

Resource query_id(
)

Get the current query statement resource id.

API Tags:

Return:

Query statement resource id.

Redefined in descendants as:

atkClusterDb::query_id()

[ Top ]

quoteIdentifier [line 1288]

string quoteIdentifier(
string
$str 
)

Quote Indentifier

Parameters:

string

$str:

Redefined in descendants as:

atkClusterDb::quoteIdentifier()

[ Top ]

rollback [line 612]

void rollback(
[string
$savepoint = ""] 
)

Rollback the current transaction.

(If a savepoint is given to the given savepoint.)

Parameters:

string

$savepoint:

savepoint name

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::rollback()
atkMsSqlDb::rollback() : Rollback the the current transaction.
atkMysqliDb::rollback() : Rollback the the current transaction.
atkOci8Db::rollback() : Rollback the the current transaction.

[ Top ]

savepoint [line 600]

void savepoint(
string
$name 
)

Set savepoint with the given name.

Parameters:

string

$name:

savepoint name

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::savepoint()
atkMysqliDb::savepoint() : Set savepoint with the given name.
atkOci8Db::savepoint() : Set savepoint with the given name.

[ Top ]

setHaltOnError [line 1249]

void setHaltOnError(
[Bool
$state = true] 
)

Halt on error or not?

Parameters:

Bool

$state:

Redefined in descendants as:

atkClusterDb::setHaltOnError()

[ Top ]

setInstance [line 1232]

void &setInstance(
string
$name, 
&$db, object
$db 
)

Replace the current instance of a named connection at runtime with a different connection. This is useful for example for replacing a named database instance with a mock object for testing purposes.

Parameters:

string	$name:
object	$db:
	&$db:

Redefined in descendants as:

atkClusterDb::setInstance()

[ Top ]

setSequenceValue [line 258]

void setSequenceValue(
string
$seqname, int
$value 
)

Set database sequence value.

Parameters:

string	$seqname:	sequence name
int	$value:	sequence value

API Tags:

Abstract:

Redefined in descendants as:

atkClusterDb::setSequenceValue() : Because we extend atkDb __call won't be called for the atkDb public methods as they
atkMysqlDb::setSequenceValue() : Set database sequence value.
atkOci8Db::setSequenceValue() : Set sequence value.

[ Top ]

setUserError [line 409]

void setUserError(
mixed
$errno 
)

Define custom user error codes.

Error codes passed to this method will be treated as recoverable user errors.

Parameters:

mixed

$errno:

Vendor-dependent database error code

Redefined in descendants as:

atkClusterDb::setUserError()

[ Top ]

tableExists [line 747]

bool tableExists(
string
$tableName 
)

This function checks the database for a table with the provide name

Parameters:

string

$tableName:

the table to find

API Tags:

Return:

true if found, false if not found

Redefined in descendants as:

atkClusterDb::tableExists()
atkMysqlDb::tableExists() : This function checks the database for a table with the provide name
atkOci8Db::tableExists() : This function checks in the database if a table exists.
atkPgsqlDb::tableExists() : Check if table exists.

[ Top ]

tableMeta [line 839]

array tableMeta(
string
$table 
)

Fetches table meta data from database

Parameters:

string

$table:

API Tags:

Access:

public

Redefined in descendants as:

atkClusterDb::tableMeta()

[ Top ]

table_names [line 735]

array table_names(
[boolean
$includeViews = true] 
)

Return the available table names

Parameters:

boolean

$includeViews:

include views?

API Tags:

Return:

with table names etc.

Redefined in descendants as:

atkClusterDb::table_names()
atkMysqlDb::table_names() : Return the available table names
atkMsSqlDb::table_names() : Return the available table names
atkMysqliDb::table_names() : Return the available table names
atkOci8Db::table_names() : Return a list of all table names in the current connection.
atkPgsqlDb::table_names() : Return the available table names

[ Top ]

toggleForeignKeys [line 1059]

void toggleForeignKeys(
boolean
$enable 
)

Enable/disable all foreign key constraints.

Parameters:

boolean

$enable:

enable/disable foreign keys?

Redefined in descendants as:

atkClusterDb::toggleForeignKeys()
atkMysqliDb::toggleForeignKeys() : Enable/disable all foreign key constraints.
atkOci8Db::toggleForeignKeys() : Enable/disable all foreign key constraints.

[ Top ]

unlock [line 665]

boolean unlock(
)

Relieve all locks.

API Tags:

Return:	True if succesful, false if not.
Abstract:

Redefined in descendants as:

atkClusterDb::unlock()
atkMysqlDb::unlock() : Unlock table(s) in the database
atkMsSqlDb::unlock() : Unlock table(s) in the database
atkMysqliDb::unlock() : Unlock table(s) in the database
atkOci8Db::unlock() : Relieve all locks.
atkPgsqlDb::unlock() : Unlock table(s) in the database

[ Top ]

vendorDateFormat [line 996]

String vendorDateFormat(
String
$format 
)

Convert a php date() format specifier to a vendor specific format specifier.

The default implementation returns the format as used by many database vendors ('YYYYMMDD HH24:MI'). Databases that use different formatting, should override this method.

Note that currently, only the common specifiers Y, m, d, H, h, i and s are supported.

Parameters:

String

$format:

Format specifier. The format is compatible with php's date() function (http://www.php.net/date)

API Tags:

Return:

Vendor specific format specifier.

Redefined in descendants as:

atkClusterDb::vendorDateFormat()
atkMysqlDb::vendorDateFormat() : Convert a php date() format specifier to a mysql specific format specifier.

[ Top ]

_getTableMetaFromCache [line 865]

array _getTableMetaFromCache(
string
$table 
)

If cached it'll return the table metadata from cache.

Parameters:

string

$table:

API Tags:

Access:

private

[ Top ]

_getTableMetaFromDb [line 889]

array _getTableMetaFromDb(
string
$table 
)

Returns the tablemetadata directly from db

Parameters:

string

$table:

API Tags:

Access:

protected

[ Top ]

_translateError [line 573]

int _translateError(
mixed
$errno 
)

Translate database-vendor dependent error messages into an ATK generic error code.

Derived classes should implement this method and translate their error codes.

Parameters:

mixed

$errno:

Vendor-dependent error code.

API Tags:

Return:	ATK error code
Access:	private

Redefined in descendants as:

atkClusterDb::_translateError()
atkMysqlDb::_translateError() : Translates known database errors to developer-friendly messages
atkMsSqlDb::_translateError() : Translate database-vendor dependent error messages into an ATK generic error code.
atkOci8Db::_translateError() : Translate a driver specific error to a generic ATK db error code.
atkPgsqlDb::_translateError() : TODO FIXME: I don't know what errormessges postgresql gives, so this function only returns DB_UNKNOWNERROR for now.

[ Top ]