ILIAS
Release_3_10_x_branch Revision 61812
|
Setup class. More...
Public Member Functions | |
ilSetup ($a_auth, $a_auth_type) | |
constructor | |
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 | |
execQuery ($db, $str) | |
execute a query | |
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 ($a_dir="..") | |
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 | |
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. | |
unzipTiny () | |
unzip ($a_file, $overwrite=false) | |
unzip file |
Data Fields | |
$ini | |
$ini_file_path | |
$error = "" | |
$ini_ilias_exists = false | |
$ini_client_exists = false | |
$setup_defaults | |
$ilias_nic_server = "http://homer.ilias.uni-koeln.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 |
Setup class.
class to setup ILIAS first and maintain the ini-settings and the database
Definition at line 35 of file class.ilSetup.php.
ilSetup::_ilSetup | ( | ) |
destructor
Definition at line 1461 of file class.ilSetup.php.
ilSetup::checkAccess | ( | & | $client | ) |
check client access status
object | client |
Definition at line 899 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkAuth | ( | ) |
check authentication status
Definition at line 543 of file class.ilSetup.php.
References $_SESSION.
ilSetup::checkClientContact | ( | & | $client | ) |
check client contact data status
object | client |
Definition at line 1013 of file class.ilSetup.php.
References $client, and ilUtil\is_email().
Referenced by ilSetupGUI\displayContactData(), and getStatus().
ilSetup::checkClientDatabase | ( | & | $client | ) |
check client db status
object | client |
Definition at line 939 of file class.ilSetup.php.
References $client, and DB_FETCHMODE_ASSOC.
Referenced by getStatus().
ilSetup::checkClientIni | ( | & | $client | ) |
check client ini status
object | client |
Definition at line 920 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkClientLanguages | ( | & | $client | ) |
check client installed languages status
object | client |
Definition at line 988 of file class.ilSetup.php.
Referenced by getStatus().
ilSetup::checkClientNIC | ( | & | $client | ) |
check client nic status
object | client |
Definition at line 1047 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkCookiesEnabled | ( | ) |
check cookies enabled
Definition at line 452 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 426 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkDataDirSetup | ( | $a_formdata | ) |
check datadir path
array | form data |
Definition at line 1338 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, and ilUtil\stripSlashes().
Referenced by ilSetupGUI\displayMasterSetup().
ilSetup::checkDom | ( | ) |
Check MySQL.
Definition at line 558 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkFinish | ( | & | $client | ) |
check if client setup was finished
object | client |
Definition at line 878 of file class.ilSetup.php.
References $client.
Referenced by getStatus().
ilSetup::checkGd | ( | ) |
Check MySQL.
Definition at line 601 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkIniFileExists | ( | ) |
check if inifile exists
Definition at line 386 of file class.ilSetup.php.
ilSetup::checkLogSetup | ( | $a_formdata | ) |
check log path
array | form data |
Definition at line 1415 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().
Referenced by ilSetupGUI\changeMasterSettings(), and ilSetupGUI\displayMasterSetup().
ilSetup::checkMemoryLimit | ( | ) |
Check Memory Limit.
Definition at line 623 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkMySQL | ( | ) |
Check MySQL.
Definition at line 521 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkPasswordSetup | ( | $a_formdata | ) |
check setup password
array | form data |
Definition at line 1393 of file class.ilSetup.php.
Referenced by ilSetupGUI\displayMasterSetup().
ilSetup::checkPHPVersion | ( | ) |
check for PHP version
Definition at line 474 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkPreliminaries | ( | ) |
check all prliminaries
Definition at line 680 of file class.ilSetup.php.
References queryPreliminaries().
Referenced by ilSetupGUI\cmdAdmin(), and ilSetupGUI\cmdInstall().
ilSetup::checkToolsSetup | ( | $a_formdata | ) |
check pathes to 3rd party software
array | form data |
Definition at line 1222 of file class.ilSetup.php.
References ilUtil\stripSlashes(), testConvert(), testHtmldoc(), testJava(), testLatex(), testUnzip(), and testZip().
ilSetup::checkWritable | ( | $a_dir = ".." | ) |
check for writable directory
string | directory |
Definition at line 397 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::checkXsl | ( | ) |
Check MySQL.
Definition at line 579 of file class.ilSetup.php.
Referenced by queryPreliminaries().
ilSetup::createDatabase | ( | $a_collation = "" | ) |
create client database
Definition at line 254 of file class.ilSetup.php.
References $db.
Referenced by ilSetupGUI\displayDatabase().
ilSetup::execQuery | ( | $db, | |
$str | |||
) |
execute a query
string | |
string |
Definition at line 223 of file class.ilSetup.php.
References $db.
ilSetup::getError | ( | ) |
get Error message
Definition at line 1443 of file class.ilSetup.php.
References $error.
Referenced by ilSetupGUI\displayDatabase(), ilSetupGUI\displayIni(), and ilSetupGUI\displayLogin().
ilSetup::getline | ( | $fp, | |
$delim | |||
) |
Definition at line 324 of file class.ilSetup.php.
References $result.
Referenced by readDump().
ilSetup::getPassword | ( | ) |
get setup master password
Definition at line 700 of file class.ilSetup.php.
Referenced by ilSetupGUI\changeMasterPassword().
ilSetup::getStatus | ( | $client = 0 | ) |
coumpute client status
string | client id |
Definition at line 833 of file class.ilSetup.php.
References $client, checkAccess(), checkClientContact(), checkClientDatabase(), checkClientIni(), checkClientLanguages(), checkClientNIC(), and checkFinish().
Referenced by ilSetupGUI\changeDefaultClient(), ilSetupGUI\displayClientList(), ilSetupGUI\displayProcessPanel(), and ilSetupGUI\ilSetupGUI().
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 87 of file class.ilSetup.php.
References $log, ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, and init().
Referenced by ilSetupGUI\ilSetupGUI().
ilSetup::init | ( | ) |
init setup load settings from ilias.ini if exists and sets some constants
Definition at line 141 of file class.ilSetup.php.
Referenced by ilSetup().
ilSetup::installDatabase | ( | ) |
set the database data
Definition at line 299 of file class.ilSetup.php.
References readDump().
Referenced by ilSetupGUI\displayDatabase().
ilSetup::isAdmin | ( | ) |
check if current user is admin
Definition at line 1104 of file class.ilSetup.php.
Referenced by ilSetupGUI\displayFooter(), ilSetupGUI\displayHeader(), and ilSetupGUI\ilSetupGUI().
ilSetup::isAuthenticated | ( | ) |
check if current user is authenticated
Definition at line 1095 of file class.ilSetup.php.
References $auth.
Referenced by ilSetupGUI\displayHeader(), and ilSetupGUI\ilSetupGUI().
ilSetup::isInstalled | ( | ) |
check if client's db is installed
Definition at line 1086 of file class.ilSetup.php.
References $ini_ilias_exists.
Referenced by ilSetupGUI\displayHeader(), ilSetupGUI\displayMasterSetup(), ilSetupGUI\displayPreliminaries(), ilSetupGUI\ilSetupGUI(), and newClient().
ilSetup::loginAsAdmin | ( | $a_password | ) |
process setup admin login
string | password |
Definition at line 788 of file class.ilSetup.php.
References $_SESSION.
Referenced by ilSetupGUI\displayLogin().
ilSetup::loginAsClient | ( | $a_auth_data | ) |
process client login
array |
Definition at line 728 of file class.ilSetup.php.
References $_SESSION, and newClient().
Referenced by ilSetupGUI\displayLogin().
ilSetup::newClient | ( | $a_client_id = 0 | ) |
creates a client object in $this->client
string | client id |
Definition at line 807 of file class.ilSetup.php.
References $_SESSION, and isInstalled().
Referenced by ilSetupGUI\cmdAdmin(), ilSetupGUI\displayIni(), ilSetupGUI\ilSetupGUI(), and loginAsClient().
ilSetup::queryPreliminaries | ( | ) |
preliminaries
check if different things are ok for setting up ilias private
Definition at line 660 of file class.ilSetup.php.
References checkCookiesEnabled(), checkCreatable(), checkDom(), checkGd(), checkMemoryLimit(), checkMySQL(), checkPHPVersion(), checkWritable(), and checkXsl().
Referenced by checkPreliminaries().
ilSetup::readDump | ( | $db, | |
$file | |||
) |
execute a query
string | |
string |
Definition at line 343 of file class.ilSetup.php.
References $db, $file, and getline().
Referenced by installDatabase().
ilSetup::saveMasterSetup | ( | $a_formdata | ) |
saves intial settings
array | form data |
Definition at line 1114 of file class.ilSetup.php.
References $_SESSION, ilFile\deleteTrailingSlash(), ILIAS_ABSOLUTE_PATH, ilUtil\makeDir(), and ilUtil\stripSlashes().
Referenced by ilSetupGUI\displayMasterSetup().
ilSetup::saveNewClient | ( | ) |
saves client.ini & updates client list in ilias.ini
Definition at line 166 of file class.ilSetup.php.
References $_SESSION.
Referenced by ilSetupGUI\displayIni(), and updateNewClient().
ilSetup::setPassword | ( | $a_password | ) |
set setup master password
string | password |
Definition at line 710 of file class.ilSetup.php.
Referenced by ilSetupGUI\changeMasterPassword().
ilSetup::testConvert | ( | $a_convert_path | ) |
Check convert program.
string | convert path |
Definition at line 1476 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testHtmldoc | ( | $a_htmldoc_path | ) |
Check htmldoc program.
string | htmldoc_path |
Definition at line 1672 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 1517 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testLatex | ( | $a_latex_url | ) |
Check latex cgi script.
string | latex cgi url |
Definition at line 1546 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 1627 of file class.ilSetup.php.
Referenced by checkToolsSetup().
ilSetup::testZip | ( | $a_zip_path | ) |
Check zip program.
string | zip path |
Definition at line 1574 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 1750 of file class.ilSetup.php.
References $dir, $file, ilUtil\createDirectory(), and ilUtil\escapeShellArg().
Referenced by unzipTiny().
ilSetup::unzipTiny | ( | ) |
Definition at line 1732 of file class.ilSetup.php.
References ILIAS_ABSOLUTE_PATH, and unzip().
ilSetup::updateMasterSettings | ( | $a_formdata | ) |
updates settings
array | form data |
Definition at line 1176 of file class.ilSetup.php.
References ilFile\deleteTrailingSlash(), and ilUtil\stripSlashes().
Referenced by ilSetupGUI\changeMasterSettings().
ilSetup::updateNewClient | ( | $a_old_client_id | ) |
update client.ini & move data dirs does not work correctly at this time - DISABLED
Definition at line 189 of file class.ilSetup.php.
References ilUtil\delDir(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, and saveNewClient().
ilSetup::$access_mode |
Definition at line 78 of file class.ilSetup.php.
ilSetup::$auth |
Definition at line 77 of file class.ilSetup.php.
Referenced by isAuthenticated().
ilSetup::$db |
Definition at line 69 of file class.ilSetup.php.
Referenced by createDatabase(), ilSetupGUI\displayDeleteConfirmation(), execQuery(), and readDump().
ilSetup::$default_client |
Definition at line 72 of file class.ilSetup.php.
ilSetup::$dsn = "" |
Definition at line 62 of file class.ilSetup.php.
ilSetup::$error = "" |
Definition at line 39 of file class.ilSetup.php.
Referenced by getError().
ilSetup::$ilias_nic_server = "http://homer.ilias.uni-koeln.de/ilias-nic/index.php" |
Definition at line 45 of file class.ilSetup.php.
ilSetup::$ini |
Definition at line 37 of file class.ilSetup.php.
Referenced by ilSetupGUI\displayDeleteConfirmation().
ilSetup::$ini_client_exists = false |
Definition at line 42 of file class.ilSetup.php.
ilSetup::$ini_file_path |
Definition at line 38 of file class.ilSetup.php.
ilSetup::$ini_ilias_exists = false |
Definition at line 41 of file class.ilSetup.php.
Referenced by isInstalled().
ilSetup::$preliminaries = true |
Definition at line 48 of file class.ilSetup.php.
Referenced by ilSetupGUI\displayPreliminaries().
ilSetup::$preliminaries_result = array() |
Definition at line 47 of file class.ilSetup.php.
ilSetup::$safe_mode |
Definition at line 74 of file class.ilSetup.php.
ilSetup::$safe_mode_exec_dir |
Definition at line 75 of file class.ilSetup.php.
ilSetup::$setup_defaults |
Definition at line 44 of file class.ilSetup.php.
ilSetup::$setup_password |
Definition at line 71 of file class.ilSetup.php.
ilSetup::$SQL_FILE = "../setup/sql/ilias3.sql" |
Definition at line 55 of file class.ilSetup.php.