Docs For Class atkMysqlDb

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_identifierQuoting
mixed	$m_seq_field
mixed	$m_seq_namefield
mixed	$m_seq_table
mixed	$m_type

[ Top ]

Method Summary

affected	affected_rows()	Evaluate the result; which rows were affected by the query.
void	atkmysqldb()	Base constructor
void	disconnect()	Disconnect from database
mixed	doConnect()	Connect to the database
void	dropAll()	Drop all database tables.
void	escapeSQL()	Escaping a MySQL string, in a mysqli safe way
String	func_datetimetochar()	Get TO_CHAR() equivalent for the current database.
String	func_datetochar()	Get TO_CHAR() equivalent for the current database.
false\|string	getColumnLength()	Mysql_field_len returns unusable results for decimal,float and double column types.
String	getErrorType()	Determine whether an error that occurred is a recoverable (user) error or a system error.
array	getSearchModes()	This function indicates what searchmodes the database supports.
result	lock()	Lock a certain table in the database
void	locktables_fallback_on_error()	This method provides a fallback when error 1100 occurs (Table ... not locked using LOCK TABLES). This method locks the table and runs the query again.
array	metadata()	Return the meta data of a certain table
the	nextid()	Get the next sequence number of a certain sequence.
result	next_record()	Goto the next record in the result set
number	num_fields()	Evaluatie the result; how many fields where affected by the query.
number	num_rows()	Evaluate the result; how many rows were affected by the query.
void	query()	Performs a query
void	seek()	Goto a certain position in result set.
void	setSequenceValue()	Set database sequence value.
boolean	tableExists()	This function checks the database for a table with the provide name
array	table_names()	Return the available table names
result	unlock()	Unlock table(s) in the database
String	vendorDateFormat()	Convert a php date() format specifier to a mysql specific format specifier.
string	_getTableType()	Returns the table type.
void	_setErrorVariables()	Store MySQL errors in internal variables
int	_translateError()	Translates known database errors to developer-friendly messages

[ Top ]

Properties

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

API Tags:

Access:

protected

Redefinition of:

atkDb::$m_identifierQuoting: Indentifier Quoting

[ Top ]

mixed $m_seq_field = "nextid" [line 32]

[ Top ]

mixed $m_seq_namefield = "seq_name" [line 34]

[ Top ]

mixed $m_seq_table = "db_sequence" [line 30]

[ Top ]

mixed $m_type = "mysql" [line 36]

Redefinition of:

atkDb::$m_type: Driver name.

[ Top ]

Methods

affected_rows [line 376]

affected affected_rows(
)

Evaluate the result; which rows were affected by the query.

API Tags:

Return:

rows

Redefinition of:

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

Redefined in descendants as:

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.

[ Top ]

atkmysqldb [line 44]

void atkmysqldb(
)

Base constructor

[ Top ]

disconnect [line 158]

void disconnect(
)

Disconnect from database

Redefinition of:

atkDb::disconnect(): Disconnect from database

Redefined in descendants as:

atkMsSqlDb::disconnect() : Disconnect from database
atkMysqliDb::disconnect() : Disconnect from database

[ Top ]

doConnect [line 69]

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

Connect to the database

Parameters:

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

API Tags:

Return:

Connection status

Redefinition of:

atkDb::doConnect(): Connect to the database

Redefined in descendants as:

atkMysqliDb::doConnect() : Connect to the database

[ Top ]

dropAll [line 455]

void dropAll(
)

Drop all database tables.

Redefinition of:

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

[ Top ]

escapeSQL [line 173]

void escapeSQL(
string
$string, [bool
$wildcard = false] 
)

Escaping a MySQL string, in a mysqli safe way

Parameters:

string	$string:
bool	$wildcard:

Redefinition of:

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

Redefined in descendants as:

atkMysqliDb::escapeSQL() : Escaping a MySQL string, in a mysqli safe way

[ Top ]

func_datetimetochar [line 706]

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

Redefinition of:

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

[ Top ]

func_datetochar [line 673]

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

Redefinition of:

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

[ Top ]

getColumnLength [line 573]

false|string getColumnLength(
string
$tableName, string
$columnName, string
$columnType 
)

Mysql_field_len returns unusable results for decimal,float and double column types.

This method returns a number format, e.g.: '6,2' or false in case of failure OR if the field type does not support a floating point (e.g. for integer fields) so it can fall back on mysql_field_len()

Parameters:

string	$tableName:
string	$columnName:
string	$columnType:

API Tags:

Return:	e.g. '6,2'
Access:	public

[ Top ]

getErrorType [line 108]

String getErrorType(
)

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

API Tags:

Return:

"user" or "system"

Redefinition of:

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

[ Top ]

getSearchModes [line 654]

array getSearchModes(
)

This function indicates what searchmodes the database supports.

API Tags:

Return:

with search modes

Redefinition of:

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

[ Top ]

lock [line 329]

result lock(
string
$table, [string
$mode = "write"] 
)

Lock a certain table in the database

Parameters:

string	$table:	the table name
string	$mode:	the type of locking

