Client Management. More...

Collaboration diagram for ilClient:

Public Member Functions
	ilClient ($a_client_id, $a_db_connections)
	Constructor. More...

	init ()
	init client load client.ini and set some constants More...

	getId ()
	get client id More...

	setId ($a_client_id)
	set client id More...

	getName ()
	get client name More...

	setName ($a_str)
	set client name More...

	getDescription ()
	get client description More...

	setDescription ($a_str)
	set client description More...

	getDB ()
	get mysql version More...

	connect ()
	connect to client database More...

	isInstalledDB (&$a_db)
	check if client db is installed More...

	setDSN ()
	set the dsn and dsn_host More...

	setDbHost ($a_str)
	set the host More...

	getDbHost ()
	get db host More...

	setDbName ($a_str)
	set the name of database More...

	getDbName ()
	get name of database More...

	setDbUser ($a_str)
	set db user More...

	getDbUser ()
	get db user More...

	getDbPort ()
	get db port More...

	setDbPort ($a_str)
	set db port More...

	setDbPass ($a_str)
	set db password More...

	getDbPass ()
	get db password More...

	setDbSlaveActive ($a_act)
	set the slave active More...

	getDbSlaveActive ()
	get slave active More...

	setDbSlaveHost ($a_str)
	set the slave host More...

	getDbSlaveHost ()
	get db slave host More...

	setDbSlaveName ($a_str)
	set the name of slave database More...

	getDbSlaveName ()
	get name of slave database More...

	setDbSlaveUser ($a_str)
	set slave db user More...

	getDbSlaveUser ()
	get slave db user More...

	getDbSlavePort ()
	get slave db port More...

	setDbSlavePort ($a_str)
	set slave db port More...

	setDbSlavePass ($a_str)
	set slave db password More...

	getDbSlavePass ()
	get slave db password More...

	setDbType ($a_str)
	set the type of database More...

	getDbType ()
	get type of database More...

	getDataDir ()
	get client datadir path More...

	getWebspaceDir ()
	get client webspacedir path More...

	checkDatabaseHost ()
	check database connection More...

	checkDatabaseExists ($a_keep_connection=false)
	check database connection with database name More...

	reconnect ()

	getSetting ($a_keyword)
	read one value from settings table public More...

	getAllSettings ()
	read all values from settings table public More...

	setSetting ($a_key, $a_val)
	write one value to settings table public More...

	getURLStringForNIC ($a_nic_url)

	updateNIC ($a_nic_url)
	Connect to ILIAS-NIC. More...

	setNICkey ()
	set nic_key generate nic_key if nic_key field in cust table is empty. More...

	getNICkey ()
	get nic_key public More...

	getDefaultLanguage ()

	setDefaultLanguage ($a_lang_key)

	getError ()
	get error message and clear error var More...

	delete ($a_ini=true, $a_db=false, $a_files=false)
	delete client More...

	create ()
	create a new client and its subdirectories More...

	writeIni ()
	write init More...

Data Fields
	$id

	$dir

	$name

	$db_exists = false

	$db_installed = false

	$client_defaults

	$status

	$setup_ok = false

	$nic_status

Detailed Description

Client Management.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilClient.php.

Member Function Documentation

◆ checkDatabaseExists()

ilClient::checkDatabaseExists ( $a_keep_connection = false )

check database connection with database name

Returns: boolean

Definition at line 552 of file class.ilClient.php.

