| ILIAS
    Release_4_1_x_branch Revision 61804
    | 
Setup class. More...
 Inheritance diagram for ilSetup:
 Inheritance diagram for ilSetup: Collaboration diagram for ilSetup:
 Collaboration diagram for ilSetup:| Public Member Functions | |
| ilSetup ($a_auth, $a_auth_type) | |
| constructor | |
| setClient ($a_cl) | |
| Set Client. | |
| getClient () | |
| Get Client. | |
| init () | |
| init setup load settings from ilias.ini if exists and sets some constants | |
| saveNewClient () | |
| saves client.ini & updates client list in ilias.ini | |
| updateNewClient ($a_old_client_id) | |
| update client.ini & move data dirs does not work correctly at this time - DISABLED | |
| createDatabase ($a_collation="") | |
| create client database | |
| installDatabase () | |
| set the database data | |
| getline ($fp, $delim) | |
| readDump ($db, $file) | |
| execute a query | |
| checkIniFileExists () | |
| check if inifile exists | |
| checkWritable () | |
| check for writable directory | |
| checkCreatable ($a_dir=".") | |
| check for permission to create new folders in specified directory | |
| checkCookiesEnabled () | |
| check cookies enabled | |
| checkPHPVersion () | |
| check for PHP version | |
| checkMySQL () | |
| Check MySQL. | |
| checkAuth () | |
| check authentication status | |
| checkDom () | |
| Check MySQL. | |
| checkXsl () | |
| Check MySQL. | |
| checkGd () | |
| Check MySQL. | |
| checkMemoryLimit () | |
| Check Memory Limit. | |
| queryPreliminaries () | |
| preliminaries | |
| checkPreliminaries () | |
| check all prliminaries | |
| getPassword () | |
| get setup master password | |
| setPassword ($a_password) | |
| set setup master password | |
| loginAsClient ($a_auth_data) | |
| process client login | |
| loginAsAdmin ($a_password) | |
| process setup admin login | |
| newClient ($a_client_id=0) | |
| creates a client object in $this->client | |
| getStatus ($client=0) | |
| coumpute client status | |
| checkFinish (&$client) | |
| check if client setup was finished | |
| checkAccess (&$client) | |
| check client access status | |
| checkClientIni (&$client) | |
| check client ini status | |
| checkClientDatabase (&$client) | |
| check client db status | |
| checkClientSessionSettings (&$client, $a_as_bool=false) | |
| check client session config status | |
| checkClientLanguages (&$client) | |
| check client installed languages status | |
| checkClientContact (&$client) | |
| check client contact data status | |
| checkClientNIC (&$client) | |
| check client nic status | |
| isInstalled () | |
| check if client's db is installed | |
| isAuthenticated () | |
| check if current user is authenticated | |
| isAdmin () | |
| check if current user is admin | |
| saveMasterSetup ($a_formdata) | |
| saves intial settings | |
| updateMasterSettings ($a_formdata) | |
| updates settings | |
| checkToolsSetup ($a_formdata) | |
| check pathes to 3rd party software | |
| checkDataDirSetup ($a_formdata) | |
| check datadir path | |
| checkPasswordSetup ($a_formdata) | |
| check setup password | |
| checkLogSetup ($a_formdata) | |
| check log path | |
| getError () | |
| get Error message | |
| _ilSetup () | |
| destructor | |
| testConvert ($a_convert_path) | |
| Check convert program. | |
| testJava ($a_java_path) | |
| Check JVM. | |
| testLatex ($a_latex_url) | |
| Check latex cgi script. | |
| testZip ($a_zip_path) | |
| Check zip program. | |
| testUnzip ($a_unzip_path) | |
| Check unzip program. | |
| testHtmldoc ($a_htmldoc_path) | |
| Check htmldoc program. | |
| unzip ($a_file, $overwrite=false) | |
| unzip file | |
| setSessionSettings ($session_settings) | |
| saves session settings to db | |
| getSessionSettings () | |
| reads session settings from db | |
|  Public Member Functions inherited from PEAR | |
| PEAR ($error_class=null) | |
| Constructor. | |
| _PEAR () | |
| Destructor (the emulated type of...). | |
| & | getStaticProperty ($class, $var) | 
| If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. | |
| registerShutdownFunc ($func, $args=array()) | |
| Use this function to register a shutdown method for static classes. | |
| isError ($data, $code=null) | |
| Tell whether a value is a PEAR error. | |
| setErrorHandling ($mode=null, $options=null) | |
| Sets how errors generated by this object should be handled. | |
| expectError ($code= '*') | |
| This method is used to tell which errors you expect to get. | |
| popExpect () | |
| This method pops one element off the expected error codes stack. | |
| _checkDelExpect ($error_code) | |
| This method checks unsets an error code if available. | |
| delExpect ($error_code) | |
| This method deletes all occurences of the specified element from the expected error codes stack. | |
| & | raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false) | 
| This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. | |
| & | throwError ($message=null, $code=null, $userinfo=null) | 
| Simpler form of raiseError with fewer options. | |
| staticPushErrorHandling ($mode, $options=null) | |
| staticPopErrorHandling () | |
| pushErrorHandling ($mode, $options=null) | |
| Push a new error handler on top of the error handler options stack. | |
| popErrorHandling () | |
| Pop the last error handler used. | |
| loadExtension ($ext) | |
| OS independant PHP extension load. | |
| Data Fields | |
| $ini | |
| $ini_file_path | |
| $error = "" | |
| $ini_ilias_exists = false | |
| $ini_client_exists = false | |
| $setup_defaults | |
| $ilias_nic_server = "http://www.ilias.de/ilias-nic/index.php" | |
| $preliminaries_result = array() | |
| $preliminaries = true | |
| $SQL_FILE = "./setup/sql/ilias3.sql" | |
| $dsn = "" | |
| $db | |
| $setup_password | |
| $default_client | |
| $safe_mode | |
| $safe_mode_exec_dir | |
| $auth | |
| $access_mode | |
|  Data Fields inherited from PEAR | |
| $_debug = false | |
| $_default_error_mode = null | |
| $_default_error_options = null | |
| $_default_error_handler = '' | |
| $_error_class = 'PEAR_Error' | |
| $_expected_errors = array() | |
Setup class.
class to setup ILIAS first and maintain the ini-settings and the database
Definition at line 15 of file class.ilSetup.php.
| ilSetup::_ilSetup | ( | ) | 
destructor
Definition at line 1510 of file class.ilSetup.php.
| ilSetup::checkAccess | ( | & | $client | ) | 
check client access status
| object | client | 
Definition at line 879 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkAuth | ( | ) | 
check authentication status
Definition at line 513 of file class.ilSetup.php.
References $_SESSION.
| ilSetup::checkClientContact | ( | & | $client | ) | 
check client contact data status
| object | client | 
Definition at line 1043 of file class.ilSetup.php.
References $client, and ilUtil\is_email().
Referenced by getStatus().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkClientDatabase | ( | & | $client | ) | 
check client db status
| object | client | 
Definition at line 919 of file class.ilSetup.php.
References $client, and $ilDB.
Referenced by getStatus().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkClientIni | ( | & | $client | ) | 
check client ini status
| object | client | 
Definition at line 900 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkClientLanguages | ( | & | $client | ) | 
check client installed languages status
| object | client | 
Definition at line 1018 of file class.ilSetup.php.
Referenced by getStatus().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkClientNIC | ( | & | $client | ) | 
check client nic status
| object | client | 
Definition at line 1074 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkClientSessionSettings | ( | & | $client, | 
| $a_as_bool = false | |||
| ) | 
check client session config status
| object | client | 
Definition at line 977 of file class.ilSetup.php.
References $db, $ilDB, $query, $res, $row, DB_FETCHMODE_ASSOC, and ilSessionControl\getSettingFields().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::checkCookiesEnabled | ( | ) | 
check cookies enabled
Definition at line 450 of file class.ilSetup.php.
References $sess.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkCreatable | ( | $a_dir = "." | ) | 
check for permission to create new folders in specified directory
| string | directory | 
Definition at line 424 of file class.ilSetup.php.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkDataDirSetup | ( | $a_formdata | ) | 
check datadir path
| array | form data | 
Definition at line 1387 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, and ilUtil\stripSlashes().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::checkDom | ( | ) | 
Check MySQL.
Definition at line 528 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkFinish | ( | & | $client | ) | 
check if client setup was finished
| object | client | 
Definition at line 858 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkGd | ( | ) | 
Check MySQL.
Definition at line 571 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkIniFileExists | ( | ) | 
check if inifile exists
Definition at line 384 of file class.ilSetup.php.
| ilSetup::checkLogSetup | ( | $a_formdata | ) | 
check log path
| array | form data | 
Definition at line 1464 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::checkMemoryLimit | ( | ) | 
Check Memory Limit.
Definition at line 593 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkMySQL | ( | ) | 
Check MySQL.
Definition at line 491 of file class.ilSetup.php.
References $ilDB.
| ilSetup::checkPasswordSetup | ( | $a_formdata | ) | 
check setup password
| array | form data | 
Definition at line 1442 of file class.ilSetup.php.
| ilSetup::checkPHPVersion | ( | ) | 
check for PHP version
Definition at line 472 of file class.ilSetup.php.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkPreliminaries | ( | ) | 
check all prliminaries
Definition at line 650 of file class.ilSetup.php.
References queryPreliminaries().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::checkToolsSetup | ( | $a_formdata | ) | 
check pathes to 3rd party software
| array | form data | 
Definition at line 1254 of file class.ilSetup.php.
References ilUtil\stripSlashes(), testConvert(), testHtmldoc(), testJava(), testLatex(), testUnzip(), and testZip().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::checkWritable | ( | ) | 
check for writable directory
| string | directory | 
Definition at line 395 of file class.ilSetup.php.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::checkXsl | ( | ) | 
Check MySQL.
Definition at line 549 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::createDatabase | ( | $a_collation = "" | ) | 
create client database
Definition at line 222 of file class.ilSetup.php.
References $db, and MDB2\isError().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::getClient | ( | ) | 
Get Client.
Definition at line 132 of file class.ilSetup.php.
References $client.
| ilSetup::getError | ( | ) | 
get Error message
Definition at line 1492 of file class.ilSetup.php.
References $error.
| ilSetup::getline | ( | $fp, | |
| $delim | |||
| ) | 
Definition at line 285 of file class.ilSetup.php.
References $result.
Referenced by readDump().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::getPassword | ( | ) | 
get setup master password
Definition at line 670 of file class.ilSetup.php.
| ilSetup::getSessionSettings | ( | ) | 
reads session settings from db
Definition at line 1907 of file class.ilSetup.php.
References $db, $query, $res, $row, DB_FETCHMODE_ASSOC, ilSessionControl\DEFAULT_ALLOW_CLIENT_MAINTENANCE, ilSessionControl\DEFAULT_MAX_COUNT, ilSessionControl\DEFAULT_MAX_IDLE, ilSessionControl\DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST, ilSessionControl\DEFAULT_MIN_IDLE, and ilSessionControl\getSettingFields().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::getStatus | ( | $client = 0 | ) | 
coumpute client status
| string | client id | 
Definition at line 810 of file class.ilSetup.php.
References $client, checkAccess(), checkClientContact(), checkClientDatabase(), checkClientIni(), checkClientLanguages(), checkClientNIC(), and checkFinish().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::ilSetup | ( | $a_auth, | |
| $a_auth_type | |||
| ) | 
constructor
| boolean | user is authenticated? (true) or not (false) | 
| string | user is admin or common user | 
Definition at line 67 of file class.ilSetup.php.
References $lng, $log, ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, init(), PEAR\PEAR(), PEAR_ERROR_CALLBACK, and PEAR\setErrorHandling().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::init | ( | ) | 
init setup load settings from ilias.ini if exists and sets some constants
Definition at line 142 of file class.ilSetup.php.
Referenced by ilSetup().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::installDatabase | ( | ) | 
set the database data
Definition at line 260 of file class.ilSetup.php.
References readDump().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::isAdmin | ( | ) | 
check if current user is admin
Definition at line 1131 of file class.ilSetup.php.
| ilSetup::isAuthenticated | ( | ) | 
check if current user is authenticated
Definition at line 1122 of file class.ilSetup.php.
References $auth.
| ilSetup::isInstalled | ( | ) | 
check if client's db is installed
Definition at line 1113 of file class.ilSetup.php.
References $ini_ilias_exists.
Referenced by newClient().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::loginAsAdmin | ( | $a_password | ) | 
process setup admin login
| string | password | 
Definition at line 764 of file class.ilSetup.php.
References $_SESSION.
| ilSetup::loginAsClient | ( | $a_auth_data | ) | 
process client login
| array | 
Definition at line 698 of file class.ilSetup.php.
References $_SESSION, $ilDB, and newClient().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::newClient | ( | $a_client_id = 0 | ) | 
creates a client object in $this->client
| string | client id | 
Definition at line 783 of file class.ilSetup.php.
References $_SESSION, and isInstalled().
Referenced by loginAsClient().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::queryPreliminaries | ( | ) | 
preliminaries
check if different things are ok for setting up ilias private
Definition at line 630 of file class.ilSetup.php.
References checkCookiesEnabled(), checkCreatable(), checkDom(), checkGd(), checkMemoryLimit(), checkPHPVersion(), checkWritable(), and checkXsl().
Referenced by checkPreliminaries().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::readDump | ( | $db, | |
| $file | |||
| ) | 
execute a query
| string | |
| string | 
Definition at line 304 of file class.ilSetup.php.
References $db, $file, $reader, and getline().
Referenced by installDatabase().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::saveMasterSetup | ( | $a_formdata | ) | 
saves intial settings
| array | form data | 
Definition at line 1141 of file class.ilSetup.php.
References $_SESSION, ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, ilUtil\makeDir(), and ilUtil\stripSlashes().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::saveNewClient | ( | ) | 
saves client.ini & updates client list in ilias.ini
Definition at line 167 of file class.ilSetup.php.
References $_SESSION.
Referenced by updateNewClient().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::setClient | ( | $a_cl | ) | 
Set Client.
| object | client | 
Definition at line 122 of file class.ilSetup.php.
| ilSetup::setPassword | ( | $a_password | ) | 
set setup master password
| string | password | 
Definition at line 680 of file class.ilSetup.php.
| ilSetup::setSessionSettings | ( | $session_settings | ) | 
saves session settings to db
| array | $session_settings | 
Definition at line 1847 of file class.ilSetup.php.
References $db, $query, $res, $row, DB_FETCHMODE_ASSOC, ilSessionControl\getSettingFields(), and ilUtil\sendInfo().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::testConvert | ( | $a_convert_path | ) | 
Check convert program.
| string | convert path | 
Definition at line 1525 of file class.ilSetup.php.
Referenced by checkToolsSetup().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::testHtmldoc | ( | $a_htmldoc_path | ) | 
Check htmldoc program.
| string | htmldoc_path | 
Definition at line 1721 of file class.ilSetup.php.
References ILIAS_ABSOLUTE_PATH.
Referenced by checkToolsSetup().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::testJava | ( | $a_java_path | ) | 
Check JVM.
| string | java path | 
Definition at line 1566 of file class.ilSetup.php.
Referenced by checkToolsSetup().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::testLatex | ( | $a_latex_url | ) | 
Check latex cgi script.
| string | latex cgi url | 
Definition at line 1595 of file class.ilSetup.php.
References $result, and ilUtil\stripSlashes().
Referenced by checkToolsSetup().
 Here is the call graph for this function:
 Here is the call graph for this function: Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::testUnzip | ( | $a_unzip_path | ) | 
