icms_db_Connection

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_db_Connection

Database connection

• Class name: icms_db_Connection
• Namespace:
• Parent class: Aura\Sql\ExtendedPdo
• This class implements: icms_db_IConnection, icms_db_legacy_IDatabase

Properties

$prefix

protected string $prefix

Database prefix

• Visibility: protected

$lastRowCount

protected int $lastRowCount

Last row count

• Visibility: protected

Methods

escape

mixed icms_db_IConnection::escape(mixed string)

Safely escape the string, but strips the outer quotes This is a legacy method

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• string mixed

query

\icms_db_Statement icms_db_IConnection::query(mixed statement, mixed fetch)

Executes an SQL statement and returns a result set as a IStatement object.

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• statement mixed
• fetch mixed

queryF

resource icms_db_legacy_IDatabase::queryF(string sql, int limit, int start)

perform a query on the database

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• sql string - <p>a valid MySQL query</p>
• limit int - <p>number of records to return</p>
• start int - <p>offset of first record to return</p>

setLogger

mixed icms_db_legacy_IDatabase::setLogger(\icms_core_Logger logger)

assign a logger to the database

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• logger icms_core_Logger - <p>reference to a logger object</p>

setPrefix

mixed icms_db_legacy_IDatabase::setPrefix(string value)

set the prefix for tables in the database

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• value string - <p>table prefix</p>

prefix

string icms_db_legacy_IDatabase::prefix(string tablename)

attach the prefix.'_' to a given tablename.

if tablename is empty, only prefix will be returned

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• tablename string - <p>tablename</p>

genId

int icms_db_legacy_IDatabase::genId(string sequence)

generate an ID for a new row

This is for compatibility only. Will always return 0, because MySQL supports autoincrement for primary keys.

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• sequence string - <p>name of the sequence from which to get the next ID</p>

fetchRow

array icms_db_legacy_IDatabase::fetchRow(resource result)

Get a result row as an enumerated array

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result resource

fetchArray

array icms_db_legacy_IDatabase::fetchArray(mixed result)

Fetch a result row as an associative array

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result mixed

fetchBoth

array icms_db_legacy_IDatabase::fetchBoth(mixed result)

Fetch a result row as an associative array and numerical array

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result mixed

getInsertId

int icms_db_legacy_IDatabase::getInsertId()

Get the ID generated from the previous INSERT operation

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

getRowsNum

int icms_db_legacy_IDatabase::getRowsNum(mixed result)

Get number of rows in result

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result mixed

getAffectedRows

int icms_db_legacy_IDatabase::getAffectedRows()

Get number of affected rows

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

close

mixed icms_db_legacy_IDatabase::close()

Closes MySQL connection

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

freeRecordSet

bool icms_db_legacy_IDatabase::freeRecordSet(mixed result)

will free all memory associated with the result identifier result.

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result mixed

error

string icms_db_legacy_IDatabase::error()

Returns the text of the error message from previous MySQL operation

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

errno

int icms_db_legacy_IDatabase::errno()

Returns the numerical value of the error message from previous MySQL operation

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

quoteString

string icms_db_legacy_IDatabase::quoteString(string str)

Returns escaped string text with single quotes around it to be safely stored in database

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• str string - <p>unescaped string text</p>

getFieldName

string icms_db_legacy_IDatabase::getFieldName(resource result, mixed offset)

Get field name

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result resource - <p>query result</p>
• offset mixed

getFieldType

string icms_db_legacy_IDatabase::getFieldType(resource result, int offset)

Get field type

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result resource - <p>query result</p>
• offset int - <p>numerical field index</p>

getFieldsNum

int icms_db_legacy_IDatabase::getFieldsNum(resource result)

Get number of fields in result

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• result resource - <p>query result</p>

getServerVersion

string icms_db_Connection::getServerVersion()

Gets server version

• Visibility: public

setAttribute

bool icms_db_IConnection::setAttribute(int attribute, mixed value)

Set the value of a database connection attribute.

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• attribute int
• value mixed

getAttribute

mixed icms_db_IConnection::getAttribute(int attribute)

Return the value of a database connection attribute.

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• attribute int

errorCode

mixed icms_db_IConnection::errorCode()

Last error as an SQLSTATE, a five characters alphanumeric identifier.

• Visibility: public
• This method is defined by icms_db_IConnection

errorInfo

array icms_db_IConnection::errorInfo()

Get an array of error information about the last operation.

• Visibility: public
• This method is defined by icms_db_IConnection

quote

string icms_db_legacy_IDatabase::quote(mixed string)

Quotes a string for use in a query using mysql_real_escape_string.

• Visibility: public
• This method is defined by icms_db_legacy_IDatabase

Arguments

• string mixed

beginTransaction

bool icms_db_IConnection::beginTransaction()

Turns off autocommit mode and starts recording transaction.

• Visibility: public
• This method is defined by icms_db_IConnection

commit

bool icms_db_IConnection::commit()

Commits current transaction.

• Visibility: public
• This method is defined by icms_db_IConnection

rollBack

bool icms_db_IConnection::rollBack()

Rolls back current transaction.

• Visibility: public
• This method is defined by icms_db_IConnection

prepare

\icms_db_Statement icms_db_IConnection::prepare(string sql, array options)

Prepares an SQL statement

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• sql string
• options array

exec

int icms_db_IConnection::exec(string sql)

Executes an SQL statement and returns the number of affected rows.

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• sql string

lastInsertId

string icms_db_IConnection::lastInsertId(string name)

Returns the ID of the last inserted row or the last value from a sequence object.

• Visibility: public
• This method is defined by icms_db_IConnection

Arguments

• name string