References $GLOBALS, MDB2\isError(), and isInstalledDB().

         {
                 //try to connect to database
                 $db = $this->db_connections->connectDB($this->dsn);
                 if (MDB2::isError($db))
                 {
                         return false;
                 }
                 
                 if (!$this->isInstalledDB($db))
                 {
                         return false;
                 }
                 
                 // #10633
                 if($a_keep_connection)
                 {
                         $GLOBALS["ilDB"] = $this->db;
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ checkDatabaseHost()

ilClient::checkDatabaseHost ( )

check database connection

Returns: boolean

Definition at line 527 of file class.ilClient.php.

References $lng, getDbType(), and MDB2\isError().

         {
                 global $lng;
 
                 if ($this->getDbType() == "oracle")
                 {
                         return true;
                 }
                 
                 //connect to databasehost
                 $db = $this->db_connections->connectHost($this->dsn_host);
                 if (MDB2::isError($db))
                 {
                         //$this->error = $db->getMessage()."! Please check database hostname, username & password.";
                         $this->error = $db->getMessage()." - ".$db->getUserInfo()." - ".$lng->txt("db_error_please_check");
                         return false;
                 }
                 
                 return true;
         }

Here is the call graph for this function:

◆ connect()

ilClient::connect ( )

connect to client database

Returns: boolean true on success

Definition at line 163 of file class.ilClient.php.

References $GLOBALS, and ilDBWrapperFactory\getWrapper().

Referenced by init(), and reconnect().

         {
                 // check parameters
                 // To support oracle tnsnames.ora dbname is not required
                 if (!$this->getdbHost() || !$this->getdbUser())
                 {
                         $this->error = "empty_fields";
                         return false;
                 }
                 /*
                 if (!$this->getdbHost() || !$this->getdbName() || !$this->getdbUser())
                 {
                         $this->error = "empty_fields";
                         return false;
                 }
                 */
                 
                 include_once("./Services/Database/classes/class.ilDBWrapperFactory.php");
                 $this->db = ilDBWrapperFactory::getWrapper($this->getdbType(), 
                         $this->ini->readVariable("db","inactive_mysqli"));
                 $this->db->setDBUser($this->getdbUser());
                 $this->db->setDBPort($this->getdbPort());
                 $this->db->setDBPassword($this->getdbPass());
                 $this->db->setDBHost($this->getdbHost());
                 $this->db->setDBName($this->getdbName());
                 $con = $this->db->connect(true);
                 
                 if (!$con)
                 {
                         $this->error = "Database connection failed.";
                         return false;
                 }
                 $GLOBALS["ilDB"] = $this->db;
                 
                 $this->db_exists = true;
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilClient::create ( )

create a new client and its subdirectories

Returns: boolean true on success

Definition at line 801 of file class.ilClient.php.

References getDataDir(), getWebspaceDir(), and ilUtil\makeDir().

         {
                 //var_dump($this->getDataDir());exit;
                 // create base data dir
                 if (!ilUtil::makeDir($this->getDataDir()))
                 {
                         $this->error = "could_not_create_base_data_dir :".$this->getDataDir();
                         return false;
                 }
 
                 // create sub dirs in base data dir
                 if (!ilUtil::makeDir($this->getDataDir()."/mail"))
                 {
                         $this->error = "could_not_create_mail_data_dir :".$this->getDataDir()."/mail";
                         return false;
                 }
 
                 if (!ilUtil::makeDir($this->getDataDir()."/lm_data"))
                 {
                         $this->error = "could_not_create_lm_data_dir :".$this->getDataDir()."/lm_data";
                         return false;
                 }
 
                 if (!ilUtil::makeDir($this->getDataDir()."/forum"))
                 {
                         $this->error = "could_not_create_forum_data_dir :".$this->getDataDir()."/forum";
                         return false;
                 }
 
                 if (!ilUtil::makeDir($this->getDataDir()."/files"))
                 {
                         $this->error = "could_not_create_files_data_dir :".$this->getDataDir()."/files";
                         return false;
                 }
 
                 // create base webspace dir
                 if (!ilUtil::makeDir($this->getWebspaceDir()))
                 {
                         $this->error = "could_not_create_base_webspace_dir :".$this->getWebspaceDir();
                         return false;
                 }
 
                 // create sub dirs in base webspace dir
                 if (!ilUtil::makeDir($this->getWebspaceDir()."/lm_data"))
                 {
                         $this->error = "could_not_create_lm_webspace_dir :".$this->getWebspaceDir()."/lm_data";
                         return false;
                 }
 
                 if (!ilUtil::makeDir($this->getWebspaceDir()."/usr_images"))
                 {
                         $this->error = "could_not_create_usr_images_webspace_dir :".$this->getWebspaceDir()."/usr_images";
                         return false;
                 }
 
                 if (!ilUtil::makeDir($this->getWebspaceDir()."/mobs"))
                 {
                         $this->error = "could_not_create_mobs_webspace_dir :".$this->getWebspaceDir()."/mobs";
                         return false;
                 }
 
                 if (!ilUtil::makeDir($this->getWebspaceDir()."/css"))
                 {
                         $this->error = "could_not_create_css_webspace_dir :".$this->getWebspaceDir()."/css";
                         return false;
                 }
 
                 // write client ini
                 if (!$this->ini->write())
                 {
                         $this->error = get_class($this).": ".$this->ini->getError();
                         return false;
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ delete()

ilClient::delete	(	$a_ini = `true`,
		$a_db = `false`,
		$a_files = `false`
	)

delete client

Parameters

boolean	remove ini if true
boolean	remove db if true
boolean	remove files if true

Returns: array confirmation messages

Definition at line 772 of file class.ilClient.php.

References ilUtil\delDir(), getDbName(), ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.

         {
                 if ($a_ini === true and file_exists(ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId()."/client.ini.php"))
                 {
                         unlink(CLIENT_WEB_DIR."/client.ini.php");
                         $msg[] = "ini_deleted";
                 }
 
                 if ($a_db === true and $this->db_exists)
                 {
                         $this->db->query("DROP DATABASE ".$this->getDbName());
                         $msg[] = "db_deleted";
                 }
 
                 if ($a_files === true and file_exists(CLIENT_WEB_DIR) and is_dir(CLIENT_WEB_DIR))
                 {
                         // rmdir();
                         ilUtil::delDir(CLIENT_WEB_DIR);
                         ilUtil::delDir(CLIENT_DATA_DIR);
                         $msg[] = "files_deleted";
                 }
 
                 return $msg;
         }

Here is the call graph for this function:

◆ getAllSettings()

ilClient::getAllSettings ( )

read all values from settings table public

Returns: array keyword/value pairs

Definition at line 598 of file class.ilClient.php.

Referenced by getURLStringForNIC(), and updateNIC().

         {
                 include_once './Services/Administration/classes/class.ilSetting.php';
                 $set = new ilSetting("common", true);
                 return $set->getAll();
         }

Here is the caller graph for this function:

◆ getDataDir()

ilClient::getDataDir ( )

get client datadir path

Returns: string client datadir path

Definition at line 509 of file class.ilClient.php.

References getId().

Referenced by create().

         {
                 return ILIAS_DATA_DIR."/".$this->getId();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDB()

ilClient::getDB ( )

get mysql version

Get DB object

Definition at line 154 of file class.ilClient.php.

         {
                 return $this->db;
         }

◆ getDbHost()

ilClient::getDbHost ( )

get db host

Returns: string db host

Definition at line 292 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","host");
         }

◆ getDbName()

ilClient::getDbName ( )

get name of database

Returns: string name of database

Definition at line 310 of file class.ilClient.php.

Referenced by delete().

         {
                 return $this->ini->readVariable("db","name");
         }

Here is the caller graph for this function:

◆ getDbPass()

ilClient::getDbPass ( )

get db password

Returns: string db password

Definition at line 364 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","pass");
         }

◆ getDbPort()

ilClient::getDbPort ( )

get db port

Returns: string db port

Definition at line 337 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","port");
         }

◆ getDbSlaveActive()

ilClient::getDbSlaveActive ( )

get slave active

Returns: int active

Definition at line 383 of file class.ilClient.php.

         {
                 return (int) $this->ini->readVariable("db","slave_active");
         }

◆ getDbSlaveHost()

ilClient::getDbSlaveHost ( )

get db slave host

Returns: string db host

Definition at line 402 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","slave_host");
         }

◆ getDbSlaveName()

ilClient::getDbSlaveName ( )

get name of slave database

Returns: string name of database

Definition at line 420 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","slave_name");
         }

◆ getDbSlavePass()

ilClient::getDbSlavePass ( )

get slave db password

Returns: string db password

Definition at line 474 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","slave_pass");
         }

