Docs For Class atkClusterDb

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_identifierQuoting 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_type 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::getInstance() Get database instance. atkDb::getMapping() Returns the current database mapping. atkDb::getQueryMode() Returns the query mode atkDb::getrows() Get all rows that are the result of a certain specified query 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 (first row, first column) from a certain specified query atkDb::getValues() Get an array with all the values in the (first) column. 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::query() Parse and execute a query. atkDb::query_id() Get the current query statement resource id. atkDb::quoteIdentifier() Quote Indentifier 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::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_identifierQuoting

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_type

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::getInstance()

Get database instance.

atkDb::getMapping()

Returns the current database mapping.

atkDb::getQueryMode()

Returns the query mode

atkDb::getrows()

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

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 (first row, first column) from a certain specified query

atkDb::getValues()

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

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::query()

Parse and execute a query.

atkDb::query_id()

Get the current query statement resource id.

atkDb::quoteIdentifier()

Quote Indentifier

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

atkDb	$m_current_clusternode	Cluster node (database) that we are currently proxying for
mixed	$m_name
mixed	$m_nodes_config
array	$m_readonly_nodes_config	Array of read-only slaves
array	$m_writeonly_nodes_config	Array of write-only slaves

[ Top ]

Method Summary

static mixed	__callStatic()	Magic callstatic function
void	affected_rows()
void	clearMapping()
void	cloneAll()
void	commit()
bool	connect()	Connects to a cluster node and sets the node as "current node"
atkDDL	createDDL()	Creates a new new atkDDL based on current cluster nodes type
object	createQuery()	Creates a new a new query object based on the current nodes type
void	deleteAll()
void	disconnect()
void	doConnect()
void	dropAll()
void	errorLookup()
void	escapeSQL()
void	func_concat()
void	func_concat_ws()
void	func_datetimetochar()
void	func_datetochar()
void	func_now()
void	func_substring()
void	getAtkDbErrno()
void	getDbErrno()
void	getDbError()
void	getDbStatus()
void	getErrorMsg()
void	getErrorType()
void	&getInstance()
void	getMapping()
void	getQueryMode()
void	getrows()
void	getSearchModes()
void	getTranslatedDatabaseName()
void	getType()
void	getValue()
void	getValues()
void	halt()
void	hasError()
array	hasMode()	Returns nodes that have a specific mode set
void	init()	Initialize the atkClusterDb
void	link_id()
void	lock()
void	maxIdentifierLength()
void	metadata()
int	nextid()	Gets the next available id
void	next_record()
bool	query()	Query method, first detects the query mode (read/write) and connects to the proper database before executing the query on it.
void	query_id()
void	quoteIdentifier()
void	rollback()
void	savepoint()
void	setConfig()	Sets config and mode for all configured nodes
void	setCurrentClusterNode()	Sets a random cluster node as the current node based on the mode provided
void	setHaltOnError()
void	&setInstance()
void	setNodeConfig()	Sets the config and mode for a named node
void	setRandomNodeFromNodeConfigs()	Selects a random node from the node configuration based on the mode.
void	setSequenceValue()	Because we extend atkDb __call won't be called for the atkDb public methods as they
void	setUserError()
void	tableExists()
void	tableMeta()
void	table_names()
void	toggleForeignKeys()
void	unlock()
void	useMapping()
void	vendorDateFormat()
void	_getOrUseMapping()
void	_translateError()
mixed	__call()	Magic call function
void	__get()	Gets a value from current nodes properties based on key
bool	__isset()	Checks if current node has the property set
void	__set()	Allows setting key/value pairs for the current node
void	__unset()	Magic unset function

[ Top ]

Properties

atkDb $m_current_clusternode [line 50]

Cluster node (database) that we are currently proxying for

API Tags:

Access:

protected

[ Top ]

mixed $m_name [line 28]

API Tags:

Access:

protected

[ Top ]

mixed $m_nodes_config = array() [line 43]

API Tags:

Access:

protected

[ Top ]

