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 ($a_client_id=0)
	Constructor setup ILIAS global object public. More...
	setAuthError ($a_error_obj)
	set authentication error (should be set after Auth->start() via $ilias->setAuthError($ilErr->getLastError()); More...
&	getAuthError ()
	get (last) authentication error object More...
	getSetting ($a_keyword, $a_default_value=false)
	read one value from settingstable public More...
	deleteSetting ($a_keyword)
	delete one value from settingstable public More...
	getAllSettings ()
	read all values from settingstable public More...
	setSetting ($a_key, $a_val)
	write one value to db-table settings public More...
	getFirstStyle ($a_skin)
	get first available stylesheet from skindirectory More...
	checkTemplate ($a_name)
	check if a template name exists on the server More...
&	getCurrentUser ()
	get current user account More...
	getClientId ()
	raiseError ($a_msg, $a_err_obj)
	wrapper for downward compability More...

Data Fields
	$INI_FILE
	$dsn = ""
	$db
	$tplPath = "./templates/"
	$account
	$auth_params = array()
	$auth
	$ini = array()
	$error_obj
	$obj_factory
	$styles
	$skins

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 16 of file class.ilias.php.

Constructor & Destructor Documentation

__construct()

ILIAS::__construct

(

$a_client_id = 0

)

Constructor setup ILIAS global object public.

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

References $ilDB, $ilErr, and $ilIliasIniFile.

    {
        global $ilErr, $ilDB, $ilIliasIniFile, $ilClientIniFile, $ilAuth;

        $this->ini_ilias = &$ilIliasIniFile;
        $this->client_id = '';
        if (defined('CLIENT_ID')) {
            $this->client_id = CLIENT_ID;
        }
        $this->ini = &$ilClientIniFile;
        $this->db = &$ilDB;
        $this->error_obj = &$ilErr;
        $this->auth = &$ilAuth;

        // create instance of object factory
        include_once("./Services/Object/classes/class.ilObjectFactory.php");
        $this->obj_factory = new ilObjectFactory();
    }

Member Function Documentation

checkTemplate()

ILIAS::checkTemplate

(

$a_name

)

check if a template name exists on the server

Parameters

string

template name

Returns

boolean true if file exists public

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

    {
        return file_exists($this->tplPath . $a_name);
    }

deleteSetting()

ILIAS::deleteSetting

(

$a_keyword

)

delete one value from settingstable public

Parameters

string

keyword

Returns

string value

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

References $ilSetting.

    {
        global $ilSetting;
        
        return $ilSetting->delete($a_keyword);
    }

getAllSettings()

ILIAS::getAllSettings

(

)

read all values from settingstable public

Returns

array keyword/value pairs

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

References $ilSetting.

    {
        global $ilSetting;
        
        return $ilSetting->getAll();
    }

getAuthError()

& ILIAS::getAuthError

(

)

get (last) authentication error object

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

    {
        return $this->auth_error;
    }

getClientId()

ILIAS::getClientId

(

)

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

References $client_id.

    {
        return $this->client_id;
    }

getCurrentUser()

& ILIAS::getCurrentUser

(

)

get current user account

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

References $account.

    {
        return $this->account;
    }

getFirstStyle()

ILIAS::getFirstStyle

(

$a_skin

)

get first available stylesheet from skindirectory

Parameters

string

Returns

string style name public

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

    {
        if (!is_array($this->styles)) {
            $this->getStyles($a_skin);
        }

        return $this->styles[0]["name"];
    }

getSetting()

ILIAS::getSetting	(		$a_keyword,
			$a_default_value = false
	)

read one value from settingstable public

Parameters

string	keyword
string	default_value This value is returned, when no setting has been found for the keyword.

Returns

string value

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

References $ilSetting.

    {
        global $ilSetting;
        
        return $ilSetting->get($a_keyword, $a_default_value);
    }

raiseError()

ILIAS::raiseError	(		$a_msg,
			$a_err_obj
	)

wrapper for downward compability

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

References $ilErr.

    {
        global $ilErr;

        $ilErr->raiseError($a_msg, $a_err_obj);
    }

setAuthError()

ILIAS::setAuthError

(

$a_error_obj

)

set authentication error (should be set after Auth->start() via $ilias->setAuthError($ilErr->getLastError());

Parameters

object

$a_error_obj

pear error object

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

    {
        $this->auth_error = &$a_error_obj;
    }

setSetting()

ILIAS::setSetting	(		$a_key,
			$a_val
	)

write one value to db-table settings public

Parameters

string	keyword
string	value

Returns

boolean true on success

TODO: change to replace-statement

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

References $ilSetting.

    {
        global $ilSetting;
        
        return $ilSetting->set($a_key, $a_val);
    }

Field Documentation

$account

ILIAS::$account

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

Referenced by getCurrentUser().

$auth

ILIAS::$auth

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

$auth_params

ILIAS::$auth_params = array()

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

$db

ILIAS::$db

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

$dsn

ILIAS::$dsn = ""

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

$error_obj

ILIAS::$error_obj

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

$ini

ILIAS::$ini = array()

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

$INI_FILE

ILIAS::$INI_FILE

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

$obj_factory

ILIAS::$obj_factory

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

$skins

ILIAS::$skins

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

$styles

ILIAS::$styles

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

$tplPath

ILIAS::$tplPath = "./templates/"

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

---

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

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