◆ getDbSlavePort()

ilClient::getDbSlavePort ( )

get slave db port

Returns: string db port

Definition at line 447 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","slave_port");
         }

◆ getDbSlaveUser()

ilClient::getDbSlaveUser ( )

get slave db user

Returns: string db user

Definition at line 438 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","slave_user");
         }

◆ getDbType()

ilClient::getDbType ( )

get type of database

Returns: string name of database

Definition at line 492 of file class.ilClient.php.

Referenced by checkDatabaseHost(), and setDSN().

         {
                 $val =  $this->ini->readVariable("db","type");
                 if ($val == "")
                 {
                         return "mysql";
                 }
                 else
                 {
                         return $val;
                 }
         }

Here is the caller graph for this function:

◆ getDbUser()

ilClient::getDbUser ( )

get db user

Returns: string db user

Definition at line 328 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("db","user");
         }

◆ getDefaultLanguage()

ilClient::getDefaultLanguage ( )

Definition at line 738 of file class.ilClient.php.

References getSetting().

         {
                 return $this->getSetting("language");
         }

Here is the call graph for this function:

◆ getDescription()

ilClient::getDescription ( )

get client description

Returns: string client description

Definition at line 129 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("client","description");
         }

◆ getError()

ilClient::getError ( )

get error message and clear error var

