| ILIAS
    release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
    | 
ILIAS Initialisation Utility Class perform basic setup: init database handler, load configuration file, init user authentification & error handler, load object type definitions. More...
 Collaboration diagram for ilInitialisation:
 Collaboration diagram for ilInitialisation:| Public Member Functions | |
| removeUnsafeCharacters () | |
| Remove unsafe characters from GET.  More... | |
| requireCommonIncludes () | |
| get common include code files  More... | |
| initIliasIniFile () | |
| This method provides a global instance of class ilIniFile for the ilias.ini.php file in variable $ilIliasIniFile.  More... | |
| determineClient () | |
| This method determines the current client and sets the constant CLIENT_ID.  More... | |
| initClientIniFile () | |
| This method provides a global instance of class ilIniFile for the client.ini.php file in variable $ilClientIniFile.  More... | |
| initDatabase () | |
| initialise database object $ilDB  More... | |
| initEventHandling () | |
| initialise event handler ilAppEventHandler  More... | |
| initILIAS ($context="web") | |
| ilias initialisation  More... | |
| initLog () | |
| persistCMIData () | |
| Static Public Member Functions | |
| static | setSessionHandler () | 
| set session handler to db  More... | |
| static | goToPublicSection ($a_auth_stat="") | 
| go to public section  More... | |
| static | reinitILIAS () | 
| static | initILIAS () | 
| ilias initialisation  More... | |
| static | handleErrorReporting () | 
| Set error reporting level.  More... | |
| static | authenticate () | 
| Try authentication.  More... | |
| Static Protected Member Functions | |
| static | removeUnsafeCharacters () | 
| Remove unsafe characters from GET.  More... | |
| static | recursivelyRemoveUnsafeCharacters ($var) | 
| static | requireCommonIncludes () | 
| get common include code files  More... | |
| static | includePhp5Compliance () | 
| This is a hack for authentication.  More... | |
| static | initIliasIniFile () | 
| This method provides a global instance of class ilIniFile for the ilias.ini.php file in variable $ilIliasIniFile.  More... | |
| static | buildHTTPPath () | 
| builds http path  More... | |
| static | determineClient () | 
| This method determines the current client and sets the constant CLIENT_ID.  More... | |
| static | initClientIniFile () | 
| This method provides a global instance of class ilIniFile for the client.ini.php file in variable $ilClientIniFile.  More... | |
| static | handleMaintenanceMode () | 
| handle maintenance mode  More... | |
| static | initDatabase () | 
| initialise database object $ilDB  More... | |
| static | setCookieParams () | 
| set session cookie params for path, domain, etc.  More... | |
| static | initSettings () | 
| initialise $ilSettings object and define constants  More... | |
| static | initStyle () | 
| provide $styleDefinition object  More... | |
| static | initLocale () | 
| Init Locale.  More... | |
| static | goToLogin ($a_auth_stat="") | 
| go to login  More... | |
| static | initAccessHandling () | 
| $ilAccess and $rbac... initialisation  More... | |
| static | initLog () | 
| Init log instance.  More... | |
| static | initGlobal ($a_name, $a_class, $a_source_file=null) | 
| Initialize global instance.  More... | |
| static | abortAndDie ($a_message) | 
| Exit.  More... | |
| static | handleDevMode () | 
| Prepare developer tools More... | |
| static | initCore () | 
| Init core objects (level 0)  More... | |
| static | initClient () | 
| Init client-based objects (level 1)  More... | |
| static | initUser () | 
| Init user / authentification (level 2)  More... | |
| static | getCurrentCmd () | 
| Extract current cmd from request.  More... | |
| static | blockedAuthentication ($a_current_script) | 
| Block authentication based on current request.  More... | |
| static | showingLoginForm ($a_current_script) | 
| Is current view the login form?  More... | |
| static | translateMessage ($a_message_id, array $a_message_static=null) | 
| Translate message if possible.  More... | |
| static | redirect ($a_target, $a_message_id, $a_message_static) | 
| Redirects to target url if context supports it.  More... | |
| Static Protected Attributes | |
| static | $already_initialized | 
ILIAS Initialisation Utility Class perform basic setup: init database handler, load configuration file, init user authentification & error handler, load object type definitions.
Definition at line 27 of file class.ilInitialisation.php.
| 
 | staticprotected | 