array $m_readonly_nodes_config = array() [line 35]

Array of read-only slaves

API Tags:

Access:

protected

[ Top ]

array $m_writeonly_nodes_config = array() [line 42]

Array of write-only slaves

API Tags:

Access:

protected

[ Top ]

Methods

static method __callStatic [line 311]

static mixed __callStatic(
string
$name, array
$arguments 
)

Magic callstatic function

Parameters:

string	$name:
array	$arguments:

API Tags:

Access:

public

[ Top ]

affected_rows [line 355]

void affected_rows(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

clearMapping [line 330]

void clearMapping(
)

API Tags:

Access:

public

Redefinition of:

atkDb::clearMapping(): Clear the current database mapping.

[ Top ]

cloneAll [line 376]

void cloneAll(
)

API Tags:

Access:

public

Redefinition of:

atkDb::cloneAll(): Clones the database structure of the given database to this database. This also means the complete database is emptied beforehand.

[ Top ]

commit [line 349]

void commit(
)

API Tags:

Access:

public

Redefinition of:

atkDb::commit(): Commit the current transaction.

[ Top ]

connect [line 79]

bool connect(
[string
$mode = 'rw'] 
)

Connects to a cluster node and sets the node as "current node"

Parameters:

string

$mode:

Mode can be r, w or rw

API Tags:

Return:	Whether the connect succeded or not
Access:	public

Redefinition of:

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

[ Top ]

createDDL [line 147]

atkDDL createDDL(
)

Creates a new new atkDDL based on current cluster nodes type

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

createQuery [line 134]

object createQuery(
)

Creates a new a new query object based on the current nodes type

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

deleteAll [line 374]

void deleteAll(
)

API Tags:

Access:

public

Redefinition of:

atkDb::deleteAll(): Empty all database tables.

[ Top ]

disconnect [line 348]

void disconnect(
)

API Tags:

Access:

public

Redefinition of:

atkDb::disconnect(): Disconnect from database

[ Top ]

doConnect [line 346]

void doConnect(

$host, 
$user, 
$password, 
$database, 
$port, 
$charset 
)

Parameters:

	$host:
	$user:
	$password:
	$database:
	$port:
	$charset:

API Tags:

Access:

public

Redefinition of:

atkDb::doConnect(): Connect to the database

[ Top ]

dropAll [line 375]

void dropAll(
)

API Tags:

Access:

public

Redefinition of:

atkDb::dropAll(): Drop all database tables.

[ Top ]

errorLookup [line 342]

void errorLookup(
)

API Tags:

Access:

public

Redefinition of:

atkDb::errorLookup(): Looks up the error

[ Top ]

escapeSQL [line 372]

void escapeSQL(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

func_concat [line 367]

void func_concat(
)

API Tags:

Access:

public

Redefinition of:

atkDb::func_concat(): Get CONCAT() equivalent for the current database.

[ Top ]

func_concat_ws [line 368]

void func_concat_ws(
)

API Tags:

Access:

public

Redefinition of:

atkDb::func_concat_ws(): Get CONCAT_WS() equivalent for the current database.

[ Top ]

func_datetimetochar [line 370]

void func_datetimetochar(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

func_datetochar [line 366]

void func_datetochar(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

func_now [line 364]

void func_now(
)

API Tags:

Access:

public

Redefinition of:

atkDb::func_now(): get NOW() or SYSDATE() equivalent for the current database

[ Top ]

func_substring [line 365]

void func_substring(
)

API Tags:

Access:

public

Redefinition of:

atkDb::func_substring(): get SUBSTRING() equivalent for the current database.

[ Top ]

getAtkDbErrno [line 337]

void getAtkDbErrno(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getAtkDbErrno(): Get generic atk errorccode

[ Top ]

getDbErrno [line 338]

void getDbErrno(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getDbErrno(): Get vendor-dependent database error number.

[ Top ]

getDbError [line 339]

void getDbError(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getDbError(): Get vendor-dependent database error message.

[ Top ]

getDbStatus [line 380]

void getDbStatus(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getDbStatus(): Check if current db is present and acceptable for current user

[ Top ]

getErrorMsg [line 343]

void getErrorMsg(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

getErrorType [line 336]

void getErrorType(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

getInstance [line 377]

void &getInstance(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getInstance(): Get database instance.

[ Top ]

getMapping [line 329]

void getMapping(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getMapping(): Returns the current database mapping.

[ Top ]

getQueryMode [line 341]

void getQueryMode(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getQueryMode(): Returns the query mode

[ Top ]

getrows [line 359]

void getrows(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

getSearchModes [line 362]

void getSearchModes(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getSearchModes(): This function indicates what searchmodes the database supports.

[ Top ]

getTranslatedDatabaseName [line 331]

void getTranslatedDatabaseName(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getTranslatedDatabaseName(): Returns the real database name. If a mapping

[ Top ]

getType [line 333]

void getType(
)

API Tags:

Access:

public

Redefinition of:

atkDb::getType(): Get the database driver type.

[ Top ]

getValue [line 360]

void getValue(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

getValues [line 361]

void getValues(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

halt [line 344]

void halt(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

hasError [line 335]

void hasError(
)

API Tags:

Access:

public

Redefinition of:

atkDb::hasError(): Has error?

[ Top ]

hasMode [line 93]

array hasMode(
string
$mode 
)

Returns nodes that have a specific mode set

Parameters:

string

$mode:

Mode can be r, w or rw

API Tags:

Access:

public

Redefinition of:

atkDb::hasMode(): Check if the current instance has the given mode

[ Top ]

init [line 63]

void init(
string
$connectionname, [string
$mode = 'rw'] 
)

Initialize the atkClusterDb

Parameters:

string	$connectionname:	The name of the database connection
string	$mode:	Mode can be r, w or rw

API Tags:

Access:

public

Redefinition of:

atkDb::init(): (Re)Initialise a database driver with a connection

[ Top ]

link_id [line 334]

void link_id(
)

API Tags:

Access:

public

Redefinition of:

atkDb::link_id(): Get the current connection.

[ Top ]

lock [line 353]

void lock(
)

API Tags:

Access:

public

Redefinition of:

atkDb::lock(): Lock a table in the database.

[ Top ]

maxIdentifierLength [line 371]

void maxIdentifierLength(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

metadata [line 356]

void metadata(
)

API Tags:

Access:

public

Redefinition of:

atkDb::metadata(): Return the meta data of a certain table HIE GEBLEVEN

[ Top ]

nextid [line 161]

int nextid(
)

Gets the next available id

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

next_record [line 352]

void next_record(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

query [line 119]

bool query(
)

Query method, first detects the query mode (read/write) and connects to the proper database before executing the query on it.

API Tags:

Return:	Wether or not the query was executed successfully
Access:	public

Redefinition of:

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

[ Top ]

query_id [line 345]

void query_id(
)

API Tags:

Access:

public

Redefinition of:

atkDb::query_id(): Get the current query statement resource id.

[ Top ]

quoteIdentifier [line 381]

void quoteIdentifier(
)

API Tags:

Access:

public

Redefinition of:

atkDb::quoteIdentifier(): Quote Indentifier

[ Top ]

rollback [line 351]

void rollback(
)

API Tags:

Access:

public

Redefinition of:

atkDb::rollback(): Rollback the current transaction.

[ Top ]

savepoint [line 350]

void savepoint(
)

API Tags:

Access:

public

Redefinition of:

atkDb::savepoint(): Set savepoint with the given name.

[ Top ]

setConfig [line 176]

void setConfig(
)

Sets config and mode for all configured nodes

API Tags:

Access:

protected

[ Top ]

setCurrentClusterNode [line 215]

void setCurrentClusterNode(
string
$mode 
)

Sets a random cluster node as the current node based on the mode provided

Parameters:

string

$mode:

API Tags:

Access:

protected

[ Top ]

setHaltOnError [line 379]

void setHaltOnError(
)

API Tags:

Access:

public

Redefinition of:

atkDb::setHaltOnError(): Halt on error or not?

[ Top ]

setInstance [line 378]

void &setInstance(
)

API Tags:

Access:

public

Redefinition of:

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.

[ Top ]

setNodeConfig [line 200]

void setNodeConfig(
string
$nodename, array
$nodeconfig, string
$mode 
)

Sets the config and mode for a named node

Parameters:

string	$nodename:
array	$nodeconfig:
string	$mode:

API Tags:

Access:

protected

[ Top ]

setRandomNodeFromNodeConfigs [line 235]

void setRandomNodeFromNodeConfigs(
array
$nodeconfigs, string
$mode 
)

Selects a random node from the node configuration based on the mode.

Parameters:

array	$nodeconfigs:
string	$mode:

API Tags:

Access:

protected

[ Top ]

setSequenceValue [line 327]

void setSequenceValue(
)

Because we extend atkDb __call won't be called for the atkDb public methods as they

are already implemented. We can't not-extend atkDb because this would break typehinting (people are using atkDb as typehints everywhere). The most decent way to fix this issue would be to make atkDb into an interface and then have atkClusterDb and atkDb implement it (and use 'atkDbInterface' for typehinting instead of atkDb), but this would break backward compatibility (maybe other people use atkDb in their code as well for typehinting) and since atkClusterDb doesn't seem to be used very often anyway for now we just solved this issue using some vogon poetry. Continue reading at your own risk.

API Tags:

Access:

public

Redefinition of:

atkDb::setSequenceValue(): Set database sequence value.

[ Top ]

setUserError [line 340]

void setUserError(
)

API Tags:

Access:

public

Redefinition of:

atkDb::setUserError(): Define custom user error codes.

[ Top ]

tableExists [line 358]

void tableExists(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

tableMeta [line 363]

void tableMeta(
)

API Tags:

Access:

public

Redefinition of:

atkDb::tableMeta(): Fetches table meta data from database

[ Top ]

table_names [line 357]

void table_names(
)

API Tags:

Access:

public

Redefinition of:

atkDb::table_names(): Return the available table names

[ Top ]

toggleForeignKeys [line 373]

void toggleForeignKeys(
)

API Tags:

Access:

public

Redefinition of:

atkDb::toggleForeignKeys(): Enable/disable all foreign key constraints.

[ Top ]

unlock [line 354]

void unlock(
)

API Tags:

Access:

public

Redefinition of:

atkDb::unlock(): Relieve all locks.

[ Top ]

useMapping [line 328]

void useMapping(
)

API Tags:

Access:

public

Redefinition of:

atkDb::useMapping(): Use the given mapping to translate database requests from one database to another database. This can be used for test purposes.

[ Top ]

vendorDateFormat [line 369]

void vendorDateFormat(
)

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

_getOrUseMapping [line 332]

void _getOrUseMapping(
)

API Tags:

Access:

public

Redefinition of:

atkDb::_getOrUseMapping(): Get or set the database mapping

[ Top ]

_translateError [line 347]

void _translateError(
)

API Tags:

Access:

public

Redefinition of:

atkDb::_translateError(): Translate database-vendor dependent error messages into an ATK generic error code.

[ Top ]

__call [line 299]

mixed __call(
string
$name, array
$arguments 
)

Magic call function

Parameters:

string	$name:
array	$arguments:

API Tags:

Access:

public

[ Top ]

__get [line 266]

void __get(
string
$name 
)

Gets a value from current nodes properties based on key

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

__isset [line 277]

bool __isset(
string
$name 
)

Checks if current node has the property set

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

__set [line 255]

void __set(
string
$name, mixed
$value 
)

Allows setting key/value pairs for the current node

Parameters:

string	$name:
mixed	$value:

API Tags:

Access:

public

[ Top ]

__unset [line 287]

void __unset(
string
$name 
)

Magic unset function

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]