API Tags:

Return:

of locking

Redefinition of:

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

Redefined in descendants as:

atkMsSqlDb::lock() : Lock a certain table in the database
atkMysqliDb::lock() : Lock a certain table in the database

[ Top ]

locktables_fallback_on_error [line 259]

void locktables_fallback_on_error(
string
$query, [string
$querymode = 'w'] 
)

This method provides a fallback when error 1100 occurs (Table ... not locked using LOCK TABLES). This method locks the table and runs the query again.

Parameters:

string	$query:	The original query that failed
string	$querymode:	Kind of query - 'w' for write or 'r' for read

Redefined in descendants as:

atkMysqliDb::locktables_fallback_on_error() : This method provides a fallback when error 1100 occurs (Table ... not locked using LOCK TABLES). This method locks the table and runs the query again.

[ Top ]

metadata [line 483]

array metadata(
String
$table, [boolean
$full = false] 
)

Return the meta data of a certain table

Parameters:

String	$table:	the table name (optionally in 'database.tablename' format)
boolean	$full:	all meta data or not

API Tags:

Return:

with meta data

Redefinition of:

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

Redefined in descendants as:

atkMsSqlDb::metadata() : Return the meta data of a certain table
atkMysqliDb::metadata() : Return the meta data of a certain table

[ Top ]

nextid [line 407]

the nextid(
string
$sequence 
)

Get the next sequence number of a certain sequence.

Parameters:

string

$sequence:

the sequence name

API Tags:

Return:

next sequence id

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]

next_record [line 290]

result next_record(
)

Goto the next record in the result set

API Tags:

Return:

of going to the next record

Redefinition of:

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

Redefined in descendants as:

atkMsSqlDb::next_record() : Goto the next record in the result set
atkMysqliDb::next_record() : Goto the next record in the result set

[ Top ]

num_fields [line 396]

number num_fields(
)

Evaluatie the result; how many fields where affected by the query.

API Tags:

Return:

of affected fields

Redefined in descendants as:

atkMsSqlDb::num_fields() : Evaluatie the result; how many fields where affected by the query.
atkMysqliDb::num_fields() : Evaluatie the result; how many fields where affected by the query.

[ Top ]

num_rows [line 386]

number num_rows(
)

Evaluate the result; how many rows were affected by the query.

API Tags:

Return:

of affected rows

Redefined in descendants as:

atkMsSqlDb::num_rows() : Evaluate the result; how many rows were affected by the query.
atkMysqliDb::num_rows() : Evaluate the result; how many rows were affected by the query.

[ Top ]

query [line 192]

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

Performs a query

Parameters:

string	$query:	the query
int	$offset:	offset in record list
int	$limit:	maximum number of records

Redefinition of:

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

Redefined in descendants as:

atkMsSqlDb::query() : Performs a query
atkMysqliDb::query() : Performs a query

[ Top ]

seek [line 316]

void seek(
[int
$position = 0] 
)

Goto a certain position in result set.

Not specifying a position will set the pointer at the beginning of the result set.

Parameters:

int

$position:

the position

Redefined in descendants as:

atkMsSqlDb::seek() : Goto a certain position in result set.
atkMysqliDb::seek() : Goto a certain position in result set.

[ Top ]

setSequenceValue [line 717]

void setSequenceValue(
string
$seqname, int
$value 
)

Set database sequence value.

Parameters:

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

Redefinition of:

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

[ Top ]

tableExists [line 644]

boolean tableExists(
String
$table 
)

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

Parameters:

String

$table:

the table to find

API Tags:

Return:

true if found, false if not found

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]

table_names [line 619]

array table_names(
)

Return the available table names

API Tags:

Return:

with table names etc.

Redefinition of:

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

Redefined in descendants as:

atkMsSqlDb::table_names() : Return the available table names
atkMysqliDb::table_names() : Return the available table names

[ Top ]

unlock [line 356]

result unlock(
)

Unlock table(s) in the database

API Tags:

Return:

of unlocking

Redefinition of:

atkDb::unlock(): Relieve all locks.

Redefined in descendants as:

atkMsSqlDb::unlock() : Unlock table(s) in the database
atkMysqliDb::unlock() : Unlock table(s) in the database

[ Top ]

vendorDateFormat [line 689]

String vendorDateFormat(
String
$format 
)

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

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:

Mysql specific format specifier.

Redefinition of:

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

[ Top ]

_getTableType [line 471]

string _getTableType(
string
$table 
)

Returns the table type.

Parameters:

string

$table:

table name

API Tags:

Return:

table type

Redefined in descendants as:

atkMysqliDb::_getTableType() : Returns the table type.

[ Top ]

_setErrorVariables [line 141]

void _setErrorVariables(
)

Store MySQL errors in internal variables

API Tags:

Access:

private

Redefined in descendants as:

atkMysqliDb::_setErrorVariables() : Store MySQL errors in internal variables

[ Top ]

_translateError [line 119]

int _translateError(
)

Translates known database errors to developer-friendly messages

API Tags:

Return:

Flag of the error

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]