ilRpcClient Class Reference

Collaboration diagram for ilRpcClient:

Public Member Functions
	__construct (string $url, string $prefix='', int $timeout=0)
	__call (string $method, array $parameters)
	handleResponse (string $xml)
	Returns decoded response if not faulty, otherwise throws exception. More...

Protected Member Functions
	encodeRequest (string $method, array $parameters)
	isListOfIntegers (mixed $parameter)
	wrapParameter (DOMDocument $encoded_parameter)
	encodeString (string $parameter)
	encodeInteger (int $parameter)
	encodeBoolean (bool $parameter)
	encodeListOfIntegers (int ... $parameters)
	decodeOKResponse (DOMElement $response_body)
	decodeString (DOMNode $string)
	decodeBase64 (DOMNode $base64)
	decodeBoolean (DOMNode $boolean)
	handleFaultResponse (DOMElement $response_body)

Protected Attributes
string	$url
string	$prefix = ''
int	$timeout = 0
ilLogger	$logger

Detailed Description

Author

Fabian Wolf wolf@.nosp@m.leif.nosp@m.os.co.nosp@m.m

List of all known RPC methods...

RPCIndexHandler: @method bool index() index(string $client, bool $bool) Prefix/Package: RPCIndexHandler @method void indexObjects() indexObjects(string $client, array $object_ids) Prefix/Package: RPCIndexHandler

RPCTransformationHandler: @method string ilFO2PDF() ilFO2PDF(string $fo_string) Prefix/Package: RPCTransformationHandler Return: base64

RPCSearchHandler: @method string searchMail() searchMail(string $client, int $user_id, string $query, int $mail_folder_id) Prefix/Package: RPCSearchHandler Return:xml @method string highlight() highlight(string $client, array $object_ids, string $query) Prefix/Package: RPCSearchHandler Return: string @method string searchUsers() searchUser(string $client, string $query) Prefix/Package: RPCSearchHandler Return: xml @method string search() search(string $client, string $query, int $page_nr) Prefix/Package: RPCSearchHandler Return: xml

Other: @method void ping() ping() Prefix/Package: RPCebug @method void refreshSettings() refreshSettings(string $client) Prefix/Package: RPCAdministration

Definition at line 43 of file class.ilRpcClient.php.

Constructor & Destructor Documentation

__construct()

ilRpcClient::__construct	(	string	$url,
		string	$prefix = '',
		int	$timeout = 0
	)

Parameters

string	$url	URL to connect to
string	$prefix	Optional prefix for method names
int	$timeout	The maximum number of seconds to allow ilRpcClient to connect.

Exceptions

ilRpcClientException

Definition at line 57 of file class.ilRpcClient.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->wsrv();
        $this->url = $url;
        $this->prefix = $prefix;
        $this->timeout = $timeout;
    }

References $DIC, $prefix, $timeout, $url, and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

__call()

ilRpcClient::__call	(	string	$method,
		array	$parameters
	)

Parameters

string	$method	Method name
	(string|int|bool|int[])[]	$parameters Argument array

Returns

string|stdClass Depends on the response returned by the XMLRPC method.

Exceptions

ilRpcClientException

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

                                                             : string|bool|stdClass
    {
        //prepare xml post data
        $method_name = str_replace('_', '.', $this->prefix . $method);
 
        $post_data = $this->encodeRequest($method_name, $parameters);
 
        //try to connect to the given url
        try {
            $curl = new ilCurlConnection($this->url);
            $curl->init(false);
            $curl->setOpt(CURLOPT_HTTPHEADER, ['Content-Type: text/xml']);
            $curl->setOpt(CURLOPT_POST, (strlen($post_data) > 0));
            $curl->setOpt(CURLOPT_POSTFIELDS, $post_data);
            $curl->setOpt(CURLOPT_RETURNTRANSFER, 1);
 
            if ($this->timeout > 0) {
                $curl->setOpt(CURLOPT_TIMEOUT, $this->timeout);
            }
            $this->logger->debug('RpcClient request to ' . $this->url . ' / ' . $method_name);
            $xml_response = $curl->exec();
        } catch (ilCurlConnectionException $e) {
            $this->logger->error(
                'RpcClient could not connect to ' . $this->url . ' ' .
                'Reason ' . $e->getCode() . ': ' . $e->getMessage()
            );
            throw new ilRpcClientException($e->getMessage(), $e->getCode());
        }
 
        //return output, throw exception if rpc fault is detected
        return $this->handleResponse($xml_response);
    }

References Vendor\Package\$e, encodeRequest(), handleResponse(), and ILIAS\Repository\logger().

Here is the call graph for this function:

decodeBase64()