Check unzip program.
| string | unzip_path | 
Definition at line 1676 of file class.ilSetup.php.
Referenced by checkToolsSetup().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::testZip | ( | $a_zip_path | ) | 
Check zip program.
| string | zip path | 
Definition at line 1623 of file class.ilSetup.php.
Referenced by checkToolsSetup().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilSetup::unzip | ( | $a_file, | |
| $overwrite = false | |||
| ) | 
unzip file
| string | $a_file | full path/filename | 
| boolean | $overwrite | pass true to overwrite existing files | 
Definition at line 1788 of file class.ilSetup.php.
References $dir, $file, ilUtil\createDirectory(), and ilUtil\escapeShellArg().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::updateMasterSettings | ( | $a_formdata | ) | 
updates settings
| array | form data | 
Definition at line 1205 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::updateNewClient | ( | $a_old_client_id | ) | 
update client.ini & move data dirs does not work correctly at this time - DISABLED
Definition at line 190 of file class.ilSetup.php.
References ilUtil\delDir(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, PEAR\raiseError(), and saveNewClient().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilSetup::$access_mode | 
Definition at line 58 of file class.ilSetup.php.
| ilSetup::$auth | 
Definition at line 57 of file class.ilSetup.php.
Referenced by isAuthenticated().
| ilSetup::$db | 
Definition at line 49 of file class.ilSetup.php.
Referenced by checkClientSessionSettings(), createDatabase(), getSessionSettings(), readDump(), and setSessionSettings().
| ilSetup::$default_client | 
Definition at line 52 of file class.ilSetup.php.
| ilSetup::$dsn = "" | 
Definition at line 42 of file class.ilSetup.php.
| ilSetup::$error = "" | 
Definition at line 19 of file class.ilSetup.php.
Referenced by getError().
| ilSetup::$ilias_nic_server = "http://www.ilias.de/ilias-nic/index.php" | 
Definition at line 25 of file class.ilSetup.php.
| ilSetup::$ini | 
Definition at line 17 of file class.ilSetup.php.
| ilSetup::$ini_client_exists = false | 
Definition at line 22 of file class.ilSetup.php.
| ilSetup::$ini_file_path | 
Definition at line 18 of file class.ilSetup.php.
| ilSetup::$ini_ilias_exists = false | 
Definition at line 21 of file class.ilSetup.php.
Referenced by isInstalled().
| ilSetup::$preliminaries = true | 
Definition at line 28 of file class.ilSetup.php.
| ilSetup::$preliminaries_result = array() | 
Definition at line 27 of file class.ilSetup.php.
| ilSetup::$safe_mode | 
Definition at line 54 of file class.ilSetup.php.
| ilSetup::$safe_mode_exec_dir | 
Definition at line 55 of file class.ilSetup.php.
| ilSetup::$setup_defaults | 
Definition at line 24 of file class.ilSetup.php.
| ilSetup::$setup_password | 
Definition at line 51 of file class.ilSetup.php.
| ilSetup::$SQL_FILE = "./setup/sql/ilias3.sql" | 
Definition at line 35 of file class.ilSetup.php.