ILIAS
Release_4_0_x_branch Revision 61816
|
Client Management. More...
Public Member Functions | |
ilClient ($a_client_id, $a_db_connections) | |
Constructor. | |
init () | |
init client load client.ini and set some constants | |
getId () | |
get client id | |
setId ($a_client_id) | |
set client id | |
getName () | |
get client name | |
setName ($a_str) | |
set client name | |
getDescription () | |
get client description | |
setDescription ($a_str) | |
set client description | |
getDB () | |
get mysql version | |
connect () | |
connect to client database | |
isInstalledDB (&$a_db) | |
check if client db is installed | |
setDSN () | |
set the dsn and dsn_host | |
setDbHost ($a_str) | |
set the host | |
getDbHost () | |
get db host | |
setDbName ($a_str) | |
set the name of database | |
getDbName () | |
get name of database | |
setDbUser ($a_str) | |
set db user | |
getDbUser () | |
get db user | |
getDbPort () | |
get db port | |
setDbPort ($a_str) | |
set db port | |
setDbPass ($a_str) | |
set db password | |
getDbPass () | |
get db password | |
setDbType ($a_str) | |
set the type of database | |
getDbType () | |
get type of database | |
getDataDir () | |
get client datadir path | |
getWebspaceDir () | |
get client webspacedir path | |
checkDatabaseHost () | |
check database connection | |
checkDatabaseExists () | |
check database connection with database name | |
reconnect () | |
getSetting ($a_keyword) | |
read one value from settings table public | |
getAllSettings () | |
read all values from settings table public | |
setSetting ($a_key, $a_val) | |
write one value to settings table public | |
getURLStringForNIC ($a_nic_url) | |
updateNIC ($a_nic_url) | |
Connect to ILIAS-NIC. | |
setNICkey () | |
set nic_key generate nic_key if nic_key field in cust table is empty. | |
getNICkey () | |
get nic_key public | |
getDefaultLanguage () | |
setDefaultLanguage ($a_lang_key) | |
getError () | |
get error message and clear error var | |
delete ($a_ini=true, $a_db=false, $a_files=false) | |
delete client | |
create () | |
create a new client and its subdirectories |
Data Fields | |
$id | |
$dir | |
$name | |
$db_exists = false | |
$db_installed = false | |
$client_defaults | |
$status | |
$setup_ok = false | |
$nic_status |
Client Management.
Definition at line 12 of file class.ilClient.php.
ilClient::checkDatabaseExists | ( | ) |
check database connection with database name
Definition at line 433 of file class.ilClient.php.
References MDB2\isError(), and isInstalledDB().
ilClient::checkDatabaseHost | ( | ) |
check database connection
Definition at line 407 of file class.ilClient.php.
References $lng, getDbType(), and MDB2\isError().
ilClient::connect | ( | ) |
connect to client database
Definition at line 163 of file class.ilClient.php.
References $GLOBALS, and ilDBWrapperFactory\getWrapper().
Referenced by init(), and reconnect().
ilClient::create | ( | ) |
create a new client and its subdirectories
Definition at line 678 of file class.ilClient.php.
References getDataDir(), getWebspaceDir(), and ilUtil\makeDir().
ilClient::delete | ( | $a_ini = true , |
|
$a_db = false , |
|||
$a_files = false |
|||
) |
delete client
boolean | remove ini if true |
boolean | remove db if true |
boolean | remove files if true |
Definition at line 649 of file class.ilClient.php.
References ilUtil\delDir(), getDbName(), ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.
ilClient::getAllSettings | ( | ) |
read all values from settings table public
Definition at line 473 of file class.ilClient.php.
Referenced by getURLStringForNIC().
ilClient::getDataDir | ( | ) |
get client datadir path
Definition at line 389 of file class.ilClient.php.
References getId().
Referenced by create().
ilClient::getDB | ( | ) |
get mysql version
Get DB object
Definition at line 154 of file class.ilClient.php.
ilClient::getDbHost | ( | ) |
get db host
Definition at line 282 of file class.ilClient.php.
ilClient::getDbName | ( | ) |
get name of database
Definition at line 300 of file class.ilClient.php.
Referenced by delete().
ilClient::getDbPass | ( | ) |
get db password
Definition at line 354 of file class.ilClient.php.
ilClient::getDbPort | ( | ) |
get db port
Definition at line 327 of file class.ilClient.php.
ilClient::getDbType | ( | ) |
get type of database
Definition at line 372 of file class.ilClient.php.
Referenced by checkDatabaseHost(), and setDSN().
ilClient::getDbUser | ( | ) |
get db user
Definition at line 318 of file class.ilClient.php.
ilClient::getDefaultLanguage | ( | ) |
Definition at line 615 of file class.ilClient.php.
References getSetting().
ilClient::getDescription | ( | ) |
get client description
Definition at line 129 of file class.ilClient.php.
ilClient::getError | ( | ) |
get error message and clear error var
Definition at line 633 of file class.ilClient.php.
References $error.
ilClient::getId | ( | ) |
get client id
Definition at line 92 of file class.ilClient.php.
References $id.
Referenced by getDataDir(), getWebspaceDir(), and ilClient().
ilClient::getName | ( | ) |
get client name
Definition at line 111 of file class.ilClient.php.
ilClient::getNICkey | ( | ) |
get nic_key public
Definition at line 603 of file class.ilClient.php.
References getSetting(), and setNICkey().
Referenced by getURLStringForNIC().
ilClient::getSetting | ( | $a_keyword | ) |
read one value from settings table public
string | keyword |
Definition at line 461 of file class.ilClient.php.
Referenced by getDefaultLanguage(), and getNICkey().
ilClient::getURLStringForNIC | ( | $a_nic_url | ) |
string | url to ilias nic server |
Definition at line 498 of file class.ilClient.php.
References getAllSettings(), and getNICkey().
Referenced by updateNIC().
ilClient::getWebspaceDir | ( | ) |
get client webspacedir path
Definition at line 398 of file class.ilClient.php.
References getId(), ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.
Referenced by create().
ilClient::ilClient | ( | $a_client_id, | |
$a_db_connections | |||
) |
Constructor.
string | client id |
Definition at line 29 of file class.ilClient.php.
References getId(), ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.
ilClient::init | ( | ) |
init client load client.ini and set some constants
Definition at line 48 of file class.ilClient.php.
References connect(), ILIAS_ABSOLUTE_PATH, ILIAS_WEB_DIR, and isInstalledDB().
ilClient::isInstalledDB | ( | & | $a_db | ) |
check if client db is installed
object | db object |
Definition at line 207 of file class.ilClient.php.
Referenced by checkDatabaseExists(), and init().
ilClient::reconnect | ( | ) |
Definition at line 450 of file class.ilClient.php.
References connect().
ilClient::setDbHost | ( | $a_str | ) |
set the host
string |
Definition at line 272 of file class.ilClient.php.
ilClient::setDbName | ( | $a_str | ) |
set the name of database
string |
Definition at line 291 of file class.ilClient.php.
ilClient::setDbPass | ( | $a_str | ) |
set db password
string |
Definition at line 345 of file class.ilClient.php.
ilClient::setDbPort | ( | $a_str | ) |
set db port
string |
Definition at line 336 of file class.ilClient.php.
ilClient::setDbType | ( | $a_str | ) |
set the type of database
string |
Definition at line 363 of file class.ilClient.php.
ilClient::setDbUser | ( | $a_str | ) |
set db user
string | db user |
Definition at line 309 of file class.ilClient.php.
ilClient::setDefaultLanguage | ( | $a_lang_key | ) |
Definition at line 620 of file class.ilClient.php.
References setSetting().
ilClient::setDescription | ( | $a_str | ) |
set client description
string | client description |
Definition at line 138 of file class.ilClient.php.
ilClient::setDSN | ( | ) |
set the dsn and dsn_host
Definition at line 231 of file class.ilClient.php.
References getDbType().
ilClient::setId | ( | $a_client_id | ) |
set client id
string | client id |
Definition at line 101 of file class.ilClient.php.
References $id, ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.
ilClient::setName | ( | $a_str | ) |
set client name
string | client name |
Definition at line 120 of file class.ilClient.php.
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
Definition at line 585 of file class.ilClient.php.
References setSetting().
Referenced by getNICkey().
ilClient::setSetting | ( | $a_key, | |
$a_val | |||
) |
write one value to settings table public
string | keyword |
string | value |
Definition at line 487 of file class.ilClient.php.
Referenced by setDefaultLanguage(), and setNICkey().
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
void |
Definition at line 547 of file class.ilClient.php.
References $ret, and getURLStringForNIC().
ilClient::$client_defaults |
Definition at line 20 of file class.ilClient.php.
ilClient::$db_exists = false |
Definition at line 17 of file class.ilClient.php.
ilClient::$db_installed = false |
Definition at line 18 of file class.ilClient.php.
ilClient::$dir |
Definition at line 15 of file class.ilClient.php.
ilClient::$id |
Definition at line 14 of file class.ilClient.php.
ilClient::$name |
Definition at line 16 of file class.ilClient.php.
ilClient::$nic_status |
Definition at line 23 of file class.ilClient.php.
ilClient::$setup_ok = false |
Definition at line 22 of file class.ilClient.php.
ilClient::$status |
Definition at line 21 of file class.ilClient.php.