ilRpcClient::decodeBase64 ( DOMNode  $base64 )

protected

Definition at line 252 of file class.ilRpcClient.php.

                                                    : stdClass
    {
        return (object) base64_decode((string) $base64->nodeValue);
    }

Referenced by decodeOKResponse().

Here is the caller graph for this function:

decodeBoolean()

ilRpcClient::decodeBoolean ( DOMNode  $boolean )

protected

Definition at line 257 of file class.ilRpcClient.php.

                                                      : bool
    {
        return (bool) $boolean->nodeValue;
    }

Referenced by decodeOKResponse().

Here is the caller graph for this function:

decodeOKResponse()

ilRpcClient::decodeOKResponse ( DOMElement  $response_body )

protected

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

                                                                  : string|bool|stdClass
    {
        $param_child = $response_body->getElementsByTagName('value')->item(0)?->childNodes?->item(0);
 
        if ($param_child === null) {
            throw new ilRpcClientException('No value in response');
        }
 
        return match ($param_child->nodeName) {
            'string' => $this->decodeString($param_child),
            '#text' => $this->decodeString($param_child), // org.apache.xmlrpc returns java strings as unwrapped text node
            'base64' => $this->decodeBase64($param_child),
            'boolean' => $this->decodeBoolean($param_child),
            default => throw new ilRpcClientException('Unexpected element in response value: ' . $param_child->nodeName),
        };
    }

References decodeBase64(), decodeBoolean(), and decodeString().

Referenced by handleResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

decodeString()

ilRpcClient::decodeString ( DOMNode  $string )

protected

Definition at line 247 of file class.ilRpcClient.php.

                                                    : string
    {
        return (string) $string->nodeValue;
    }

Referenced by decodeOKResponse().

Here is the caller graph for this function:

encodeBoolean()

ilRpcClient::encodeBoolean ( bool  $parameter )

protected

Definition at line 177 of file class.ilRpcClient.php.

                                                     : DOMDocument
    {
        $xml = new DOMDocument('1.0', 'UTF-8');
        $xml->appendChild($xml->createElement('boolean', $parameter ? '1' : '0'));
        return $xml;
    }

Referenced by encodeRequest().

Here is the caller graph for this function:

encodeInteger()

ilRpcClient::encodeInteger ( int  $parameter )

protected

Definition at line 170 of file class.ilRpcClient.php.

                                                    : DOMDocument
    {
        $xml = new DOMDocument('1.0', 'UTF-8');
        $xml->appendChild($xml->createElement('int', (string) $parameter));
        return $xml;
    }

Referenced by encodeRequest().

Here is the caller graph for this function:

encodeListOfIntegers()

ilRpcClient::encodeListOfIntegers ( int ...  $parameters )

protected

Definition at line 184 of file class.ilRpcClient.php.

                                                               : DOMDocument
    {
        $xml = new DOMDocument('1.0', 'UTF-8');
        $array = $xml->createElement('array');
        $data = $xml->createElement('data');
 
        foreach ($parameters as $parameter) {
            $value = $xml->createElement('value');
            $value->appendChild($xml->importNode($this->encodeInteger($parameter)->documentElement, true));
            $data->appendChild($value);
        }
        $array->appendChild($data);
 
        $xml->appendChild($array);
        return $xml;
    }

References $data.

Referenced by encodeRequest().

Here is the caller graph for this function:

encodeRequest()

ilRpcClient::encodeRequest ( string  $method, array  $parameters  )

protected

Parameters

(string|int|bool|int[])[]

$parameters

Exceptions

ilRpcClientException

Definition at line 110 of file class.ilRpcClient.php.

                                                                       : string
    {
        $xml = new DOMDocument('1.0', 'UTF-8');
        $method_call = $xml->createElement('methodCall');
        $method_name = $xml->createElement('methodName', $method);
        $params = $xml->createElement('params');
 
        foreach ($parameters as $parameter) {
            match (true) {
                is_string($parameter) => $encoded_parameter = $this->encodeString($parameter),
                is_int($parameter) => $encoded_parameter = $this->encodeInteger($parameter),
                is_bool($parameter) => $encoded_parameter = $this->encodeBoolean($parameter),
                $this->isListOfIntegers($parameter) => $encoded_parameter = $this->encodeListOfIntegers(...$parameter),
                default => throw new ilRpcClientException(
                    'Invalid parameter type, only string, int, bool, and int[] are supported.'
                )
            };
            $params->appendChild($xml->importNode($this->wrapParameter($encoded_parameter)->documentElement, true));
        }
 
        $method_call->appendChild($method_name);
        $method_call->appendChild($params);
 
        $xml->appendChild($method_call);
        return $xml->saveXML();
    }

