- added better documentation

This commit is contained in:
steinm 2011-01-28 07:31:25 +00:00
parent 0cd5f795a3
commit bece6cec98

View File

@ -43,16 +43,29 @@ class LetoDMS_Core_DatabaseAccess {
Backup functions Backup functions
*/ */
function TableList() /**
{ * Return list of all database tables
*
* This function is used to retrieve a list of database tables for backup
*
* @return array list of table names
*/
function TableList() {
return $this->_conn->MetaTables("TABLES"); return $this->_conn->MetaTables("TABLES");
} }
/** /**
* Konstruktor * Constructor of LetoDMS_Core_DatabaseAccess
*
* Sets all database parameters but does not connect.
*
* @param string $driver the database type e.g. mysql, sqlite
* @param string $hostname host of database server
* @param string $user name of user having access to database
* @param string $passw password of user
* @param string $database name of database
*/ */
function LetoDMS_Core_DatabaseAccess($driver, $hostname, $user, $passw, $database = false) function LetoDMS_Core_DatabaseAccess($driver, $hostname, $user, $passw, $database = false) {
{
$this->_driver = $driver; $this->_driver = $driver;
$this->_hostname = $hostname; $this->_hostname = $hostname;
$this->_database = $database; $this->_database = $database;