mysql Class Reference

Inheritance diagram for mysql:

iDatabase

List of all members.

Public Member Functions

 __construct ()
 __destruct ()
 connectDB ($sHost, $sPort, $sDBName, $sUser, $sPassword)
 connectDBAdmin ()
 connectDBUser ($sUser, $sPassword)
 closeDB ()
 executeTransaction ($pQueryArray)
 executeSQL ($sQuery)
 getNextRecord ()
 hasMoreFields ()
 getNextField ()
 getNextFieldDescription ()
 getAffectedRows ()
 getNumberRows ()
 getNumberFields ()
 getLastError ()
 getLastErrorNo ()
 escapeString ($sString)


Detailed Description

mySQL database handler.

Author:
Stephan Schuetz, stephan.schuetz(at)fhnw.ch
Date:
14.10.2007
Version:
1.0
(c) Copyright GITTA 2007. Creative Commons License "Attribution-Noncommercial-Share Alike" http://creativecommons.org/licenses/by-nc-sa/3.0/

Constructor & Destructor Documentation

mysql::__construct (  ) 

Constructor

mysql::__destruct (  ) 

Destructor


Member Function Documentation

mysql::connectDB ( sHost,
sPort,
sDBName,
sUser,
sPassword 
)

Connects to the database server.

Parameters:
$sHost Hostname or IP adress of database server.
$sPort Port of database server.
$sDBName Database instance name.
$sUser User name to connect.
$sPassword Password to user name.
Returns:
True on success, otherwise false.

Implements iDatabase.

mysql::connectDBAdmin (  ) 

Connect administrator to database.

Returns:
True on success, otherwise false.

Implements iDatabase.

mysql::connectDBUser ( sUser,
sPassword 
)

Connect user to database.

Parameters:
$sUser User name.
$sPassword Password.
Returns:
True on success, otherwise false.

Implements iDatabase.

mysql::closeDB (  ) 

Frees result and close the database connection.

Returns:
True on success, otherwise false.

Implements iDatabase.

mysql::executeTransaction ( pQueryArray  ) 

Executes a transaction (array with SQL statements).

Parameters:
$pQueryArray 
Returns:
True on success, otherwise false.

Implements iDatabase.

mysql::executeSQL ( sQuery  ) 

Executes a single query.

Parameters:
$sQuery 
Returns:
True on success, otherwise false.

Implements iDatabase.

mysql::getNextRecord (  ) 

Get next record, free result set if no more recors are available.

Returns:
True if there are more records, otherwise false.

Implements iDatabase.

mysql::hasMoreFields (  ) 

Check if there are more fields in the result set.

Returns:
True if there are more fields, otherwise false.

Implements iDatabase.

mysql::getNextField (  ) 

Get next field data.

Returns:
Data.

Implements iDatabase.

mysql::getNextFieldDescription (  ) 

Get next field description.

Returns:
Array with the field name and with the lenght of the field in the database or, if this is not available the length of the name.

Implements iDatabase.

mysql::getAffectedRows (  ) 

Get number of affected rows by insert, update a.s.o.

Returns:
Number of affected rows.

Implements iDatabase.

mysql::getNumberRows (  ) 

Get number of rows in result set.

Returns:
Number of rows.

Implements iDatabase.

mysql::getNumberFields (  ) 

Get number of fields in result set.

Returns:
Number of fields.

Implements iDatabase.

mysql::getLastError (  ) 

Get last database error.

Returns:
Database error as string.

Implements iDatabase.

mysql::getLastErrorNo (  ) 

Get last database error number.

Returns:
Database error number.

Implements iDatabase.

mysql::escapeString ( sString  ) 

Escapes string for security reasons.

Parameters:
$sString String to escape.
Returns:
Escaped string.

Implements iDatabase.


The documentation for this class was generated from the following file:
Generated on Sun Dec 2 19:47:28 2007 for elSQL - e-learn SQL by  doxygen 1.5.3