Returns: string error message

Definition at line 756 of file class.ilClient.php.

         {
                 $error = $this->error;
                 $this->error = "";
 
                 return $error;
         }

◆ getId()

ilClient::getId ( )

get client id

Returns: string client id

Definition at line 92 of file class.ilClient.php.

References $id.

Referenced by getDataDir(), getWebspaceDir(), and ilClient().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getName()

ilClient::getName ( )

get client name

Returns: string client name

Definition at line 111 of file class.ilClient.php.

         {
                 return $this->ini->readVariable("client","name");
         }

◆ getNICkey()

ilClient::getNICkey ( )

get nic_key public

Returns: string nic_key

Definition at line 726 of file class.ilClient.php.

References getSetting(), and setNICkey().

Referenced by getURLStringForNIC().

         {
                 $this->nic_key = $this->getSetting("nic_key");
                 
                 if (empty($this->nic_key))
                 {
                         $this->setNICkey();
                 }
                 
                 return $this->nic_key;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSetting()

ilClient::getSetting ( $a_keyword )

read one value from settings table public

Parameters

string keyword

Returns: string value

Definition at line 586 of file class.ilClient.php.

Referenced by getDefaultLanguage(), and getNICkey().

         {
                 include_once './Services/Administration/classes/class.ilSetting.php';
                 $set = new ilSetting("common", true);
                 return $set->get($a_keyword);
         }

Here is the caller graph for this function:

◆ getURLStringForNIC()

ilClient::getURLStringForNIC ( $a_nic_url )

Parameters

string url to ilias nic server

Returns: string url with required parameters

Definition at line 623 of file class.ilClient.php.

References getAllSettings(), and getNICkey().

Referenced by updateNIC().

         {
                 $settings = $this->getAllSettings();
 
                 $inst_id = (empty($settings["inst_id"])) ? "0" : $settings["inst_id"];
 
                 // send host information to ilias-nic
                 $url =  $a_nic_url.
                                 "?cmd=getid".
                                 "&inst_id=".rawurlencode($inst_id).
                                 "&hostname=".rawurlencode($_SERVER["SERVER_NAME"]).
                                 "&ipadr=".rawurlencode($_SERVER["SERVER_ADDR"]).
                                 "&server_port=".rawurlencode($_SERVER["SERVER_PORT"]).
                                 "&server_software=".rawurlencode($_SERVER["SERVER_SOFTWARE"]).
                                 "&inst_name=".rawurlencode($this->ini->readVariable("client","name")).
                                 "&inst_info=".rawurlencode($this->ini->readVariable("client","description")).
                                 "&institution=".rawurlencode($settings["inst_institution"]).
                                 "&http_path=".rawurlencode(ILIAS_HTTP_PATH).
                                 "&contact_firstname=".rawurlencode($settings["admin_firstname"]).
                                 "&contact_lastname=".rawurlencode($settings["admin_lastname"]).
                                 "&contact_title=".rawurlencode($settings["admin_title"]).
                                 "&contact_position=".rawurlencode($settings["admin_position"]).                 
                                 "&contact_institution=".rawurlencode($settings["admin_institution"]).
                                 "&contact_street=".rawurlencode($settings["admin_street"]).
                                 "&contact_pcode=".rawurlencode($settings["admin_zipcode"]).
                                 "&contact_city=".rawurlencode($settings["admin_city"]).
                                 "&contact_country=".rawurlencode($settings["admin_country"]).
                                 "&contact_phone=".rawurlencode($settings["admin_phone"]).
                                 "&contact_email=".rawurlencode($settings["admin_email"]).
                                 "&nic_key=".rawurlencode($this->getNICkey()).
                                 "&version=".rawurlencode($settings["ilias_version"]);
                                 
                 return $url;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWebspaceDir()

ilClient::getWebspaceDir ( )

get client webspacedir path

Returns: string clietn webspacedir path

Definition at line 518 of file class.ilClient.php.

References getId(), ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.

Referenced by create().

         {
                 return ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ilClient()

ilClient::ilClient	(	$a_client_id,
		$a_db_connections
	)

Constructor.

Parameters

string client id

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

References getId(), ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.

         {
                 if ($a_client_id)
                 {
                         $this->id = $a_client_id;
                         $this->ini_file_path = ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId()."/client.ini.php";
                 }
 
                 $this->db_connections = $a_db_connections;
                 
                 // set path default.ini
                 $this->client_defaults = ILIAS_ABSOLUTE_PATH."/setup/client.master.ini.php";
         }

Here is the call graph for this function:

◆ init()

ilClient::init ( )

init client load client.ini and set some constants

Returns: boolean

Definition at line 48 of file class.ilClient.php.

References connect(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, and isInstalledDB().

         {
                 $this->ini = new ilIniFile($this->ini_file_path);
 
                 // load defaults only if no client.ini was found
                 if (!@file_exists($this->ini_file_path))
                 {
 //echo "<br>A-".$this->ini_file_path."-";
                         $this->ini->GROUPS = parse_ini_file($this->client_defaults,true);
                         return false;
                 }
 
                 // read client.ini
                 if (!$this->ini->read())
                 {
                         $this->error = get_class($this).": ".$this->ini->getError();
                         return false;           
                 }
 
                 // only for ilias main
                 define("CLIENT_WEB_DIR",ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->getId());
                 define("CLIENT_DATA_DIR",ILIAS_DATA_DIR."/".$this->getId());
                 define ("DEVMODE",$this->ini->readVariable('system','DEVMODE'));
                 define ("ROOT_FOLDER_ID",$this->ini->readVariable('system','ROOT_FOLDER_ID'));
                 define ("SYSTEM_FOLDER_ID",$this->ini->readVariable('system','SYSTEM_FOLDER_ID'));
                 define ("ROLE_FOLDER_ID",$this->ini->readVariable('system','ROLE_FOLDER_ID'));
                 define ("ANONYMOUS_USER_ID",13);
                 define ("ANONYMOUS_ROLE_ID",14);
                 define ("SYSTEM_USER_ID",6);
                 define ("SYSTEM_ROLE_ID",2);
                 
                 $this->db_exists = $this->connect();
                 if ($this->db_exists)
                 {
                         $this->db_installed = $this->isInstalledDB($this->db);
                 }
                 
                 return true;    
         }

Here is the call graph for this function:

◆ isInstalledDB()

ilClient::isInstalledDB ( & $a_db )

check if client db is installed

Parameters

object db object

Returns: boolean true if installed

Definition at line 206 of file class.ilClient.php.

Referenced by checkDatabaseExists(), and init().

         {
                 if(method_exists($a_db,'loadModule'))
                 {
                         $a_db->loadModule('Manager');
                 }
                 if(!$tables = $a_db->listTables())
                 {
                         return false;
                 }
                 
                 // check existence of some basic tables from ilias3 to determine if ilias3 is already installed in given database
                 if (in_array("object_data",$tables) and in_array("object_reference",$tables) and in_array("usr_data",$tables) and in_array("rbac_ua",$tables))
                 {
                         $this->db_installed = true;
                         return true;
                 }
                 $this->db_installed = false;
                 return false;
         }

Here is the caller graph for this function:

◆ reconnect()

ilClient::reconnect ( )

Definition at line 575 of file class.ilClient.php.

References connect().

         {
                 $this->connect();
         }

Here is the call graph for this function:

◆ setDbHost()

ilClient::setDbHost ( $a_str )

set the host

Parameters

string

Definition at line 282 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","host",$a_str);
         }

◆ setDbName()

ilClient::setDbName ( $a_str )

set the name of database

Parameters

string

Definition at line 301 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","name",$a_str);
         }

◆ setDbPass()

ilClient::setDbPass ( $a_str )

set db password

Parameters

string

Definition at line 355 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","pass",$a_str);
         }

◆ setDbPort()

ilClient::setDbPort ( $a_str )

set db port

Parameters

string

Definition at line 346 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","port",$a_str);
         }

