Docs For Class atkOci8Db

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_user atkDb::$m_user_error	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_user

atkDb::$m_user_error

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

String	$m_type
mixed	$m_vendor

[ Top ]

Method Summary

atkOci8Db	atkOci8Db()	Default constructor
int	affected_rows()	Retrieve the number of rows affected by the last query.
void	commit()	Commit the current transaction.
int	connect()	Connect to the database.
void	disconnect()	Disconnect from database.
String	escapeSQL()	Escape a string for use in SQL queries.
unknown	func_concat()	Retrieve this drivers' specific SQL implementation of a concat() function.
String	func_now()	Retrieve this drivers' specific SQL implementation of a now() function.
void	func_substring()	Retrieve this drivers' specific SQL implementation of a substring function.
int	getAtkDbErrno()	Get last error code.
boolean	lock()	Lock a table in the database.
int	maxIdentifierLength()	Returns the maximum length an identifier (tablename, columnname, etc) for this driver may have.
array	metadata()	Return the meta data of a certain table
int	nextid()	Get the next sequence number of a certain sequence.
mixed	next_record()	Retrieve the next record in the resultset.
number	num_fields()	Evaluatie the result; how many fields where affected by the query.
int	num_rows()	Retrieve the number of rows in the resultset.
void	query()	Parse and execute a query.
Bool	rollback()	Rollback the the current transaction.
void	savepoint()	Set savepoint with the given name.
void	seek()	Skip to a certain position in the result set for subsequent calls to next_record().
void	setSequenceValue()	Set sequence value.
boolean	tableExists()	This function checks in the database if a table exists.
array	table_names()	Return a list of all table names in the current connection.
void	toggleForeignKeys()	Enable/disable all foreign key constraints.
boolean	unlock()	Relieve all locks.
int	_translateError()	Translate a driver specific error to a generic ATK db error code.

[ Top ]

Properties

String $m_type = "oci8" [line 33]

API Tags:

Access:

private

Redefinition of:

atkDb::$m_type: Driver name.

Redefined in descendants as:

[ Top ]

mixed $m_vendor = "oracle" [line 34]

Redefinition of:

atkDb::$m_vendor: Vendor.

[ Top ]

Methods

Constructor atkOci8Db [line 39]

atkOci8Db atkOci8Db(
)

Default constructor

[ Top ]

affected_rows [line 379]

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

Redefinition of:

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

[ Top ]

commit [line 156]

void commit(
)

Commit the current transaction.

Redefinition of:

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

[ Top ]

connect [line 50]

int connect(
)

Connect to the database.

API Tags:

Return:

One of the generic DB_ connection statusses.

Redefinition of:

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

Redefined in descendants as:

atkOci9Db::connect() : Connect to the database

[ Top ]

disconnect [line 126]

void disconnect(
)

Disconnect from database.

Redefinition of:

atkDb::disconnect(): Disconnect from database

[ Top ]

escapeSQL [line 688]

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

Escape a string for use in SQL queries.

This driver's implementation escapes single quotes and optionally, wildcards. Wildcards should be escaped if they appear as regular characters inside a string. When actually searching for wildcards, those wildcards should not be escaped.

Parameters:

String	$string:	The string to escape.
boolean	$wildcard:	Set to true to convert wildcard chars ('%'). False will leave them unescaped.

API Tags:

Return:

A SQL compatible version of the input string.

Redefinition of:

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

[ Top ]

func_concat [line 701]

unknown func_concat(
array
$fields 
)

Retrieve this drivers' specific SQL implementation of a concat() function.

Parameters:

array

$fields:

API Tags:

Access:

public

Redefinition of:

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

[ Top ]

func_now [line 641]

String func_now(
)

Retrieve this drivers' specific SQL implementation of a now() function.

Redefinition of:

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

[ Top ]

func_substring [line 659]

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

Retrieve this drivers' specific SQL implementation of a substring function.

Note that this function does not actually perform a substring operation. It just returns a piece of valid SQL code that can be used in a query.

Parameters:

String	$fieldname:	The name of the field to perform a substring operation on.
int	$startat:	The character at which to start.
int	$length:	The number of charachters to retrieve.

Redefinition of:

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

[ Top ]

getAtkDbErrno [line 95]

