Collaboration diagram for ilSoapClient:

Public Member Functions
	__construct (string $a_uri='')

	getServer ()

	setTimeout (int $a_timeout)

	getTimeout ()

	setResponseTimeout (int $a_timeout)

	getResponseTimeout ()

	enableWSDL (bool $a_stat)

	enabledWSDL ()

	init ()

	call (string $a_operation, array $a_params)

Data Fields
const	DEFAULT_CONNECT_TIMEOUT = 10

const	DEFAULT_RESPONSE_TIMEOUT = 5

Protected Member Functions
	setSocketTimeout (bool $a_wsdl_mode)

	resetSocketTimeout ()
	Reset socket default timeout to defaults. More...

Private Attributes
ilLogger	$log

ilSetting	$settings

SoapClient	$client = null

string	$uri

bool	$use_wsdl = true

int	$connect_timeout = self::DEFAULT_CONNECT_TIMEOUT

int	$response_timeout = self::DEFAULT_RESPONSE_TIMEOUT

int	$stored_socket_timeout = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSoapClient::__construct ( string $a_uri = '' )

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

    {
        global $DIC;
 
        $this->settings = $DIC->settings();
        $this->log = $DIC->logger()->wsrv();
        $this->uri = $a_uri;
        $this->use_wsdl = true;
        $timeout = (int) $this->settings->get('soap_connect_timeout', (string) self::DEFAULT_CONNECT_TIMEOUT);
        if ($timeout) {
            $this->connect_timeout = $timeout;
        }
        $this->connect_timeout = $timeout;
 
        $this->response_timeout = (int) $this->settings->get('soap_response_timeout', (string) self::DEFAULT_RESPONSE_TIMEOUT);
    }

References $DIC, DEFAULT_CONNECT_TIMEOUT, DEFAULT_RESPONSE_TIMEOUT, ILIAS\Repository\int(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ call()

ilSoapClient::call	(	string	$a_operation,
		array	$a_params
	)

Parameters

string	$a_operation
array	$a_params

Returns: false|mixed

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

    {
        $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((string) $this->client->__getLastResponseHeaders());
            $this->log->debug((string) $this->client->__getLastResponse());
            return false;
        } catch (Exception $exception) {
            $this->log->error('Caught unknown exception with message: ' . $exception->getMessage());
            $this->log->debug((string) $this->client->__getLastResponseHeaders());
            $this->log->debug((string) $this->client->__getLastResponse());
        } finally {
            $this->resetSocketTimeout();
        }
 
        return false;
    }

References ILIAS\UI\examples\Progress\Bar\client(), resetSocketTimeout(), and setSocketTimeout().

Here is the call graph for this function:

◆ enabledWSDL()

ilSoapClient::enabledWSDL ( )

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

                                 : bool
    {
        return $this->use_wsdl;
    }

References $use_wsdl.

◆ enableWSDL()

ilSoapClient::enableWSDL ( bool $a_stat )

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

                                            : void
    {
        $this->use_wsdl = $a_stat;
    }

◆ getResponseTimeout()

ilSoapClient::getResponseTimeout ( )

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

                                        : int
    {
        return $this->response_timeout;
    }

References $response_timeout.

Referenced by init(), and setSocketTimeout().

Here is the caller graph for this function:

◆ getServer()

ilSoapClient::getServer ( )

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

                               : string
    {
        return $this->uri;
    }

References $uri.

Referenced by init().

Here is the caller graph for this function:

◆ getTimeout()

ilSoapClient::getTimeout ( )

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

                                : int
    {
        return $this->connect_timeout;
    }

References $connect_timeout.

Referenced by init(), and setSocketTimeout().

Here is the caller graph for this function:

◆ init()

