Docs For Class myMVC_DatabaseConnector

Description

Generic database connector.

It should not be used directly! Classes, derived from this, will be called from myMVC_BaseDB and derived to manage data in the database.

Located in /myMVC/DatabaseConnector.php (line 29)

myMVC_TypeCheck
   |
   --myMVC_DatabaseConnector

Direct descendents

Class	Description
myMVC_DatabaseConnectorPgsql	Database connector for PostgreSQL (http://www.postgresql.org/)
myMVC_DatabaseConnectorMysql	Database connector for MySQL (http://www.mysql.com/)
myMVC_BaseDB	Base class for a database table's class Every table must have a derived class with the check function Example:

Variable Summary

mixed $database

mixed $engine

mixed $login

mixed $password

mixed $server

Method Summary

myMVC_DatabaseConnector __construct ()

int errno ()

string error ()

boolean execute (string $query)

resource executeSelect (string $query)

boolean freeResult (resource $result)

resource getDatabaseConnection ()

int getRowsNum (resource $result)

array getValueArrayFromResult (resource $result)

array getValuesFromResult (resource $result)

string quoteSqlString (string $value)

string quoteSqlStringForLike (string $value, [string $prefix = '%'], [string $suffix = '%'])

Variables

mixed $database (line 34)

access: protected

mixed $engine (line 35)

access: protected

Redefined in descendants as:

myMVC_BaseDB::$engine

mixed $login (line 32)

access: protected

mixed $password (line 33)

access: protected

mixed $server (line 31)

access: protected

Methods

Constructor __construct (line 43)

Constructor. Initializes the database connection

WARNING: This function will only called from myMVC_BaseDB constructor, using the proper derived class (see: myMVC_DatabaseConnectorMysql and myMVC_DatabaseConnectorPgsql)

access: protected

myMVC_DatabaseConnector __construct ()

Redefined in descendants as:

myMVC_BaseDB::__construct() : Constructor
myMVC_GenericSQL::__construct() : Constructor.
myMVC_SessionDB::__construct() : Constructor.

errno (line 59)

Wrapper for the errno-function of the selected database engine

return: the error number
access: protected

int errno ()

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::errno() : Wrapper for the errno-function of the selected database engine
myMVC_DatabaseConnectorMysql::errno() : Wrapper for the errno-function of the selected database engine

error (line 69)

Wrapper for the error-function of the selected database engine

return: the error string
access: protected

string error ()

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::error() : Wrapper for the error-function of the selected database engine
myMVC_DatabaseConnectorMysql::error() : Wrapper for the error-function of the selected database engine

execute (line 117)

Execute an INSERT, UPDATE or DELETE query

return: true on success, false on failure, last inserted ID on successfully INSERT
access: protected

boolean execute (string $query)

string $query: The SQL-Query

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::execute() : Execute an INSERT, UPDATE or DELETE query
myMVC_DatabaseConnectorMysql::execute() : Execute an INSERT, UPDATE or DELETE query

executeSelect (line 128)

Executes a SELECT-Query

return: a resource to get data on success, false otherwise
access: protected

resource executeSelect (string $query)

string $query: The SQL-Query

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::executeSelect() : Executes a SELECT-Query
myMVC_DatabaseConnectorMysql::executeSelect() : Executes a SELECT-Query

freeResult (line 172)

Free the allocated memory for the SQL query.

return: true on success, false on problem
access: protected

boolean freeResult (resource $result)

resource $result: The resource

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::freeResult() : Free the allocated memory for the SQL query.
myMVC_DatabaseConnectorMysql::freeResult() : Free the allocated memory for the SQL query.

getDatabaseConnection (line 81)

Connects to the database.

This will just be done, if no connection exists yet.

return: a connection resource
throws: myMVC_DatabaseException if no connection is possible
access: protected

resource getDatabaseConnection ()

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::getDatabaseConnection() : Connects to the database.
myMVC_DatabaseConnectorMysql::getDatabaseConnection() : Connects to the database.

getRowsNum (line 161)

Returns the number of row of the runned query.

return: The row's number
access: protected

int getRowsNum (resource $result)

resource $result: The resource

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::getRowsNum() : Returns the number of row of the runned query.
myMVC_DatabaseConnectorMysql::getRowsNum() : Returns the number of row of the runned query.

getValueArrayFromResult (line 139)

Returns a record as associative array, or NULL if no record can be returned.

return: The record
access: protected

array getValueArrayFromResult (resource $result)

resource $result: The resource

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::getValueArrayFromResult() : Returns a record as associative array, or NULL if no record can be returned.
myMVC_DatabaseConnectorMysql::getValueArrayFromResult() : Returns a record as associative array, or NULL if no record can be returned.

getValuesFromResult (line 150)

Returns a record as numeric array, or NULL if no record can be returned.

return: The record
access: protected

array getValuesFromResult (resource $result)

resource $result: The resource

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::getValuesFromResult() : Returns a record as numeric array, or NULL if no record can be returned.
myMVC_DatabaseConnectorMysql::getValuesFromResult() : Returns a record as numeric array, or NULL if no record can be returned.

quoteSqlString (line 93)

Quotes a string to use in a SQL-Query

return: A secure SQL-String (quoted)
access: protected

string quoteSqlString (string $value)

string $value: The string with the Query

quoteSqlStringForLike (line 106)

Quotes a string to use in a SQL-Query (with LIKE)

return: A secure SQL-String (quoted)
access: protected

string quoteSqlStringForLike (string $value, [string $prefix = '%'], [string $suffix = '%'])

string $value: The string with the Query
string $prefix: (normally %) added BEFORE the string
string $suffix: (normally %) added AFTER the string

Redefined in descendants as:

myMVC_DatabaseConnectorPgsql::quoteSqlStringForLike() : Quotes a string to use in a SQL-Query (with LIKE)
myMVC_DatabaseConnectorMysql::quoteSqlStringForLike() : Quotes a string to use in a SQL-Query (with LIKE)

Inherited Methods

Inherited From myMVC_TypeCheck

myMVC_TypeCheck::checkAutoIncrementalId()
myMVC_TypeCheck::checkBoolNotNull()
myMVC_TypeCheck::checkBoolNull()
myMVC_TypeCheck::checkDateNotNull()
myMVC_TypeCheck::checkDateNull()
myMVC_TypeCheck::checkDateTimeNotNull()
myMVC_TypeCheck::checkDateTimeNull()
myMVC_TypeCheck::checkDomainnameNotNull()
myMVC_TypeCheck::checkDomainnameNull()
myMVC_TypeCheck::checkEMailNotNull()
myMVC_TypeCheck::checkEMailNull()
myMVC_TypeCheck::checkIPNotNull()
myMVC_TypeCheck::checkIPNull()
myMVC_TypeCheck::checkMacNotNull()
myMVC_TypeCheck::checkMacNull()
myMVC_TypeCheck::checkMaskNotNull()
myMVC_TypeCheck::checkMaskNull()
myMVC_TypeCheck::checkNetworkNotNull()
myMVC_TypeCheck::checkNetworkNull()
myMVC_TypeCheck::checkSignedIntNotNull()
myMVC_TypeCheck::checkSignedIntNull()
myMVC_TypeCheck::checkSignedMediumIntNotNull()
myMVC_TypeCheck::checkSignedMediumIntNull()
myMVC_TypeCheck::checkSignedSmallIntNotNull()
myMVC_TypeCheck::checkSignedSmallIntNull()
myMVC_TypeCheck::checkSignedTinyIntNotNull()
myMVC_TypeCheck::checkSignedTinyIntNull()
myMVC_TypeCheck::checkString255NotNull()
myMVC_TypeCheck::checkString255Null()
myMVC_TypeCheck::checkTextNotNull()
myMVC_TypeCheck::checkTextNull()
myMVC_TypeCheck::checkTimeNotNull()
myMVC_TypeCheck::checkTimeNull()
myMVC_TypeCheck::checkUnsignedIntNotNull()
myMVC_TypeCheck::checkUnsignedIntNull()
myMVC_TypeCheck::checkUnsignedMediumIntNotNull()
myMVC_TypeCheck::checkUnsignedMediumIntNull()
myMVC_TypeCheck::checkUnsignedSmallIntNotNull()
myMVC_TypeCheck::checkUnsignedSmallIntNull()
myMVC_TypeCheck::checkUnsignedTinyIntNotNull()
myMVC_TypeCheck::checkUnsignedTinyIntNull()
myMVC_TypeCheck::checkURLNotNull()
myMVC_TypeCheck::checkURLNull()