◆ setDbSlaveActive()

ilClient::setDbSlaveActive ( $a_act )

set the slave active

Parameters

int

Definition at line 373 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","slave_active", (int) $a_act);
         }

◆ setDbSlaveHost()

ilClient::setDbSlaveHost ( $a_str )

set the slave host

Parameters

string

Definition at line 392 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","slave_host",$a_str);
         }

◆ setDbSlaveName()

ilClient::setDbSlaveName ( $a_str )

set the name of slave database

Parameters

string

Definition at line 411 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","slave_name",$a_str);
         }

◆ setDbSlavePass()

ilClient::setDbSlavePass ( $a_str )

set slave db password

Parameters

string

Definition at line 465 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","slave_pass",$a_str);
         }

◆ setDbSlavePort()

ilClient::setDbSlavePort ( $a_str )

set slave db port

Parameters

string

Definition at line 456 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","slave_port",$a_str);
         }

◆ setDbSlaveUser()

ilClient::setDbSlaveUser ( $a_str )

set slave db user

Parameters

string db user

Definition at line 429 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","slave_user",$a_str);
         }

◆ setDbType()

ilClient::setDbType ( $a_str )

set the type of database

Parameters

string

Definition at line 483 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","type",$a_str);
         }

◆ setDbUser()

ilClient::setDbUser ( $a_str )

