ILIAS
release_5-0 Revision 5.0.0-1144-gc4397b1f870
|
Setup class. More...
Public Member Functions | |
ilSetup ($a_auth, $a_auth_type) | |
constructor More... | |
setClient ($a_cl) | |
getClient () | |
init () | |
init setup load settings from ilias.ini if exists and sets some constants More... | |
saveNewClient () | |
saves client.ini & updates client list in ilias.ini More... | |
updateNewClient ($a_old_client_id) | |
update client.ini & move data dirs does not work correctly at this time - DISABLED More... | |
createDatabase ($a_collation="") | |
create client database More... | |
installDatabase () | |
set the database data More... | |
getline ( $fp, $delim) | |
readDump ($db, $file) | |
execute a query More... | |
checkIniFileExists () | |
check if inifile exists More... | |
checkWritable () | |
check for writable directory More... | |
checkCreatable ($a_dir=".") | |
check for permission to create new folders in specified directory More... | |
checkCookiesEnabled () | |
check cookies enabled More... | |
checkPHPVersion () | |
check for PHP version More... | |
checkMySQL () | |
Check MySQL. More... | |
checkAuth () | |
check authentication status More... | |
checkDom () | |
Check MySQL. More... | |
checkXsl () | |
Check MySQL. More... | |
checkGd () | |
Check MySQL. More... | |
checkMemoryLimit () | |
Check Memory Limit. More... | |
queryPreliminaries () | |
preliminaries More... | |
checkPreliminaries () | |
check all prliminaries More... | |
getPassword () | |
get setup master password More... | |
setPassword ($a_password) | |
set setup master password More... | |
loginAsClient ($a_auth_data) | |
process client login More... | |
loginAsAdmin ($a_password) | |
process setup admin login More... | |
newClient ($a_client_id=0) | |
creates a client object in $this->client More... | |
getStatus ($client=0) | |
coumpute client status More... | |
checkFinish (&$client) | |
check if client setup was finished More... | |
checkAccess (&$client) | |
check client access status More... | |
checkClientIni (&$client) | |
check client ini status More... | |
checkClientDatabase (&$client) | |
check client db status More... | |
checkClientSessionSettings (&$client, $a_as_bool=false) | |
check client session config status More... | |
checkClientProxySettings (&$client) | |
check client session config status More... | |
checkClientLanguages (&$client) | |
check client installed languages status More... | |
checkClientContact (&$client) | |
check client contact data status More... | |
checkClientNIC (&$client) | |
check client nic status More... | |
isInstalled () | |
check if client's db is installed More... | |
isAuthenticated () | |
check if current user is authenticated More... | |
isAdmin () | |
check if current user is admin More... | |
saveMasterSetup ($a_formdata) | |
saves intial settings More... | |
updateMasterSettings ($a_formdata) | |
updates settings More... | |
checkToolsSetup ($a_formdata) | |
check pathes to 3rd party software More... | |
checkDataDirSetup ($a_formdata) | |
check datadir path More... | |
checkPasswordSetup ($a_formdata) | |
check setup password More... | |
checkLogSetup ($a_formdata) | |
check log path More... | |
getError () | |
get Error message More... | |
_ilSetup () | |
destructor More... | |
testConvert ($a_convert_path) | |
Check convert program. More... | |
testGhostscript ($a_ghostscript_path) | |
Check ghostscript program. More... | |
testJava ($a_java_path) | |
Check JVM. More... | |
testLatex ($a_latex_url) | |
Check latex cgi script. More... | |
testZip ($a_zip_path) | |
Check zip program. More... | |
testUnzip ($a_unzip_path) | |
Check unzip program. More... | |
testHtmldoc ($a_htmldoc_path) | |
Check htmldoc program. More... | |
unzip ($a_file, $overwrite=false) | |
unzip file More... | |
setSessionSettings ($session_settings) | |
saves session settings to db More... | |
getSessionSettings () | |
reads session settings from db More... | |
cloneFromSource ($source_id) | |
Clone source client into current client. More... | |
printProxyStatus ($client) | |
Print proxy settings. More... | |
saveProxySettings ($proxy_settings) | |
hasOpCacheEnabled () | |
![]() | |
PEAR ($error_class=null) | |
Constructor. More... | |
_PEAR () | |
Destructor (the emulated type of...). More... | |
& | 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. More... | |
registerShutdownFunc ($func, $args=array()) | |
Use this function to register a shutdown method for static classes. More... | |
isError ($data, $code=null) | |
Tell whether a value is a PEAR error. More... | |
setErrorHandling ($mode=null, $options=null) | |
Sets how errors generated by this object should be handled. More... | |
expectError ($code=' *') | |
This method is used to tell which errors you expect to get. More... | |
popExpect () | |
This method pops one element off the expected error codes stack. More... | |
_checkDelExpect ($error_code) | |
This method checks unsets an error code if available. More... | |
delExpect ($error_code) | |
This method deletes all occurences of the specified element from the expected error codes stack. More... | |
& | 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. More... | |
& | throwError ($message=null, $code=null, $userinfo=null) |
Simpler form of raiseError with fewer options. More... | |
staticPushErrorHandling ($mode, $options=null) | |
staticPopErrorHandling () | |
pushErrorHandling ($mode, $options=null) | |
Push a new error handler on top of the error handler options stack. More... | |
popErrorHandling () | |
Pop the last error handler used. More... | |
loadExtension ($ext) | |
OS independant PHP extension load. More... | |
Data Fields | |
$ini | |
$ini_file_path | |
$error = "" | |
$ini_ilias_exists = false | |
$ini_client_exists = false | |
$setup_defaults | |
$ilias_nic_server = "https://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 | |
$client | |
![]() | |
$_debug = false | |
$_default_error_mode = null | |
$_default_error_options = null | |
$_default_error_handler = '' | |
$_error_class = 'PEAR_Error' | |
$_expected_errors = array() | |
Protected Member Functions | |
checkOpcacheSettings () | |
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 | ( | ) |
ilSetup::checkAccess | ( | & | $client | ) |
check client access status
object | client |
Definition at line 944 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkAuth | ( | ) |
check authentication status
Definition at line 516 of file class.ilSetup.php.
References $_SESSION.
Referenced by ilSetup().
ilSetup::checkClientContact | ( | & | $client | ) |
check client contact data status
object | client |
Definition at line 1159 of file class.ilSetup.php.
References $client, and ilUtil\is_email().
Referenced by getStatus().
ilSetup::checkClientDatabase | ( | & | $client | ) |
check client db status
object | client |
Definition at line 984 of file class.ilSetup.php.
References $client, and $ilDB.
Referenced by getStatus().
ilSetup::checkClientIni | ( | & | $client | ) |
check client ini status
object | client |
Definition at line 965 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkClientLanguages | ( | & | $client | ) |
check client installed languages status
object | client |
Definition at line 1134 of file class.ilSetup.php.
Referenced by getStatus().
ilSetup::checkClientNIC | ( | & | $client | ) |
check client nic status
object | client |
Definition at line 1190 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkClientProxySettings | ( | & | $client | ) |
check client session config status
object | client |
Definition at line 1089 of file class.ilSetup.php.
References $ilDB, $query, $res, and $row.
Referenced by getStatus().
ilSetup::checkClientSessionSettings | ( | & | $client, |
$a_as_bool = false |
|||
) |
check client session config status
object | client |
Definition at line 1049 of file class.ilSetup.php.
References $ilDB, $query, $res, $row, DB_FETCHMODE_ASSOC, and ilSessionControl\getSettingFields().
ilSetup::checkCookiesEnabled | ( | ) |
check cookies enabled
Definition at line 453 of file class.ilSetup.php.
References $sess.
Referenced by queryPreliminaries().
ilSetup::checkCreatable | ( | $a_dir = "." | ) |
check for permission to create new folders in specified directory
string | directory |
Definition at line 427 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkDataDirSetup | ( | $a_formdata | ) |
check datadir path
array | form data |
Definition at line 1549 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, and ilUtil\stripSlashes().
ilSetup::checkDom | ( | ) |
Check MySQL.
Definition at line 531 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
ilSetup::checkFinish | ( | & | $client | ) |
check if client setup was finished
object | client |
Definition at line 923 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkGd | ( | ) |
Check MySQL.
Definition at line 574 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
ilSetup::checkIniFileExists | ( | ) |
ilSetup::checkLogSetup | ( | $a_formdata | ) |
check log path
array | form data |
Definition at line 1626 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().
ilSetup::checkMemoryLimit | ( | ) |
Check Memory Limit.
Definition at line 596 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
ilSetup::checkMySQL | ( | ) |
|
protected |
Definition at line 630 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkPasswordSetup | ( | $a_formdata | ) |
check setup password
array | form data |
Definition at line 1604 of file class.ilSetup.php.
ilSetup::checkPHPVersion | ( | ) |
check for PHP version
Definition at line 475 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkPreliminaries | ( | ) |
check all prliminaries
Definition at line 674 of file class.ilSetup.php.
References queryPreliminaries().
ilSetup::checkToolsSetup | ( | $a_formdata | ) |
check pathes to 3rd party software
array | form data |
Definition at line 1385 of file class.ilSetup.php.
References ilUtil\stripSlashes(), testConvert(), testGhostscript(), testHtmldoc(), testJava(), testLatex(), testUnzip(), and testZip().
ilSetup::checkWritable | ( | ) |
check for writable directory
string | directory |
Definition at line 398 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkXsl | ( | ) |
Check MySQL.
Definition at line 552 of file class.ilSetup.php.
References $ilDB.
Referenced by queryPreliminaries().
ilSetup::cloneFromSource | ( | $source_id | ) |
Clone source client into current client.
array | form data |
Definition at line 2135 of file class.ilSetup.php.
References $client, ilUtil\delDir(), ilUtil\makeDir(), and ilUtil\rCopy().
ilSetup::createDatabase | ( | $a_collation = "" | ) |
create client database
Definition at line 224 of file class.ilSetup.php.
References $r, and MDB2\isError().
ilSetup::getClient | ( | ) |
ilSetup::getError | ( | ) |
get Error message
Definition at line 1654 of file class.ilSetup.php.
References $error.
ilSetup::getline | ( | $fp, | |
$delim | |||
) |
Definition at line 287 of file class.ilSetup.php.
References $result.
Referenced by readDump().
ilSetup::getPassword | ( | ) |
ilSetup::getSessionSettings | ( | ) |
reads session settings from db
Definition at line 2070 of file class.ilSetup.php.
References $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().
ilSetup::getStatus | ( | $client = 0 | ) |
coumpute client status
string | client id |
Definition at line 871 of file class.ilSetup.php.
References $client, checkAccess(), checkClientContact(), checkClientDatabase(), checkClientIni(), checkClientLanguages(), checkClientNIC(), checkClientProxySettings(), and checkFinish().
ilSetup::hasOpCacheEnabled | ( | ) |
Definition at line 2319 of file class.ilSetup.php.
Referenced by queryPreliminaries().
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, checkAuth(), ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, init(), PEAR\PEAR(), PEAR_ERROR_CALLBACK, and PEAR\setErrorHandling().
ilSetup::init | ( | ) |
init setup load settings from ilias.ini if exists and sets some constants
Definition at line 144 of file class.ilSetup.php.
Referenced by ilSetup().
ilSetup::installDatabase | ( | ) |
set the database data
Definition at line 262 of file class.ilSetup.php.
References readDump().
ilSetup::isAdmin | ( | ) |
ilSetup::isAuthenticated | ( | ) |
check if current user is authenticated
Definition at line 1238 of file class.ilSetup.php.
References $auth.
ilSetup::isInstalled | ( | ) |
check if client's db is installed
Definition at line 1229 of file class.ilSetup.php.
References $ini_ilias_exists.
Referenced by newClient().
ilSetup::loginAsAdmin | ( | $a_password | ) |
process setup admin login
string | password |
Definition at line 824 of file class.ilSetup.php.
References $_SESSION.
ilSetup::loginAsClient | ( | $a_auth_data | ) |
process client login
array |
Definition at line 722 of file class.ilSetup.php.
References $_SESSION, $data, $ilDB, $r, ilUserPasswordManager\getInstance(), IL_PASSWD_CRYPTED, and newClient().
ilSetup::newClient | ( | $a_client_id = 0 | ) |
creates a client object in $this->client
string | client id |
Definition at line 844 of file class.ilSetup.php.
References $_SESSION, and isInstalled().
Referenced by loginAsClient().
ilSetup::printProxyStatus | ( | $client | ) |
Print proxy settings.
private
Verifies the proxy server connection
Definition at line 2236 of file class.ilSetup.php.
References $client, $lng, PEAR_ERROR_RETURN, ilUtil\sendFailure(), and ilUtil\sendSuccess().
ilSetup::queryPreliminaries | ( | ) |
preliminaries
check if different things are ok for setting up ilias private
Definition at line 650 of file class.ilSetup.php.
References checkCookiesEnabled(), checkCreatable(), checkDom(), checkGd(), checkMemoryLimit(), checkOpcacheSettings(), checkPHPVersion(), checkWritable(), checkXsl(), and hasOpCacheEnabled().
Referenced by checkPreliminaries().
ilSetup::readDump | ( | $db, | |
$file | |||
) |
execute a query
string | |
string |
Definition at line 306 of file class.ilSetup.php.
References $file, $r, $reader, and getline().
Referenced by installDatabase().
ilSetup::saveMasterSetup | ( | $a_formdata | ) |
saves intial settings
array | form data |
Definition at line 1257 of file class.ilSetup.php.
References $_SESSION, ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, ilUtil\makeDir(), and ilUtil\stripSlashes().
ilSetup::saveNewClient | ( | ) |
saves client.ini & updates client list in ilias.ini
Definition at line 169 of file class.ilSetup.php.
References $_SESSION.
Referenced by updateNewClient().
ilSetup::saveProxySettings | ( | $proxy_settings | ) |
ilSetup::setClient | ( | $a_cl | ) |
$a_cl |
Definition at line 127 of file class.ilSetup.php.
ilSetup::setPassword | ( | $a_password | ) |
set setup master password
string | password |
Definition at line 704 of file class.ilSetup.php.
ilSetup::setSessionSettings | ( | $session_settings | ) |
saves session settings to db
array | $session_settings |
Definition at line 2010 of file class.ilSetup.php.
References $query, $res, $row, DB_FETCHMODE_ASSOC, ilSessionControl\getSettingFields(), and ilUtil\sendInfo().
ilSetup::testConvert | ( | $a_convert_path | ) |
Check convert program.
string | convert path |
Definition at line 1687 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testGhostscript | ( | $a_ghostscript_path | ) |
Check ghostscript program.
string | ghostscript path |
Definition at line 1708 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testHtmldoc | ( | $a_htmldoc_path | ) |
Check htmldoc program.
string | htmldoc_path |
Definition at line 1884 of file class.ilSetup.php.
References ILIAS_ABSOLUTE_PATH.
Referenced by checkToolsSetup().
ilSetup::testJava | ( | $a_java_path | ) |
Check JVM.
string | java path |
Definition at line 1729 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testLatex | ( | $a_latex_url | ) |
Check latex cgi script.
string | latex cgi url |
Definition at line 1758 of file class.ilSetup.php.
References $result, and ilUtil\stripSlashes().
Referenced by checkToolsSetup().
ilSetup::testUnzip | ( | $a_unzip_path | ) |
Check unzip program.
string | unzip_path |
Definition at line 1839 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testZip | ( | $a_zip_path | ) |
Check zip program.
string | zip path |
Definition at line 1786 of file class.ilSetup.php.
Referenced by checkToolsSetup().
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 1951 of file class.ilSetup.php.
References $file, ilUtil\createDirectory(), and ilUtil\escapeShellArg().
ilSetup::updateMasterSettings | ( | $a_formdata | ) |
updates settings
array | form data |
Definition at line 1328 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().
ilSetup::updateNewClient | ( | $a_old_client_id | ) |
update client.ini & move data dirs does not work correctly at this time - DISABLED
Definition at line 192 of file class.ilSetup.php.
References ilUtil\delDir(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, PEAR\raiseError(), and saveNewClient().
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::$client |
Definition at line 121 of file class.ilSetup.php.
Referenced by checkAccess(), checkClientContact(), checkClientDatabase(), checkClientIni(), checkClientNIC(), checkFinish(), cloneFromSource(), getClient(), getStatus(), and printProxyStatus().
ilSetup::$db |
Definition at line 49 of file class.ilSetup.php.
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 = "https://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.