Exit.
| string | $a_message | 
Definition at line 820 of file class.ilInitialisation.php.
References $GLOBALS.
Referenced by determineClient(), goToPublicSection(), handleMaintenanceMode(), initClientIniFile(), initSettings(), redirect(), and setSessionHandler().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
Try authentication.
This will basically validate the current session
Definition at line 1131 of file class.ilInitialisation.php.
References $_SERVER, $ilErr, ilSession\_destroy(), ilLoggerFactory\getLogger(), ilSession\SESSION_CLOSE_LOGIN, and ilSession\set().
Referenced by initILIAS().
 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:| 
 | staticprotected | 
Block authentication based on current request.
Definition at line 1352 of file class.ilInitialisation.php.
References $_GET, $_REQUEST, $cmd, and getCurrentCmd().
 Here is the call graph for this function:
 Here is the call graph for this function:| 
 | staticprotected | 
builds http path
Definition at line 174 of file class.ilInitialisation.php.
References $_SERVER, $dirs, $https, $path, ILIAS_MODULE, and ilUtil\removeTrailingPathSeparators().
Referenced by initSettings().
 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:| 
 | staticprotected | 
This method determines the current client and sets the constant CLIENT_ID.
Definition at line 234 of file class.ilInitialisation.php.
References $_COOKIE, $_GET, $client_id, $ilIliasIniFile, abortAndDie(), ilUtil\setCookie(), and ilUtil\stripSlashes().
Referenced by initClient(), and initILIAS().
 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:| ilInitialisation::determineClient | ( | ) | 
This method determines the current client and sets the constant CLIENT_ID.
Definition at line 125 of file class.ilInitialisation.php.
References $_GET, and $ilIliasIniFile.
| 
 | staticprotected | 
Extract current cmd from request.
Definition at line 1334 of file class.ilInitialisation.php.
References $_REQUEST, and $cmd.
Referenced by blockedAuthentication().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | staticprotected | 
go to login
| int | $a_auth_stat | 
Definition at line 711 of file class.ilInitialisation.php.
References $_COOKIE, $_GET, AUTH_EXPIRED, AUTH_IDLED, redirect(), ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_LOGIN, and ilSession\setClosingContext().
 Here is the call graph for this function:
 Here is the call graph for this function:| 
 | static | 
go to public section
| int | $a_auth_stat | 
Definition at line 631 of file class.ilInitialisation.php.
References $_GET, $_POST, $_SERVER, ilAuthUtils\_initAuth(), abortAndDie(), AUTH_EXPIRED, AUTH_IDLED, redirect(), ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_PUBLIC, ilSession\setClosingContext(), and setSessionHandler().
Referenced by ilStartUpGUI\processIndexPHP().
 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:| 
 | staticprotected | 
Prepare developer tools 
 
Definition at line 832 of file class.ilInitialisation.php.
Referenced by initClient().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | static | 
Set error reporting level.
Definition at line 925 of file class.ilInitialisation.php.
Referenced by ilWebAccessCheckerDelivery\handleRequest(), and initCore().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | staticprotected | 
handle maintenance mode
Definition at line 375 of file class.ilInitialisation.php.
References abortAndDie(), ilContext\hasHTML(), redirect(), and translateMessage().
Referenced by initClient().
 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:| 
 | staticprotected | 
This is a hack for authentication.
Since the phpCAS lib ships with its own compliance functions.
Definition at line 92 of file class.ilInitialisation.php.
References ilAuthFactory\CONTEXT_CAS, and ilAuthFactory\getContext().
Referenced by initILIAS().
 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:| 
 | staticprotected | 
$ilAccess and $rbac... initialisation
Definition at line 764 of file class.ilInitialisation.php.
References ilRbacSystem\getInstance(), and initGlobal().
Referenced by initUser().
 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:| 
 | staticprotected | 
Init client-based objects (level 1)
Definition at line 987 of file class.ilInitialisation.php.
References $GLOBALS, $https, determineClient(), handleDevMode(), handleMaintenanceMode(), initClientIniFile(), initDatabase(), initGlobal(), initLocale(), initLog(), initSettings(), setCookieParams(), setSessionHandler(), and ilContext\usesHTTP().
Referenced by initILIAS().
 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:| 
 | staticprotected | 