ilSoapClient::init ( )

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

                          : bool
    {
        $internal_path = $this->settings->get('soap_internal_wsdl_path');
        if (trim($this->getServer()) === '') {
            if ($internal_path) {
                $uri = (new \ILIAS\Data\URI($internal_path));
                parse_str($uri->getQuery() ?? '', $query);
                $this->uri = (string) (isset($query['wsdl']) ?
                                       $uri :
                                       $uri->withQuery(http_build_query(array_merge($query, ['wsdl' => '']))));
            } elseif (trim($this->settings->get('soap_wsdl_path', '')) !== '') {
                $this->uri = $this->settings->get('soap_wsdl_path', '');
            } else {
                $this->uri = ilUtil::_getHttpPath() . '/public/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' => $this->getTimeout(),
                    'stream_context' => $this->uri === $internal_path ? stream_context_create([
                        'ssl' => [
                            'verify_peer' => (bool) $this->settings->get('soap_internal_wsdl_verify_peer', '1'),
                            'verify_peer_name' => (bool) $this->settings->get('soap_internal_wsdl_verify_peer_name', '1'),
                            'allow_self_signed' => (bool) $this->settings->get('soap_internal_wsdl_allow_self_signed', ''),
                        ]
                    ]) : null
                )
            );
            return true;
        } catch (SoapFault $ex) {
            $this->log->warning('Soap init failed with message: ' . $ex->getMessage());
            $this->resetSocketTimeout();
            return false;
        } finally {
            $this->resetSocketTimeout();
        }
    }

References $uri, ilUtil\_getHttpPath(), ILIAS\UI\examples\Progress\Bar\client(), getResponseTimeout(), getServer(), getTimeout(), resetSocketTimeout(), setSocketTimeout(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ resetSocketTimeout()

ilSoapClient::resetSocketTimeout ( )

protected

Reset socket default timeout to defaults.

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

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

Referenced by call(), and init().

Here is the caller graph for this function:

◆ setResponseTimeout()

ilSoapClient::setResponseTimeout ( int $a_timeout )

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

                                                      : void
    {
        $this->response_timeout = $a_timeout;
    }

◆ setSocketTimeout()

ilSoapClient::setSocketTimeout ( bool $a_wsdl_mode )

protected

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

                                                          : bool
    {
        $this->stored_socket_timeout = (int) 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', (string) $this->getTimeout());
        } else {
            $this->log->debug('Non WSDL mode, using socket timeout: ' . $this->getResponseTimeout());
            ini_set('default_socket_timeout', (string) $this->getResponseTimeout());
        }
 
        return true;
    }

References getResponseTimeout(), getTimeout(), and ILIAS\Repository\int().

Referenced by call(), and init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTimeout()

ilSoapClient::setTimeout ( int $a_timeout )

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

                                              : void
    {
        $this->connect_timeout = $a_timeout;
    }

Field Documentation

◆ $client

SoapClient ilSoapClient::$client = null

private

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

◆ $connect_timeout

int ilSoapClient::$connect_timeout = self::DEFAULT_CONNECT_TIMEOUT

private

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

Referenced by getTimeout().

◆ $log

ilLogger ilSoapClient::$log

private

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

◆ $response_timeout

int ilSoapClient::$response_timeout = self::DEFAULT_RESPONSE_TIMEOUT

private

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

Referenced by getResponseTimeout().

◆ $settings

ilSetting ilSoapClient::$settings

private

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

◆ $stored_socket_timeout

int ilSoapClient::$stored_socket_timeout = null

private

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

◆ $uri

string ilSoapClient::$uri

private

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

Referenced by getServer(), and init().

◆ $use_wsdl

bool ilSoapClient::$use_wsdl = true

private

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

Referenced by enabledWSDL().

◆ DEFAULT_CONNECT_TIMEOUT

const ilSoapClient::DEFAULT_CONNECT_TIMEOUT = 10

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

Referenced by __construct(), and ilWebServicesSetupAgent\getArrayToConfigTransformation().

◆ DEFAULT_RESPONSE_TIMEOUT

const ilSoapClient::DEFAULT_RESPONSE_TIMEOUT = 5

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

Referenced by __construct(), and ilWebServicesSetupAgent\getArrayToConfigTransformation().

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

components/ILIAS/WebServices/SOAP/classes/class.ilSoapClient.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ call()

◆ enabledWSDL()

◆ enableWSDL()

◆ getResponseTimeout()

◆ getServer()

◆ getTimeout()

◆ init()

◆ resetSocketTimeout()

◆ setResponseTimeout()

◆ setSocketTimeout()

◆ setTimeout()

Field Documentation

◆ $client

◆ $connect_timeout

◆ $log

◆ $response_timeout

◆ $settings

◆ $stored_socket_timeout

◆ $uri

◆ $use_wsdl

◆ DEFAULT_CONNECT_TIMEOUT

◆ DEFAULT_RESPONSE_TIMEOUT