common/common.inc.php File Reference


Functions

 changeUserPW ()
 resetDB ()
 changeUserInfo ()
 setEnvVar ()
 resetAllDB ()
 echoUserTable ($sUserID, $sLastName, $sFirstName, $sFieldOfStudy, $sEmail, $sLastLogin)
 writeConfig ($sDBSystem, $sDBHost, $sDBPort, $sDBInstance, $sDBAdminUser, $sDBAdminPw, $sLanguage, $sDataDir, $sRegPassword, $sMaxNumResults, $bEmailSupport, $sTitle, $sEmail, $bNewFile)

Detailed Description

Common functions
Offers common functionality for elSQL.

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/

Function Documentation

changeUserInfo (  ) 

Changes the user information of the logged in user.

Returns:
Array with status information (ret: true or false, mes: message).

changeUserPW (  ) 

Changes the user password of the logged in user.

Returns:
Array with status information (ret: true or false, mes: message).

echoUserTable ( sUserID,
sLastName,
sFirstName,
sFieldOfStudy,
sEmail,
sLastLogin 
)

Returns the HTML code for the user administration table.

Parameters:
$sUserID User ID.
$sLastName Last name of the user.
$sFirstName First name of the user.
$sFieldOfStudy Field of study of the user.
$sEmail E-mail of the user.
$sLastLogin Date of last login.
Returns:
Echo HTML code.

resetAllDB (  ) 

Resetting all user databases.

Returns:
Array with status information (ret: true or false, mes: message).

resetDB (  ) 

Resets a user database of the logged in user.

Returns:
Array with status information (ret: true or false, mes: message).

setEnvVar (  ) 

Setting new environment vairables and writ configuration file.

Returns:
Array with status information (ret: true or false, mes: message).

writeConfig ( sDBSystem,
sDBHost,
sDBPort,
sDBInstance,
sDBAdminUser,
sDBAdminPw,
sLanguage,
sDataDir,
sRegPassword,
sMaxNumResults,
bEmailSupport,
sTitle,
sEmail,
bNewFile 
)

Writes the configuration file.

Parameters:
$sDBSystem Database system identifier (e.g. "mysql", "pgsql" a.s.o.).
$sDBHost Database host.
$sDBPort Port on which database is listening.
$sDBInstance Name of the database instance.
$sDBAdminUser Database and elSQL administrator user name.
$sDBAdminPw Database and elSQL administrator password.
$sLanguage Selected frontend language.
$sDataDir Data directory.
$sRegPassword Registration password.
$sMaxNumResults Maximum number of shown rows in result sets.
$bEmailSupport True if server is capable to send e-mails, otherwise false.
$sTitle Title of this application, normally the university name.
$sEmail Administrator e-mail address.
$bNewFile Set true to create a new file, false to edit the existing file.
Returns:
True on success, otherwise false.


Generated on Sun Dec 2 19:47:27 2007 for elSQL - e-learn SQL by  doxygen 1.5.3