int getAtkDbErrno(
)

Get last error code.

If an error occurred, this method can be called to retrieve the generic error code.

API Tags:

Return:

One of the generic DB_* statusses.

Redefinition of:

atkDb::getAtkDbErrno(): Get generic atk errorccode

[ Top ]

lock [line 333]

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. Note that this driver only supports "write".

API Tags:

Return:

True if succesful, false if not.

Redefinition of:

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

[ Top ]

maxIdentifierLength [line 669]

int maxIdentifierLength(
)

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

Redefinition of:

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

[ Top ]

metadata [line 510]

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

Return the meta data of a certain table

Parameters:

String	$table:	The name of the table
boolean	$full:	If set to true, more metadata is retrieved than when set to false.

API Tags:

Return:

The retrieved metadata. See documentation for atkDb::metadata() for information about the structure of the returned array.

Redefinition of:

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

[ Top ]

nextid [line 426]

int nextid(
string
$sequence 
)

Get the next sequence number of a certain sequence.

If the sequence does not exist, it is created automatically. For this to work, the database user should have the 'create sequence' privilege. The name of the sequence in the database is prefixed with the string that's configured in $config_database_sequenceprefix.

Example If the database contains a sequence named "seq_employees", the following call will retrieve the next value from the sequence:

$id = $db->nextid("employees");

Parameters:

string

$sequence:

The sequence name

API Tags:

Return:

The next sequence value

Redefinition of:

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

[ Top ]

next_record [line 271]

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.

Redefinition of:

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

[ Top ]

num_fields [line 402]

number num_fields(
)

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

API Tags:

Return:

of affected fields

[ Top ]

num_rows [line 392]

int num_rows(
)

Retrieve the number of rows in the resultset.

After calling query() to perform a select statement, this method will return the number of rows in the resultset.

API Tags:

Return:

The number of rows in the resultset.

[ Top ]

query [line 212]

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.

Redefinition of:

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

Redefined in descendants as:

atkOci9Db::query() : Performs a query

[ Top ]

rollback [line 184]

Bool rollback(
[String
$savepoint = ""] 
)

Rollback the the current transaction.

Parameters:

String

$savepoint:

API Tags:

Return:

true

Redefinition of:

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

[ Top ]

savepoint [line 172]

void savepoint(
string
$name 
)

Set savepoint with the given name.

Parameters:

string

$name:

savepoint name

API Tags:

Abstract:

Redefinition of:

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

[ Top ]

seek [line 318]

void seek(
[int
$position = 0] 
)

Skip to a certain position in the result set for subsequent calls to next_record().

Calling seek() with no parameters places the pointer to the first record in the resultset.

Parameters:

int

$position:

The number of the record to skip to.

[ Top ]

setSequenceValue [line 472]

void setSequenceValue(
string
$sequence, int
$value 
)

Set sequence value.

Parameters:

string	$sequence:
int	$value:

Redefinition of:

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

[ Top ]

tableExists [line 631]

boolean tableExists(
String
$table 
)

This function checks in the database if a table exists.

Parameters:

String

$table:

The name of the table to check.

API Tags:

Return:

True if the table exists, false if not.

Redefinition of:

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

[ Top ]

table_names [line 607]

array table_names(
)

Return a list of all table names in the current connection.

API Tags:

Return:

The array containing the names of the tables.

Redefinition of:

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

[ Top ]

toggleForeignKeys [line 140]

void toggleForeignKeys(
bool
$enable 
)

Enable/disable all foreign key constraints.

Parameters:

bool

$enable:

enable/disable foreign keys?

Redefinition of:

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

[ Top ]

unlock [line 366]

boolean unlock(
)

Relieve all locks.

The oracle 8i driver has no way to unlock other than committing the current transaction. So be careful with calling this function; any outstanding transaction will be committed.

API Tags:

Return:

True if succesful, false if not.

Redefinition of:

atkDb::unlock(): Relieve all locks.

[ Top ]

_translateError [line 108]

int _translateError(
Array
$err 
)

Translate a driver specific error to a generic ATK db error code.

Parameters:

Array

$err:

Error code.

API Tags:

Return:	One of the generic DB_* constants
Access:	private

Redefinition of:

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

[ Top ]