Docs For Class atkMockDb

Inherited Properties	Inherited Methods
Inherited From atkDb atkDb::$m_affected_rows atkDb::$m_auto_free atkDb::$m_charset atkDb::$m_collate atkDb::$m_connection atkDb::$m_database atkDb::$m_errno atkDb::$m_error atkDb::$m_errorLookup atkDb::$m_haltonerror atkDb::$m_host atkDb::$m_link_id atkDb::$m_mode atkDb::$m_password atkDb::$m_port atkDb::$m_query_id atkDb::$m_record atkDb::$m_row atkDb::$m_tableMeta atkDb::$m_user atkDb::$m_user_error atkDb::$m_vendor	Inherited From atkDb atkDb::affected_rows() Retrieve the number of rows affected by the last query. atkDb::clearMapping() Clear the current database mapping. atkDb::cloneAll() Clones the database structure of the given database to this database. This also means the complete database is emptied beforehand. atkDb::commit() Commit the current transaction. atkDb::connect() Connect to the database. atkDb::createDDL() Create an atkDDL object for constructing ddl queries. atkDb::createQuery() Create an atkQuery object for constructing queries. atkDb::deleteAll() Empty all database tables. atkDb::disconnect() Disconnect from database atkDb::doConnect() Connect to the database atkDb::dropAll() Drop all database tables. atkDb::errorLookup() Looks up the error atkDb::escapeSQL() escapes quotes for use in SQL: ' -> '' (and sometimes % -> %%) atkDb::func_concat() Get CONCAT() equivalent for the current database. atkDb::func_concat_ws() Get CONCAT_WS() equivalent for the current database. atkDb::func_datetimetochar() Get TO_CHAR() equivalent for the current database. atkDb::func_datetochar() Get TO_CHAR() equivalent for the current database. atkDb::func_now() get NOW() or SYSDATE() equivalent for the current database atkDb::func_substring() get SUBSTRING() equivalent for the current database. atkDb::getAtkDbErrno() Get generic atk errorccode atkDb::getDbErrno() Get vendor-dependent database error number. atkDb::getDbError() Get vendor-dependent database error message. atkDb::getDbStatus() Check if current db is present and acceptable for current user atkDb::getErrorMsg() Get localized error message (for display in the application) atkDb::getErrorType() Determine whether an error that occurred is a recoverable (user) error or a system error. atkDb::getHaltOnError() Halt on error? atkDb::getInstance() Get database instance. atkDb::getMapping() Returns the current database mapping. atkDb::getQueryId() Returns the current query resource. atkDb::getQueryMode() Returns the query mode atkDb::getRow() Returns the first row for the given query. atkDb::getRows() Get all rows for the given query. atkDb::getRowsAssoc() Get rows in an associative array with the given column used as key for the rows. atkDb::getSearchModes() This function indicates what searchmodes the database supports. atkDb::getTranslatedDatabaseName() Returns the real database name. If a mapping atkDb::getType() Get the database driver type. atkDb::getValue() Get a single value from a certain specified query atkDb::getValues() Get an array with all the values in the specified column. atkDb::getValuesAssoc() Get rows in an associative array with the given key column used as key and the given value column used as value. atkDb::halt() If haltonerror is set, this will raise an atkerror. If not, it will place the error in atkdebug and continue. atkDb::hasError() Has error? atkDb::hasMode() Check if the current instance has the given mode atkDb::init() (Re)Initialise a database driver with a connection atkDb::link_id() Get the current connection. atkDb::lock() Lock a table in the database. atkDb::maxIdentifierLength() Returns the maximum length an identifier (tablename, columnname, etc) may have atkDb::metadata() Return the meta data of a certain table HIE GEBLEVEN atkDb::nextid() Get the next sequence number of a certain sequence. atkDb::next_record() Retrieve the next record in the resultset. atkDb::prepare() Creates a new statement for the given query. atkDb::query() Parse and execute a query. atkDb::query_id() Get the current query statement resource id. atkDb::quoteIdentifier() Quote Indentifier atkDb::resetQueryId() Rests the query resource. atkDb::rollback() Rollback the current transaction. atkDb::savepoint() Set savepoint with the given name. atkDb::setHaltOnError() Halt on error or not? atkDb::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. atkDb::setQueryId() Sets the current query identifier used for next_record() etc. atkDb::setSequenceValue() Set database sequence value. atkDb::setUserError() Define custom user error codes. atkDb::tableExists() This function checks the database for a table with the provide name atkDb::tableMeta() Fetches table meta data from database atkDb::table_names() Return the available table names atkDb::toggleForeignKeys() Enable/disable all foreign key constraints. atkDb::unlock() Relieve all locks. atkDb::useMapping() Use the given mapping to translate database requests from one database to another database. This can be used for test purposes. atkDb::vendorDateFormat() Convert a php date() format specifier to a vendor specific format specifier. atkDb::_getOrUseMapping() Get or set the database mapping atkDb::_getTableMetaFromCache() If cached it'll return the table metadata from cache. atkDb::_getTableMetaFromDb() Returns the tablemetadata directly from db atkDb::_translateError() Translate database-vendor dependent error messages into an ATK generic error code.