set db user

Parameters

string db user

Definition at line 319 of file class.ilClient.php.

         {
                 $this->ini->setVariable("db","user",$a_str);
         }

◆ setDefaultLanguage()

ilClient::setDefaultLanguage ( $a_lang_key )

Definition at line 743 of file class.ilClient.php.

References setSetting().

         {
                 $this->setSetting("language",$a_lang_key);
                 $this->ini->setVariable("language","default",$a_lang_key);
                 $this->ini->write();
                 
                 return true;
         }

Here is the call graph for this function:

◆ setDescription()

ilClient::setDescription ( $a_str )

set client description

Parameters

string client description

Definition at line 138 of file class.ilClient.php.

         {
                 $this->ini->setVariable("client","description",$a_str);
         }

◆ setDSN()

ilClient::setDSN ( )

set the dsn and dsn_host

Definition at line 230 of file class.ilClient.php.

References getDbType().

         {
                 switch($this->getDbType())
                 {
                         case "oracle":
                                 //$this->dsn_host = "oci8://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost();
                                 $this->dsn_host = array(
                                                 'phptype' => 'oci8',
                                                 'hostspec' => $this->getdbHost(),
                                                 'username' => $this->getdbUser(),
                                                                                                 'port' => $this->getdbPort(),
                                                 'password' => $this->getdbPass(),
                                                 );
                                 //$this->dsn = "oci8://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost()."/?service=".$this->getdbName();
                                 $this->dsn = $this->dsn = array(
                                         'phptype' => 'oci8',
                                         'hostspec' => $this->getdbHost(),
                                         'username' => $this->getdbUser(),
                                         'port' => $this->getdbPort(),
                                         'password' => $this->getdbPass(),
                                         'service' => $this->getdbName()
                                         );
                                 break;
 
                         case "postgres":
                                 $db_port_str = "";
                                 if (trim($this->getdbPort()) != "")
                                 {
                                         $db_port_str = ":".$this->getdbPort();
                                 }
                                 $this->dsn_host = "pgsql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str;
                                 $this->dsn = "pgsql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str."/".$this->getdbName();
                                 break;
                                 
                         case "mysql":
                         case "innodb":
                         default:
                                 $db_port_str = "";
                                 if (trim($this->getdbPort()) != "")
                                 {
                                         $db_port_str = ":".$this->getdbPort();
                                 }
                                 $this->dsn_host = "mysql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str;
                                 $this->dsn = "mysql://".$this->getdbUser().":".$this->getdbPass()."@".$this->getdbHost().$db_port_str."/".$this->getdbName();
                                 break;
                 }                               
         }

