ILIAS Class Reference

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.

Referenced by ILIAS\UI\examples\Table\Column\LinkListing\base(), ILIAS\UI\examples\Table\Column\Boolean\base(), ILIAS\UI\examples\Table\Column\Text\base(), ILIAS\UI\examples\Table\Column\Link\base(), ILIAS\UI\examples\Table\Column\Number\base(), ILIAS\UI\examples\Table\Column\StatusIcon\base(), ILIAS\UI\examples\Table\Data\base(), ILIAS\UI\examples\Tree\Expandable\expandable2(), ILIAS\LTIOAuth\OAuthSignatureMethod_HMAC_SHA1\get_name(), ILIAS\ResourceStorage\Policy\FileNamePolicyTest\getFileNamePolicy(), ILIAS\GlobalScreen\MainMenu\CollectorTest\getItemInformation(), ILIAS\Tests\UI\Component\Input\DynamicInputDataIteratorTest\getTestInputData(), ILIAS\Tests\Setup\CLI\HasAgentTest\setUp(), ILIAS\Tests\Setup\CLI\HasConfigReaderTest\setUp(), ILIAS\Tests\Setup\ObjectiveIteratorTest\testFailedPreconditionLastOnStack(), ILIAS\Tests\Setup\ObjectiveIteratorTest\testFailedPreconditionWithOtherOnStack(), ILIAS\ContentPage\GlobalSettingsStorageTest\testGlobalSettings(), and ILIAS\ResourceStorage\Revision\StakeholderRepositoryTests\testNameTooLong().

    {
        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().

Referenced by ilObjUserFolderGUI\saveGlobalUserSettingsObject().

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

Here is the call graph for this function:

Here is the caller 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(), ilObjQuestionPool\_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().

Referenced by ilObjUserFolderGUI\saveGlobalUserSettingsObject().

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

Here is the call graph for this function:

Here is the caller 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\Setup\Objective\ClientIdReadObjective\achieve(), 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.

Referenced by ILIAS\UI\Implementation\Component\Input\Field\Url\addValidation(), ILIAS\UI\Implementation\Component\Input\Field\Link\addValidation(), ILIAS\UI\Implementation\Component\Input\Field\Duration\addValidation(), ILIAS\Refinery\Custom\Group\constraint(), ILIAS\UI\Implementation\Component\Input\Input\getError(), ILIAS\Refinery\getErrorMessage(), ILIAS\Refinery\getLngClosure(), ILIAS\COPage\Editor\Components\Paragraph\ParagraphResponseFactory\getResponseObject(), ILIAS\COPage\Editor\Components\Paragraph\ParagraphResponseFactory\getResponseObjectMulti(), ILIAS\UI\Implementation\Component\Input\Container\Form\Renderer\maybeAddError(), ILIAS\Survey\Page\PageRenderer\render(), ILIAS\OrgUnit\Webservices\SOAP\ImportOrgUnitTree\run(), ILIAS\COPage\Editor\Server\UIWrapper\sendPage(), ILIAS\COPage\Editor\Components\Table\TableCommandActionHandler\sendUpdateResponse(), ILIAS\UI\Implementation\Component\Input\ViewControl\Group\setError(), ILIAS\UI\Implementation\Component\Input\Input\setError(), ILIAS\UI\Implementation\Component\Input\Field\Group\setError(), ILIAS\UI\Implementation\Component\Input\setInputs(), ILIAS\COPage\Editor\EditSessionRepository\setPageError(), ILIAS\Tests\Refinery\IdentityTransformationTest\testApplyToError(), ILIAS\Tests\Refinery\To\Transformation\NewObjectTransformationTest\testNewObjectApplyResultsErrorObjectOnInvalidConstructorArguments(), ILIAS\Tests\Refinery\To\Transformation\NewMethodTransformationTest\testPrivateMethodCanNotBeCalledInApplyto(), ILIAS\Tests\Refinery\To\Transformation\NewMethodTransformationTest\testPrivateMethodCanNotBeCalledInTransform(), ILIAS\Tests\Refinery\Integer\Constraints\GreaterThanConstraintTest\testRestrictError(), ILIAS\Tests\Refinery\Integer\Constraints\GreaterThanOrEqualConstraintTest\testRestrictError(), ILIAS\Tests\Refinery\Integer\Constraints\LessThanOrEqualConstraintTest\testRestrictError(), ILIAS\Tests\Refinery\Integer\Constraints\LessThanConstraintTest\testRestrictError(), ILIAS\UI\Implementation\Component\Input\Field\FormInput\withInput(), ILIAS\UI\Implementation\Component\Input\withInput(), ILIAS\UI\Implementation\Component\Input\Field\Renderer\wrapInFormContext(), and ILIAS\Refinery\String\EstimatedReadingTime\xmlErrorsToString().

$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.

$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(), getSettingObject(), and ILIAS\Notifications\Provider\AwarenessToastProvider\getToasts().

---

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

• Services/Init/classes/class.ilias.php