ilSoapClient Class Reference

Collaboration diagram for ilSoapClient:

Public Member Functions
	__construct ($a_uri='')
	getServer ()
	Get server uri. More...
	setTimeout ($a_timeout)
	Set connect timeout. More...
	getTimeout ()
	Get connect timeout. More...
	setResponseTimeout ($a_timeout)
	getResponseTimeout ()
	enableWSDL ($a_stat)
	enable wsdl mode More...
	enabledWSDL ()
	Check if wsdl is enabled. More...
	init ()
	Init soap client. More...
	call ($a_operation, $a_params)
	Call webservice method. More...

Data Fields
const	DEFAULT_CONNECT_TIMEOUT = 10
const	DEFAULT_RESPONSE_TIMEOUT = 5

Protected Member Functions
	setSocketTimeout ($a_wsdl_mode)
	Set socket timeout. More...
	resetSocketTimeout ()
	Reset socket default timeout to defaults. More...

Private Attributes
	$log = null
	$client = null
	$uri
	$connect_timeout = 10
	$response_timeout = 10
	$stored_socket_timeout = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSoapClient::__construct

(

$a_uri = ''

)

Parameters

string

$a_uri

Definition at line 40 of file class.ilSoapClient.php.

References $ilSetting, and ilLoggerFactory\getLogger().

    {
        global $ilSetting;
        
        $this->log = ilLoggerFactory::getLogger('wsrv');

        $this->uri = $a_uri;

        $this->use_wsdl = true;
        $timeout = $ilSetting->get('soap_connect_timeout', self::DEFAULT_CONNECT_TIMEOUT);
        if (!$timeout) {
            $timeout = self::DEFAULT_CONNECT_TIMEOUT;
        }
        $this->connect_timeout = $timeout;
        
        $this->response_timeout = self::DEFAULT_RESPONSE_TIMEOUT;
    }

Here is the call graph for this function:

Member Function Documentation

call()

ilSoapClient::call	(		$a_operation,
			$a_params
	)

Call webservice method.

Parameters

string	$a_operation
array	$a_params

Definition at line 193 of file class.ilSoapClient.php.

References resetSocketTimeout(), and setSocketTimeout().

    {
        $this->log->debug('Calling webservice: ' . $a_operation);

        $this->setSocketTimeout(false);
        try {
            return $this->client->__call($a_operation, $a_params);
        } catch (SoapFault $exception) {
            $this->log->error('Calling webservice failed with message: ' . $exception->getMessage());
            $this->log->debug($this->client->__getLastResponseHeaders());
            $this->log->debug($this->client->__getLastResponse());
            return false;
        } catch (Exception $exception) {
            $this->log->error('Caught unknown exception with message: ' . $exception->getMessage());
            $this->log->debug($this->client->__getLastResponseHeaders());
            $this->log->debug($this->client->__getLastResponse());
        } finally {
            $this->resetSocketTimeout();
        }
    }

Here is the call graph for this function:

enabledWSDL()

ilSoapClient::enabledWSDL

(

)

Check if wsdl is enabled.

Returns

type

Definition at line 114 of file class.ilSoapClient.php.

    {
        return $this->use_wsdl;
    }

enableWSDL()

ilSoapClient::enableWSDL

(

$a_stat

)

enable wsdl mode

Parameters

type

$a_stat

Definition at line 105 of file class.ilSoapClient.php.

    {
        $this->use_wsdl = $a_stat;
    }

getResponseTimeout()

ilSoapClient::getResponseTimeout

(

)

Returns

int Response Timeout

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

References $response_timeout.

Referenced by init(), and setSocketTimeout().

    {
        return $this->response_timeout;
    }

Here is the caller graph for this function:

getServer()

ilSoapClient::getServer

(

)

Get server uri.

Returns

string

Definition at line 62 of file class.ilSoapClient.php.

References $uri.

Referenced by init().

    {
        return $this->uri;
    }

Here is the caller graph for this function:

getTimeout()

ilSoapClient::getTimeout

(

)

Get connect timeout.

Returns

int

Definition at line 80 of file class.ilSoapClient.php.

References $connect_timeout.

Referenced by init(), and setSocketTimeout().

    {
        return $this->connect_timeout;
    }

Here is the caller graph for this function:

init()

ilSoapClient::init

(

)

Init soap client.

