ILIAS base class perform basic setup: init database handler, load configuration file, init user authentification & error handler, load object type definitions. More...

Collaboration diagram for ILIAS:

Public Member Functions
	__construct ()
	Constructor setup ILIAS global object public. More...

	getSetting (string $a_keyword, ?string $a_default_value=null)
	read one value from settingstable More...

	deleteSetting (string $a_keyword)
	delete one value from settingstable More...

	getAllSettings ()

	setSetting (string $a_key, string $a_val)

	getClientId ()

	raiseError (string $a_msg, int $a_err_obj)
	wrapper for downward compability More...

Data Fields
string	$INI_FILE

string	$client_id = ''

	$account

	$ini = array()

	$ini_ilias

	$db

	$error_obj

Protected Member Functions
	getSettingObject ()

Protected Attributes
ilSetting	$setting = null

ilErrorHandling	$error

Detailed Description

ILIAS base class perform basic setup: init database handler, load configuration file, init user authentification & error handler, load object type definitions.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Todo:: review the concept how the object type definition is loaded. We need a concept to edit the definitions via webfrontend in the admin console.

Definition at line 14 of file class.ilias.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS::__construct ( )

Constructor setup ILIAS global object public.

Definition at line 62 of file class.ilias.php.

References $DIC, $ilDB, and $ilIliasIniFile.

     {
         global $DIC, $ilClientIniFile, $ilIliasIniFile, $ilDB;
 
         $this->ini = &$ilClientIniFile;
         $this->ini_ilias = &$ilIliasIniFile;
         $this->db = &$ilDB;
 
         // already available in DIC
         $this->error_obj = $DIC['ilErr'];
     }

Here is the caller graph for this function:

Member Function Documentation

◆ deleteSetting()

ILIAS::deleteSetting ( string $a_keyword )

delete one value from settingstable

Deprecated:

See also: $DIC->settings()->delete()

Definition at line 98 of file class.ilias.php.

References getSettingObject().

                                                     : void
     {
         $this->getSettingObject()->delete($a_keyword);
     }

Here is the call graph for this function:

◆ getAllSettings()

ILIAS::getAllSettings ( )

Deprecated:

Definition at line 106 of file class.ilias.php.

References getSettingObject().

                                     : array
     {
         return $this->getSettingObject()->getAll();
     }

Here is the call graph for this function:

◆ getClientId()

ILIAS::getClientId ( )

Definition at line 119 of file class.ilias.php.

References CLIENT_ID.

Referenced by ILIAS\Tests\Setup\CLI\InstallCommandTest\basicFunctionality().

                                  : string
     {
         if (defined('CLIENT_ID')) {
             return (string) CLIENT_ID;
         }
         return '';
     }

Here is the caller graph for this function:

◆ getSetting()

ILIAS::getSetting	(	string	$a_keyword,
		?string	$a_default_value = `null`
	)

read one value from settingstable

Deprecated:

Definition at line 88 of file class.ilias.php.

References getSettingObject().

Referenced by ILIAS\LTI\ToolProvider\Platform\getToolSettings(), ILIAS\LTI\ToolProvider\Platform\hasAccessTokenService(), ILIAS\LTI\ToolProvider\Platform\hasToolSettingsService(), ILIAS\LTI\ToolProvider\setSetting(), and ILIAS\LTI\ToolProvider\Platform\setToolSettings().

                                                                                   : ?string
     {
         return $this->getSettingObject()->get($a_keyword, $a_default_value);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettingObject()

ILIAS::getSettingObject ( )

protected

Definition at line 74 of file class.ilias.php.

References $DIC, and $setting.

Referenced by deleteSetting(), getAllSettings(), getSetting(), and setSetting().

                                          : ?ilSetting
     {
         global $DIC;
 
         if (!$this->setting instanceof ilSetting) {
             return $this->setting = $DIC->settings();
         }
         return $this->setting;
     }

Here is the caller graph for this function:

◆ raiseError()

ILIAS::raiseError	(	string	$a_msg,
		int	$a_err_obj
	)

wrapper for downward compability

Deprecated:

Definition at line 131 of file class.ilias.php.

Referenced by ilObjTest\_createImportDirectory(), and ilObjQuestionPoolGUI\getQueryParamInt().

                                                              : void
     {
         $this->error_obj->raiseError($a_msg, $a_err_obj);
     }

Here is the caller graph for this function:

◆ setSetting()

ILIAS::setSetting	(	string	$a_key,
		string	$a_val
	)

Deprecated:

Definition at line 114 of file class.ilias.php.

References getSettingObject().

                                                             : void
     {
         $this->getSettingObject()->set($a_key, $a_val);
     }

Here is the call graph for this function:

Field Documentation

◆ $account

ILIAS::$account

Definition at line 28 of file class.ilias.php.

◆ $client_id

string ILIAS::$client_id = ''

Definition at line 22 of file class.ilias.php.

Referenced by ILIAS\COPage\Link\ExtLinkMapper\__construct(), ILIAS\Setup\Objective\ClientIdReadObjective\achieve(), ILIAS\FileDelivery\Setup\BaseDirObjective\buildIn(), and ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager\run().

◆ $db

ILIAS::$db

Definition at line 46 of file class.ilias.php.

◆ $error

ilErrorHandling ILIAS::$error

protected

Definition at line 55 of file class.ilias.php.

◆ $error_obj

ILIAS::$error_obj

Definition at line 52 of file class.ilias.php.

◆ $ini

ILIAS::$ini = array()

Definition at line 34 of file class.ilias.php.

Referenced by ILIAS\TestQuestionPool\Setup\RebuildMissingThumbnailMigration\prepare().

◆ $INI_FILE

string ILIAS::$INI_FILE

Definition at line 16 of file class.ilias.php.

◆ $ini_ilias

ILIAS::$ini_ilias

Definition at line 40 of file class.ilias.php.

◆ $setting

ilSetting ILIAS::$setting = null

protected

Definition at line 54 of file class.ilias.php.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\ExpiredOrOrphanedMailsCollector\__construct(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\__construct(), ILIAS\TermsOfService\test\SettingsTest\assertSelect(), ILIAS\DataProtection\test\SettingsTest\assertSelect(), getSettingObject(), ILIAS\Notifications\Provider\AwarenessToastProvider\getToasts(), ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\testAcceptMatchingDocument(), ILIAS\DataProtection\test\UserSettingsTest\testAgreeDate(), ILIAS\TermsOfService\test\UserSettingsTest\testAgreeDate(), ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\testAgreeDate(), ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\testNeverAgreed(), ILIAS\LegalDocuments\test\ConsumerToolbox\RoutingTest\testRedirectToOriginalTarget(), ILIAS\LegalDocuments\test\ConsumerToolbox\SelectSettingTest\testTyped(), ILIAS\DataProtection\test\UserSettingsTest\testWithdrawalRequested(), ILIAS\TermsOfService\test\UserSettingsTest\testWithdrawalRequested(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcessTest\testWithdrawalRequested(), and ILIAS\LegalDocuments\test\ConsumerToolbox\UserTest\testWithdrawalRequested().

The documentation for this class was generated from the following file:

Services/Init/classes/class.ilias.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteSetting()

◆ getAllSettings()

◆ getClientId()

◆ getSetting()

◆ getSettingObject()

◆ raiseError()

◆ setSetting()

Field Documentation

◆ $account

◆ $client_id

◆ $db

◆ $error

◆ $error_obj

◆ $ini

◆ $INI_FILE

◆ $ini_ilias

◆ $setting