This method provides a global instance of class ilIniFile for the client.ini.php file in variable $ilClientIniFile.
It initializes a lot of constants accordingly to the settings in the client.ini.php file.
Preconditions: ILIAS_WEB_DIR and CLIENT_ID must be set.
Definition at line 281 of file class.ilInitialisation.php.
References $_COOKIE, $ilIliasIniFile, abortAndDie(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, initGlobal(), redirect(), ilUtil\setCookie(), and ilGlobalCache\setup().
Referenced by initClient(), and initILIAS().
 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:| ilInitialisation::initClientIniFile | ( | ) | 
This method provides a global instance of class ilIniFile for the client.ini.php file in variable $ilClientIniFile.
It initializes a lot of constants accordingly to the settings in the client.ini.php file.
Preconditions: ILIAS_WEB_DIR and CLIENT_ID must be set.
Definition at line 150 of file class.ilInitialisation.php.
References $GLOBALS, ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.
| 
 | staticprotected | 
Init core objects (level 0)
Definition at line 947 of file class.ilInitialisation.php.
References $_POST, $ilErr, ilSession\get(), handleErrorReporting(), initGlobal(), initIliasIniFile(), PEAR_ERROR_CALLBACK, removeUnsafeCharacters(), requireCommonIncludes(), and PEAR\setErrorHandling().
Referenced by initILIAS().
 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:| 
 | staticprotected | 
initialise database object $ilDB
Definition at line 403 of file class.ilInitialisation.php.
References $ilDB, ilDBWrapperFactory\getWrapper(), and initGlobal().
Referenced by initClient(), and initILIAS().
 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:| ilInitialisation::initDatabase | ( | ) | 
initialise database object $ilDB
Definition at line 204 of file class.ilInitialisation.php.
References $GLOBALS, $ilDB, and ilDBWrapperFactory\getWrapper().
 Here is the call graph for this function:
 Here is the call graph for this function:| ilInitialisation::initEventHandling | ( | ) | 
initialise event handler ilAppEventHandler
Definition at line 220 of file class.ilInitialisation.php.
References $GLOBALS.
| 
 | staticprotected | 
Initialize global instance.
| string | $a_name | |
| string | $a_class | |
| string | $a_source_file | 
Definition at line 802 of file class.ilInitialisation.php.
References $GLOBALS.
Referenced by initAccessHandling(), initClient(), initClientIniFile(), initCore(), initDatabase(), initIliasIniFile(), initLog(), initSettings(), initStyle(), initUser(), and requireCommonIncludes().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| ilInitialisation::initILIAS | ( | $context = "web" | ) | 
ilias initialisation
| string | $context | this is used for circumvent redirects to the login page if called e.g. by soap | 
Definition at line 235 of file class.ilInitialisation.php.
References $_GET, $GLOBALS, $https, $ilBench, $ilCtrl, $ilDB, $ilErr, $ilIliasIniFile, $ilLog, $ilSetting, $ilUser, $lng, determineClient(), initClientIniFile(), initDatabase(), initIliasIniFile(), initLog(), persistCMIData(), removeUnsafeCharacters(), requireCommonIncludes(), and ilSCORM2004StoreData\scormPlayerUnload().
 Here is the call graph for this function:
 Here is the call graph for this function:| 
 | static | 
ilias initialisation
Definition at line 860 of file class.ilInitialisation.php.
References $tpl, authenticate(), ilContext\doAuthentication(), ilUtil\getStyleSheetLocation(), ilContext\hasHTML(), ilContext\hasUser(), includePhp5Compliance(), ilContext\initClient(), initClient(), initCore(), initUser(), and ilECSTaskScheduler\start().
Referenced by ilSoapAdministration\getClientInfoXML(), ilSoapAdministration\getInstallationInfoXML(), ilCalendarRemoteAccessHandler\initIlias(), ilWebAccessChecker\initILIAS(), ilSoapAdministration\initIlias(), and reinitILIAS().
 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:| 
 | staticprotected | 
This method provides a global instance of class ilIniFile for the ilias.ini.php file in variable $ilIliasIniFile.
It initializes a lot of constants accordingly to the settings in the ilias.ini.php file.
Definition at line 109 of file class.ilInitialisation.php.
References $ilIliasIniFile, $tz, ilTimeZone\initDefaultTimeZone(), and initGlobal().
Referenced by initCore(), and initILIAS().
 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:| ilInitialisation::initIliasIniFile | ( | ) | 
This method provides a global instance of class ilIniFile for the ilias.ini.php file in variable $ilIliasIniFile.
It initializes a lot of constants accordingly to the settings in the ilias.ini.php file.
Definition at line 88 of file class.ilInitialisation.php.
References $GLOBALS, $ilIliasIniFile, and $tz.
| 
 | staticprotected | 
Init Locale.
Definition at line 595 of file class.ilInitialisation.php.
References $GLOBALS, $ilSetting, and $l.
Referenced by initClient().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | staticprotected | 
Init log instance.
Definition at line 785 of file class.ilInitialisation.php.
References $log, ilLoggerFactory\getRootLogger(), and initGlobal().
Referenced by initClient(), and initILIAS().
 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:| ilInitialisation::initLog | ( | ) | 
Definition at line 300 of file class.ilInitialisation.php.
| 
 | staticprotected | 
initialise $ilSettings object and define constants
Used in Soap
Definition at line 490 of file class.ilInitialisation.php.
References $ilSetting, ilPaymentSettings\_isPaymentEnabled(), abortAndDie(), buildHTTPPath(), initGlobal(), and ilContext\usesHTTP().
Referenced by initClient().
 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:| 
 | staticprotected | 
provide $styleDefinition object
Definition at line 533 of file class.ilInitialisation.php.
References ilPluginAdmin\getPluginObject(), IL_COMP_SERVICE, and initGlobal().
 Here is the call graph for this function:
 Here is the call graph for this function:| 
 | staticprotected | 
Init user / authentification (level 2)
Definition at line 1071 of file class.ilInitialisation.php.
References $_GET, $_POST, $_SESSION, $ilUser, ilSession\_destroy(), ilAuthUtils\_initAuth(), initAccessHandling(), initGlobal(), ilSession\SESSION_CLOSE_LOGIN, ilSession\set(), and ilContext\usesHTTP().
Referenced by initILIAS().
 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:| ilInitialisation::persistCMIData | ( | ) | 
Definition at line 308 of file class.ilInitialisation.php.
References $_GET, $data, $ilDB, $ilLog, $ilUser, $lm_set, $packageId, ilSCORM2004StoreData\persistCMIData(), and ilUtil\yn2tf().
Referenced by initILIAS().
 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:| 
 | staticprotected | 
Definition at line 41 of file class.ilInitialisation.php.
References recursivelyRemoveUnsafeCharacters().
Referenced by recursivelyRemoveUnsafeCharacters(), and removeUnsafeCharacters().
 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:| 
 | staticprotected | 
Redirects to target url if context supports it.
| string | $a_target | |
| string | $a_message_id | |
| array | $a_message_details | 
Definition at line 1481 of file class.ilInitialisation.php.
References abortAndDie(), ilContext\hasHTML(), ilUtil\redirect(), ilContext\supportsRedirects(), translateMessage(), and ilContext\usesHTTP().
Referenced by goToLogin(), goToPublicSection(), handleMaintenanceMode(), and initClientIniFile().
 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:| 
 | static | 
Definition at line 852 of file class.ilInitialisation.php.
References initILIAS().
Referenced by ilWebAccessChecker\initILIAS(), and ilSoapUserAdministration\loginStudipUser().
 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:| 
 | staticprotected | 
Remove unsafe characters from GET.
Definition at line 32 of file class.ilInitialisation.php.
References $_GET, and recursivelyRemoveUnsafeCharacters().
Referenced by initCore(), and initILIAS().
 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:| ilInitialisation::removeUnsafeCharacters | ( | ) | 
Remove unsafe characters from GET.
Definition at line 25 of file class.ilInitialisation.php.
References $_GET.
| 
 | staticprotected | 
get common include code files
Definition at line 62 of file class.ilInitialisation.php.
References initGlobal(), and ilContext\usesTemplate().
Referenced by initCore(), and initILIAS().
 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:| ilInitialisation::requireCommonIncludes | ( | ) | 
get common include code files
Definition at line 48 of file class.ilInitialisation.php.
| 
 | staticprotected | 
set session cookie params for path, domain, etc.
Definition at line 443 of file class.ilInitialisation.php.
References $_SERVER, $GLOBALS, $ilSetting, ilAuthFactory\CONTEXT_HTTP, ilAuthFactory\getContext(), ilHTTPS\getInstance(), and IL_COOKIE_PATH.
Referenced by initClient().
 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:| 
 | static | 
set session handler to db
Used in Soap/CAS
Definition at line 419 of file class.ilInitialisation.php.
References ilSession\_exists(), and abortAndDie().
Referenced by goToPublicSection(), initClient(), and CASClient\renameSession().
 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:| 
 | staticprotected | 
Is current view the login form?
Definition at line 1397 of file class.ilInitialisation.php.
References $_REQUEST.
| 
 | staticprotected | 
Translate message if possible.
| string | $a_message_id | |
| array | $a_message_static | 
Definition at line 1420 of file class.ilInitialisation.php.
References $_REQUEST, $ilDB, $ilSetting, $ilUser, $lang, and $lng.
Referenced by handleMaintenanceMode(), and redirect().
 Here is the caller graph for this function:
 Here is the caller graph for this function:| 
 | staticprotected | 
Definition at line 849 of file class.ilInitialisation.php.