Inherited Properties

Inherited Methods

Inherited From atkDb

atkDb::$m_affected_rows

atkDb::$m_auto_free

atkDb::$m_charset

atkDb::$m_collate

atkDb::$m_connection

atkDb::$m_database

atkDb::$m_errno

atkDb::$m_error

atkDb::$m_errorLookup

atkDb::$m_haltonerror

atkDb::$m_host

atkDb::$m_link_id

atkDb::$m_mode

atkDb::$m_password

atkDb::$m_port

atkDb::$m_query_id

atkDb::$m_record

atkDb::$m_row

atkDb::$m_tableMeta

atkDb::$m_user

atkDb::$m_user_error

atkDb::$m_vendor

Inherited From atkDb

atkDb::affected_rows()

Retrieve the number of rows affected by the last query.

atkDb::clearMapping()

Clear the current database mapping.

atkDb::cloneAll()

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

atkDb::commit()

Commit the current transaction.

atkDb::connect()

Connect to the database.

atkDb::createDDL()

Create an atkDDL object for constructing ddl queries.

atkDb::createQuery()

Create an atkQuery object for constructing queries.

atkDb::deleteAll()

Empty all database tables.

atkDb::disconnect()

Disconnect from database

atkDb::doConnect()

Connect to the database

atkDb::dropAll()

Drop all database tables.

atkDb::errorLookup()

Looks up the error

atkDb::escapeSQL()

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

atkDb::func_concat()

Get CONCAT() equivalent for the current database.

atkDb::func_concat_ws()

Get CONCAT_WS() equivalent for the current database.

atkDb::func_datetimetochar()

Get TO_CHAR() equivalent for the current database.

atkDb::func_datetochar()

Get TO_CHAR() equivalent for the current database.

atkDb::func_now()

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

atkDb::func_substring()

get SUBSTRING() equivalent for the current database.

atkDb::getAtkDbErrno()

Get generic atk errorccode

atkDb::getDbErrno()

Get vendor-dependent database error number.

atkDb::getDbError()

Get vendor-dependent database error message.

atkDb::getDbStatus()

Check if current db is present and acceptable for current user

atkDb::getErrorMsg()

Get localized error message (for display in the application)

atkDb::getErrorType()

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

atkDb::getHaltOnError()

Halt on error?

atkDb::getInstance()

Get database instance.

atkDb::getMapping()

Returns the current database mapping.

atkDb::getQueryId()

Returns the current query resource.

atkDb::getQueryMode()

Returns the query mode

atkDb::getRow()

Returns the first row for the given query.

atkDb::getRows()

Get all rows for the given query.

atkDb::getRowsAssoc()

Get rows in an associative array with the given column used as key for the rows.

atkDb::getSearchModes()

This function indicates what searchmodes the database supports.

atkDb::getTranslatedDatabaseName()

Returns the real database name. If a mapping

atkDb::getType()

Get the database driver type.

atkDb::getValue()

Get a single value from a certain specified query

atkDb::getValues()

Get an array with all the values in the specified column.

atkDb::getValuesAssoc()

Get rows in an associative array with the given key column used as key and the given value column used as value.

atkDb::halt()

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

atkDb::hasError()

Has error?

atkDb::hasMode()

Check if the current instance has the given mode

atkDb::init()

(Re)Initialise a database driver with a connection

atkDb::link_id()

Get the current connection.

atkDb::lock()

Lock a table in the database.

atkDb::maxIdentifierLength()

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

atkDb::metadata()

Return the meta data of a certain table HIE GEBLEVEN

atkDb::nextid()

Get the next sequence number of a certain sequence.

atkDb::next_record()

Retrieve the next record in the resultset.

atkDb::prepare()

Creates a new statement for the given query.

atkDb::query()

Parse and execute a query.

atkDb::query_id()

Get the current query statement resource id.

atkDb::quoteIdentifier()

Quote Indentifier

atkDb::resetQueryId()

Rests the query resource.

atkDb::rollback()

Rollback the current transaction.

atkDb::savepoint()

Set savepoint with the given name.

atkDb::setHaltOnError()

Halt on error or not?

atkDb::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.

atkDb::setQueryId()

Sets the current query identifier used for next_record() etc.

atkDb::setSequenceValue()

Set database sequence value.

atkDb::setUserError()

Define custom user error codes.

atkDb::tableExists()

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

atkDb::tableMeta()

Fetches table meta data from database

atkDb::table_names()

Return the available table names

atkDb::toggleForeignKeys()

Enable/disable all foreign key constraints.

atkDb::unlock()

Relieve all locks.

atkDb::useMapping()

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

atkDb::vendorDateFormat()

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

atkDb::_getOrUseMapping()

Get or set the database mapping

atkDb::_getTableMetaFromCache()

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

atkDb::_getTableMetaFromDb()

Returns the tablemetadata directly from db

atkDb::_translateError()

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

[ Top ]

Property Summary

mixed	$m_currentResult
mixed	$m_identifierQuoting
mixed	$m_next_ids
mixed	$m_query_history
mixed	$m_regex_results
mixed	$m_results
mixed	$m_tables
mixed	$m_type

