Inheritance diagram for ilSoapAdministration:

Public Member Functions
	ilSoapAdministration ($use_nusoap=true)
	__checkSession ($sid)
	initErrorWriter ()
	Overwrite error handler.
	__explodeSid ($sid)
	__setMessage ($a_str)
	__getMessage ()
	__appendMessage ($a_str)
	__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
	__raiseError ($a_message, $a_code)
	getNIC ($sid)
	get client information from current as xml result set
Data Fields
	$sauth = null
	$error_method = null
Private Member Functions
	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes

Detailed Description

Definition at line 41 of file class.ilSoapAdministration.php.

Member Function Documentation

ilSoapAdministration::__appendMessage ( $ a_str )

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

Referenced by ilSoapUserAdministration::__validateUserData().

        {
                $this->message .= isset($this->message) ? ' ' : '';
                $this->message .= $a_str;
        }

Here is the caller graph for this function:

ilSoapAdministration::__checkSession ( $ sid )

Definition at line 75 of file class.ilSoapAdministration.php.

References $client, and __explodeSid().

        {
                list($sid,$client) = $this->__explodeSid($sid);

                $this->sauth->setClient($client);
                $this->sauth->setSid($sid);

                if(!$this->sauth->validateSession())
                {
                        return false;
                }
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapAdministration::__explodeSid ( $ sid )

Definition at line 104 of file class.ilSoapAdministration.php.

Referenced by __checkSession().

        {
                $exploded = explode('::',$sid);

                return is_array($exploded) ? $exploded : array('sid' => '','client' => '');
        }

Here is the caller graph for this function:

ilSoapAdministration::__getMessage ( )

Definition at line 116 of file class.ilSoapAdministration.php.

Referenced by ilSoapUserAdministration::__validateUserData(), ilSoapUserAdministration::addUser(), and ilSoapUserAdministration::updateUser().

        {
                return $this->message;
        }

Here is the caller graph for this function:

ilSoapAdministration::__initAuthenticationObject ( $ a_auth_mode = AUTH_LOCAL )

Definition at line 127 of file class.ilSoapAdministration.php.

Referenced by ilSoapAdministration(), ilSoapUserAdministration::login(), ilSoapUserAdministration::loginCAS(), and ilSoapUserAdministration::loginLDAP().

        {
                switch($a_auth_mode)
                {
                        case AUTH_CAS:
                                include_once './webservice/soap/classes/class.ilSoapAuthenticationCAS.php';
                                return $this->sauth = new ilSoapAuthenticationCAS();
                        case AUTH_LDAP:
                                include_once './webservice/soap/classes/class.ilSoapAuthenticationLDAP.php';
                                return $this->sauth = new ilSoapAuthenticationLDAP();

                        default:
                                include_once './webservice/soap/classes/class.ilSoapAuthentication.php';
                                return $this->sauth = new ilSoapAuthentication();
                }
        }

Here is the caller graph for this function:

ilSoapAdministration::__raiseError	(	$	a_message,
		$	a_code
	)

Definition at line 145 of file class.ilSoapAdministration.php.

        {
                switch($this->error_method)
                {
                        case NUSOAP:
                                return new soap_fault($a_code,'',$a_message);
                        case PHP5:
                                return new SoapFault($a_code, $a_message);
                }
        }

Here is the caller graph for this function:

ilSoapAdministration::__setMessage ( $ a_str )

Definition at line 112 of file class.ilSoapAdministration.php.

Referenced by ilSoapUserAdministration::__validateUserData().

        {
                $this->message = $a_str;
        }

Here is the caller graph for this function:

ilSoapAdministration::getNIC ( $ sid )

get client information from current as xml result set

Parameters:

string

$sid current session id

Returns:: XMLResultSet containing columns installation_id, installation_version, installation_url, installation_description, installation_default_language

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

References $ilLog, $ilSetting, __checkSession(), __raiseError(), ilAuthUtils::_getActiveAuthModes(), ilAuthUtils::_getAuthModeName(), and return_bytes().

                              {
            if(!$this->__checkSession($sid))
                {
                        return $this->__raiseError($this->sauth->getMessage(),$this->sauth->getMessageCode());
                }

                // Include main header
                include_once './include/inc.header.php';
                global $rbacsystem, $rbacreview, $ilLog, $rbacadmin,$ilSetting, $ilClientIniFile;

                if (!is_object($ilClientIniFile)) {
                    return $this->__raiseError("Client ini is not initialized","Server");
                }

                $auth_modes = ilAuthUtils::_getActiveAuthModes();
                $auth_mode_default =  strtoupper(ilAuthUtils::_getAuthModeName(array_shift($auth_modes)));
                $auth_mode_names = array();
                foreach ($auth_modes as $mode) {
                        $auth_mode_names[] = strtoupper(ilAuthUtils::_getAuthModeName($mode));
                }

        // todo: get information from client id, read from ini file specificied
        $client_details[] = array ("installation_id" => IL_INST_ID,
                                   "installation_version" => ILIAS_VERSION,
                                   "installation_url" => ILIAS_HTTP_PATH,
                                   "installation_description" => $ilClientIniFile->readVariable("client","description"),
                                                                        "installation_language_default" => $ilClientIniFile->readVariable("language","default"),
                                                                        "installation_session_expire" => $ilClientIniFile->readVariable("session","expire"),
                                                                        "installation_php_postmaxsize" => $this->return_bytes(ini_get("post_max_size")),
                                                                        "authentication_methods" => join(",", $auth_mode_names),
                                                                        "authentication_default_method" => $auth_mode_default

                                                                                                                                                );

        // store into xml result set
                include_once './webservice/soap/classes/class.ilXMLResultSet.php';


        $xmlResult = new ilXMLResultSet();
        $xmlResult->addArray($client_details, true);

        // create writer and return xml
                include_once './webservice/soap/classes/class.ilXMLResultSetWriter.php';
        $xmlResultWriter = new ilXMLResultSetWriter($xmlResult);
        $xmlResultWriter->start();
        return $xmlResultWriter->getXML();
        }

Here is the call graph for this function:

ilSoapAdministration::ilSoapAdministration ( $ use_nusoap = true )

Definition at line 56 of file class.ilSoapAdministration.php.

References __initAuthenticationObject().

        {
                define('USER_FOLDER_ID',7);
                define('NUSOAP',1);
                define('PHP5',2);

                if(IL_SOAPMODE == IL_SOAPMODE_NUSOAP)
                {
                        $this->error_method = NUSOAP;
                } 
                else
                { 
                        $this->error_method = PHP5;
                }
                $this->__initAuthenticationObject();

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapAdministration::initErrorWriter ( )

Overwrite error handler.

public

Parameters:

Definition at line 96 of file class.ilSoapAdministration.php.

        {
                include_once('classes/class.ilErrorHandling.php');

                set_error_handler(array('ilErrorHandling','_ilErrorWriter'),E_ALL);
        }

ilSoapAdministration::return_bytes ( $ val ) [private]

calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes

Definition at line 215 of file class.ilSoapAdministration.php.

Referenced by getNIC().

                                            {
                $val = trim($val);
                $last = strtolower($val{strlen($val)-1});
                switch($last) {
                // The 'G' modifier is available since PHP 5.1.0
                case 'g':
                        $val *= 1024;
                case 'm':
                        $val *= 1024;
                case 'k':
                        $val *= 1024;
                }
                return $val;
        }

Here is the caller graph for this function:

Field Documentation

ilSoapAdministration::$error_method = null

Definition at line 53 of file class.ilSoapAdministration.php.

ilSoapAdministration::$sauth = null

Definition at line 47 of file class.ilSoapAdministration.php.

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

webservice/soap/classes/class.ilSoapAdministration.php

ilSoapAdministration Class Reference

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Member Function Documentation

Field Documentation