Here is the call graph for this function:

◆ setId()

ilClient::setId ( $a_client_id )

set client id

Parameters

string client id

Definition at line 101 of file class.ilClient.php.

References $id, ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.

         {
                 $this->id = $a_client_id;
                 $this->webspace_dir = ILIAS_ABSOLUTE_PATH."/".ILIAS_WEB_DIR."/".$this->id;
         }

◆ setName()

ilClient::setName ( $a_str )

set client name

Parameters

string client name

Definition at line 120 of file class.ilClient.php.

         {
                 $this->ini->setVariable("client","name",$a_str);
         }

◆ setNICkey()

ilClient::setNICkey ( )

set nic_key generate nic_key if nic_key field in cust table is empty.

the nic_key is used for authentication update requests sent to the ILIAS-NIC server. public

Returns: boolean

Definition at line 708 of file class.ilClient.php.

References setSetting().

Referenced by getNICkey().

         {
                 mt_srand((double)microtime()*1000000);
                 $nic_key =      md5(str_replace(".","",$_SERVER["SERVER_ADDR"]) +
                                         mt_rand(100000,999999));
                 
                 $this->setSetting("nic_key",$nic_key);
                 
                 $this->nic_key = $nic_key;
                 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSetting()

ilClient::setSetting	(	$a_key,
		$a_val
	)

write one value to settings table public

Parameters

string	keyword
string	value

Returns: boolean true on success

Definition at line 612 of file class.ilClient.php.

Referenced by setDefaultLanguage(), and setNICkey().

         {
                 include_once './Services/Administration/classes/class.ilSetting.php';
                 $set = new ilSetting("common", true);
                 $set->set($a_key, $a_val);
         }

Here is the caller graph for this function:

◆ updateNIC()

ilClient::updateNIC ( $a_nic_url )

Connect to ILIAS-NIC.

This function establishes a HTTP connection to the ILIAS Network Information Center (NIC) in order to update the ILIAS-NIC host database and - in case of a newly installed system - obtain an installation id at first connection. This function my be put into a dedicated include file as soon as there are more functions concerning the interconnection of ILIAS hosts

Parameters

void

Returns: string/array $ret error message or data array

Definition at line 672 of file class.ilClient.php.

References getAllSettings(), and getURLStringForNIC().

         {
                 $settings = $this->getAllSettings();
                 if((bool)$settings['proxy_status'] && strlen($settings['proxy_host']) && strlen($settings['proxy_port']))
                 {
                         $proxy_options = array(
                                 'proxy_host' => $settings['proxy_host'],
                                 'proxy_port' => $settings['proxy_port']
                         );
                 }
                 else
                 {
                         $proxy_options = array();
                 }
 
                 include_once('HTTP/Request.php');
                 $url = $this->getURLStringForNIC($a_nic_url);
                 $req = new HTTP_Request($url, $proxy_options);
 
                 $req->sendRequest();
                 $response = $req->getResponseBody();
                 $response = explode("\n", $response);
 
                 $this->nic_status = $response;
                 
                 return true;
         }

Here is the call graph for this function:

◆ writeIni()

ilClient::writeIni ( )

write init

Parameters

Definition at line 884 of file class.ilClient.php.

         {
                 $this->ini->write();
         }

Field Documentation

◆ $client_defaults

ilClient::$client_defaults

Definition at line 20 of file class.ilClient.php.

◆ $db_exists

ilClient::$db_exists = false

Definition at line 17 of file class.ilClient.php.

◆ $db_installed

ilClient::$db_installed = false

Definition at line 18 of file class.ilClient.php.

◆ $dir

ilClient::$dir

Definition at line 15 of file class.ilClient.php.

◆ $id

ilClient::$id

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

Referenced by getId(), and setId().

◆ $name

ilClient::$name

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

◆ $nic_status

ilClient::$nic_status

Definition at line 23 of file class.ilClient.php.

◆ $setup_ok

ilClient::$setup_ok = false

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

◆ $status

ilClient::$status

Definition at line 21 of file class.ilClient.php.

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

setup/classes/class.ilClient.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ checkDatabaseExists()

◆ checkDatabaseHost()

◆ connect()

◆ create()

◆ delete()

◆ getAllSettings()

◆ getDataDir()

◆ getDB()

◆ getDbHost()

◆ getDbName()

◆ getDbPass()

◆ getDbPort()

◆ getDbSlaveActive()

◆ getDbSlaveHost()

◆ getDbSlaveName()

◆ getDbSlavePass()

◆ getDbSlavePort()

◆ getDbSlaveUser()

◆ getDbType()

◆ getDbUser()

◆ getDefaultLanguage()

◆ getDescription()

◆ getError()

◆ getId()

◆ getName()

◆ getNICkey()

◆ getSetting()

◆ getURLStringForNIC()

◆ getWebspaceDir()

◆ ilClient()

◆ init()

◆ isInstalledDB()

◆ reconnect()

◆ setDbHost()

◆ setDbName()

◆ setDbPass()

◆ setDbPort()

◆ setDbSlaveActive()

◆ setDbSlaveHost()

◆ setDbSlaveName()

◆ setDbSlavePass()

◆ setDbSlavePort()

◆ setDbSlaveUser()

◆ setDbType()

◆ setDbUser()

◆ setDefaultLanguage()

◆ setDescription()

◆ setDSN()

◆ setId()

◆ setName()

◆ setNICkey()

◆ setSetting()

◆ updateNIC()

◆ writeIni()

Field Documentation

◆ $client_defaults

◆ $db_exists

◆ $db_installed

◆ $dir

◆ $id

◆ $name

◆ $nic_status

◆ $setup_ok

◆ $status