[ Top ]

Method Summary

void	affected_rows()	Overriding the affected rows count to what was set.
void	clearNextId()	Clear the nextids array
void	clearQueryHistory()	Clear the query history.
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.
string	getLastQuery()	Returns the last executed query.
Array	getQueryHistory()	Retrieve the query history.
int	nextid()	returns nextid When the sequence isn't set the value 1 is returned.
mixed	next_record()	Retrieve the next record in the resultset.
void	query()	Parse and execute a query.
void	setAffectedRows()	Set the affected rows, expecting an array with rows
void	setNextId()	Set the next id
void	setRegexResult()	Set the regex result for the query
void	setResult()	Set the result for the query (to mock executing a query)
void	setTables()	Sets the tables in the database.
boolean	tableExists()	Returns whatever the given table exists in the database.

[ Top ]

Properties

mixed $m_currentResult = null [line 38]

API Tags:

Access:

private

[ Top ]

mixed $m_identifierQuoting = array('start' => '`', 'end' => '`', 'escape' => '`') [line 40]

API Tags:

Access:

protected

Redefinition of:

atkDb::$m_identifierQuoting: Indentifier Quoting

[ Top ]

mixed $m_next_ids = array() [line 35]

[ Top ]

mixed $m_query_history = array() [line 34]

[ Top ]

mixed $m_regex_results = array() [line 33]

[ Top ]

mixed $m_results = array() [line 32]

[ Top ]

mixed $m_tables = array() [line 36]

[ Top ]

mixed $m_type = "mock" [line 31]

Redefinition of:

atkDb::$m_type: Driver name.

[ Top ]

Methods

affected_rows [line 169]

void affected_rows(
)

Overriding the affected rows count to what was set.

API Tags:

Access:

public

Redefinition of:

atkDb::affected_rows(): Retrieve the number of rows affected by the last query.

[ Top ]

clearNextId [line 243]

void clearNextId(
)

Clear the nextids array

[ Top ]

clearQueryHistory [line 204]

void clearQueryHistory(
)

Clear the query history.

[ Top ]

connect [line 48]

int connect(
)

Connect to the database.

API Tags:

Return:	Connection status
Abstract:

Redefinition of:

atkDb::connect(): Connect to the database.

[ Top ]

createDDL [line 263]

atkDDL createDDL(
)

Create an atkDDL object for constructing ddl queries.

API Tags:

Return:

DDL object

Redefinition of:

atkDb::createDDL(): Create an atkDDL object for constructing ddl queries.

[ Top ]

createQuery [line 252]

atkQuery createQuery(
)

Create an atkQuery object for constructing queries.

API Tags:

Return:

Query class.

Redefinition of:

atkDb::createQuery(): Create an atkQuery object for constructing queries.

[ Top ]

getLastQuery [line 189]

string getLastQuery(
)

Returns the last executed query.

API Tags:

Return:

last executed query

[ Top ]

getQueryHistory [line 179]

Array getQueryHistory(
)

Retrieve the query history.

[ Top ]

nextid [line 227]

int nextid(
string
$sequence 
)

returns nextid When the sequence isn't set the value 1 is returned.

Parameters:

string

$sequence:

API Tags:

Return:

The nextid

Redefinition of:

atkDb::nextid(): Get the next sequence number of a certain sequence.

[ Top ]

next_record [line 113]

mixed next_record(
)

Retrieve the next record in the resultset.

API Tags:

Return:	An array containing the record, or false if there are no more records to retrieve.
Access:	public

Redefinition of:

atkDb::next_record(): Retrieve the next record in the resultset.

[ Top ]

query [line 67]

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:

Redefinition of:

atkDb::query(): Parse and execute a query.

[ Top ]

setAffectedRows [line 161]

void setAffectedRows(
array
$result 
)

Set the affected rows, expecting an array with rows

Parameters:

array

$result:

API Tags:

Access:

public

[ Top ]

setNextId [line 215]

void setNextId(
string
$sequence, int
$nextid 
)

Set the next id

Parameters:

string	$sequence:
int	$nextid:

[ Top ]

setRegexResult [line 151]

void setRegexResult(
mixed
$result, string
$regex, [int
$offset = -1], [int
$limit = -1] 
)

Set the regex result for the query

Parameters:

mixed	$result:
string	$regex:
int	$offset:
int	$limit:

[ Top ]

setResult [line 138]

void setResult(
mixed
$result, string
$query, [int
$offset = -1], [int
$limit = -1] 
)

Set the result for the query (to mock executing a query)

Parameters:

mixed	$result:
string	$query:
int	$offset:
int	$limit:

[ Top ]

setTables [line 276]

void setTables(
array
$tables 
)

Sets the tables in the database.

Parameters:

array

$tables:

table names

API Tags:

Access:

public

[ Top ]

tableExists [line 288]

boolean tableExists(
string
$table 
)

Returns whatever the given table exists in the database.

Parameters:

string

$table:

table name

API Tags:

Return:	table exists?
Access:	public

Redefinition of:

atkDb::tableExists(): This function checks the database for a table with the provide name

[ Top ]