References $params, encodeBoolean(), encodeInteger(), encodeListOfIntegers(), encodeString(), and isListOfIntegers().

Referenced by __call().

Here is the call graph for this function:

Here is the caller graph for this function:

encodeString()

ilRpcClient::encodeString ( string  $parameter )

protected

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

                                                      : DOMDocument
    {
        $xml = new DOMDocument('1.0', 'UTF-8');
        $xml->appendChild($xml->createElement('string', $parameter));
        return $xml;
    }

Referenced by encodeRequest().

Here is the caller graph for this function:

handleFaultResponse()

ilRpcClient::handleFaultResponse ( DOMElement  $response_body )

protected

Exceptions

ilRpcClientException

Definition at line 265 of file class.ilRpcClient.php.

                                                                     : string
    {
        $fault_code = null;
        $fault_string = null;
 
        $members = $response_body->getElementsByTagName('member');
        foreach ($members as $member) {
            $name = $member->getElementsByTagName('name')->item(0)?->nodeValue;
            if ($name === 'faultCode') {
                if ($fault_code !== null) {
                    throw new ilRpcClientException('Multiple codes in fault response.');
                }
                $fault_code = (int) $member->getElementsByTagName('int')->item(0)?->nodeValue;
            }
            if ($name === 'faultString') {
                if ($fault_string !== null) {
                    throw new ilRpcClientException('Multiple strings in fault response.');
                }
                $fault_string = $member->getElementsByTagName('string')->item(0)?->nodeValue;
            }
        }
 
        if ($fault_code === null || $fault_string === null) {
            throw new ilRpcClientException('No code or no string in fault respsonse');
        }
 
        $this->logger->error('RpcClient recieved error ' . $fault_code . ': ' . $fault_string);
        throw new ilRpcClientException(
            'RPC-Server returned fault message: ' .
            $fault_string,
            $fault_code
        );
    }

References ILIAS\Repository\int(), and ILIAS\Repository\logger().

Referenced by handleResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

handleResponse()

ilRpcClient::handleResponse

(

string

$xml

)

Returns decoded response if not faulty, otherwise throws exception.

Exceptions

ilRpcClientException

Definition at line 205 of file class.ilRpcClient.php.

                                               : string|bool|stdClass
    {
        $response = new DOMDocument('1.0', 'UTF-8');
        $response->preserveWhiteSpace = false;
        $response->loadXML($xml);
 
        if (!$response) {
            throw new ilRpcClientException('Invalid XML response');
        }
 
        $response_body = $response->documentElement->childNodes->item(0);
 
        if ($response_body === null) {
            throw new ilRpcClientException('Empty response');
        }
 
        $this->logger->dump($response_body);
 
        return match ($response_body->nodeName) {
            'params' => $this->decodeOKResponse($response_body),
            'fault' => $this->handleFaultResponse($response_body),
            default => throw new ilRpcClientException('Unexpected element in response: ' . get_class($response_body)),
        };
    }

References $response, decodeOKResponse(), handleFaultResponse(), and ILIAS\Repository\logger().

Referenced by __call().

Here is the call graph for this function:

Here is the caller graph for this function:

isListOfIntegers()

ilRpcClient::isListOfIntegers ( mixed  $parameter )

protected

Definition at line 137 of file class.ilRpcClient.php.

                                                         : bool
    {
        if (!is_array($parameter)) {
            return false;
        }
        foreach ($parameter as $entries) {
            if (!is_int($entries)) {
                return false;
            }
        }
        return true;
    }

Referenced by encodeRequest().

Here is the caller graph for this function:

wrapParameter()

ilRpcClient::wrapParameter ( DOMDocument  $encoded_parameter )

protected

Definition at line 150 of file class.ilRpcClient.php.

                                                                    : DOMDocument
    {
        $xml = new DOMDocument('1.0', 'UTF-8');
        $param = $xml->createElement('param');
        $value = $xml->createElement('value');
 
        $value->appendChild($xml->importNode($encoded_parameter->documentElement, true));
        $param->appendChild($value);
 
        $xml->appendChild($param);
        return $xml;
    }

References $param.

Field Documentation

$logger

ilLogger ilRpcClient::$logger

protected

Definition at line 49 of file class.ilRpcClient.php.

$prefix

string ilRpcClient::$prefix = ''

protected

Definition at line 46 of file class.ilRpcClient.php.

Referenced by __construct().

$timeout

int ilRpcClient::$timeout = 0

protected

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

Referenced by __construct().

$url

string ilRpcClient::$url

protected

Definition at line 45 of file class.ilRpcClient.php.

Referenced by __construct().

---

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

• components/ILIAS/WebServices/RPC/classes/class.ilRpcClient.php