Definition at line 123 of file class.ilSoapClient.php.

References $ilSetting, ilUtil\_getHttpPath(), array, getResponseTimeout(), getServer(), getTimeout(), resetSocketTimeout(), and setSocketTimeout().

    {
        global $ilSetting;
        
        if (!strlen(trim($this->getServer()))) {
            if (strlen(trim($ilSetting->get('soap_wsdl_path', '')))) {
                $this->uri = $ilSetting->get('soap_wsdl_path', '');
            } else {
                $this->uri = ilUtil::_getHttpPath() . '/webservice/soap/server.php?wsdl';
            }
        }
        try {
            $this->log->debug('Using wsdl: ' . $this->getServer());
            $this->log->debug('Using connection timeout: ' . $this->getTimeout());
            $this->log->debug('Using response timeout: ' . $this->getResponseTimeout());
            
            $this->setSocketTimeout(true);
            $this->client = new SoapClient(
                $this->uri,
                array(
                    'exceptions' => true,
                    'trace' => 1,
                    'connection_timeout' => (int) $this->getTimeout()
                )
            );
            return true;
        } catch (SoapFault $ex) {
            $this->log->warning('Soap init failed with message: ' . $ex->getMessage());
            $this->resetSocketTimeout();
            return false;
        } finally {
            $this->resetSocketTimeout();
        }
    }

Here is the call graph for this function:

resetSocketTimeout()

ilSoapClient::resetSocketTimeout ( )

protected

Reset socket default timeout to defaults.

Returns

boolean

Definition at line 181 of file class.ilSoapClient.php.

Referenced by call(), and init().

    {
        ini_set('default_socket_timeout', $this->stored_socket_timeout);
        $this->log->debug('Restoring default socket timeout to: ' . $this->stored_socket_timeout);
        return true;
    }

Here is the caller graph for this function:

setResponseTimeout()

ilSoapClient::setResponseTimeout

(

$a_timeout

)

Parameters

int

$a_timeout

Response Timeout

Definition at line 88 of file class.ilSoapClient.php.

    {
        $this->response_timeout = (int) $a_timeout;
    }

setSocketTimeout()

ilSoapClient::setSocketTimeout (   $a_wsdl_mode )

protected

Set socket timeout.

Returns

boolean

Definition at line 162 of file class.ilSoapClient.php.

References getResponseTimeout(), and getTimeout().

Referenced by call(), and init().

    {
        $this->stored_socket_timeout = ini_get('default_socket_timeout');
        $this->log->debug('Default socket timeout is: ' . $this->stored_socket_timeout);
        
        if ($a_wsdl_mode) {
            $this->log->debug('WSDL mode, using socket timeout: ' . $this->getTimeout());
            ini_set('default_socket_timeout', $this->getTimeout());
        } else {
            $this->log->debug('Non WSDL mode, using socket timeout: ' . $this->getResponseTimeout());
            ini_set('default_socket_timeout', $this->getResponseTimeout());
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTimeout()

ilSoapClient::setTimeout

(

$a_timeout

)

Set connect timeout.

Parameters

int

$a_timeout

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

    {
        $this->connect_timeout = $a_timeout;
    }

Field Documentation

$client

ilSoapClient::$client = null

private

Definition at line 27 of file class.ilSoapClient.php.

$connect_timeout

ilSoapClient::$connect_timeout = 10

private

Definition at line 31 of file class.ilSoapClient.php.

Referenced by getTimeout().

$log

ilSoapClient::$log = null

private

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

$response_timeout

ilSoapClient::$response_timeout = 10

private

Definition at line 32 of file class.ilSoapClient.php.

Referenced by getResponseTimeout().

$stored_socket_timeout

ilSoapClient::$stored_socket_timeout = null

private

Definition at line 34 of file class.ilSoapClient.php.

$uri

ilSoapClient::$uri

private

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

Referenced by getServer().

DEFAULT_CONNECT_TIMEOUT

const ilSoapClient::DEFAULT_CONNECT_TIMEOUT = 10

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

Referenced by ilObjSystemFolderGUI\initWebServicesForm().

DEFAULT_RESPONSE_TIMEOUT

const ilSoapClient::DEFAULT_RESPONSE_TIMEOUT = 5

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

---

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

• Services/WebServices/SOAP/classes/class.ilSoapClient.php