ilRpcClient Class Reference

Class ilRpcClient. More...

Collaboration diagram for ilRpcClient:

Public Member Functions
	__construct (string $a_url, string $a_prefix='', int $a_timeout=0, string $a_encoding='utf-8')
	ilRpcClient constructor. More...
	__call (string $a_method, array $a_params)
	Magic caller to all RPC functions. More...

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

Detailed Description

Class ilRpcClient.

Author

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

List of all known RPC methods...

RPCIndexHandler: @method void 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 46 of file class.ilRpcClient.php.

Constructor & Destructor Documentation

__construct()

ilRpcClient::__construct	(	string	$a_url,
		string	$a_prefix = '',
		int	$a_timeout = 0,
		string	$a_encoding = 'utf-8'
	)

ilRpcClient constructor.

Parameters

string	$a_url	URL to connect to
string	$a_prefix	Optional prefix for method names
int	$a_timeout	The maximum number of seconds to allow ilRpcClient to connect.
string	$a_encoding	Character encoding

Exceptions

ilRpcClientException

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->wsrv();
 
        if (!extension_loaded('xmlrpc')) {
            ilLoggerFactory::getLogger('wsrv')->error('RpcClient Xmlrpc extension not enabled');
            throw new ilRpcClientException('Xmlrpc extension not enabled.', 50);
        }
 
        $this->url = $a_url;
        $this->prefix = $a_prefix;
        $this->timeout = $a_timeout;
        $this->encoding = $a_encoding;
    }

References $DIC, ilLoggerFactory\getLogger(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

__call()

ilRpcClient::__call	(	string	$a_method,
		array	$a_params
	)

Magic caller to all RPC functions.

Parameters

string	$a_method	Method name
array	$a_params	Argument array

Returns

mixed Returns either an array, or an integer, or a string, or a boolean according to the response returned by the XMLRPC method.

Exceptions

ilRpcClientException

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

    {
        //prepare xml post data
        $method_name = str_replace('_', '.', $this->prefix . $a_method);
        $rpc_options = array(
            'verbosity' => 'newlines_only',
            'escaping' => 'markup'
        );
 
        if ($this->encoding) {
            $rpc_options['encoding'] = $this->encoding;
        }
        $post_data = xmlrpc_encode_request($method_name, $a_params, $rpc_options);
        //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_resp = $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());
        }
 
        //prepare output, throw exception if rpc fault is detected
        $resp = xmlrpc_decode($xml_resp, $this->encoding);
 
        //xmlrpc_is_fault can just handle arrays as response
        if (is_array($resp) && xmlrpc_is_fault($resp)) {
            $this->logger->error('RpcClient recieved error ' . $resp['faultCode'] . ': ' . $resp['faultString']);
            throw new ilRpcClientException(
                'RPC-Server returned fault message: ' .
                $resp['faultString'],
                $resp['faultCode']
            );
        }
        return $resp;
    }

References Vendor\Package\$e, $encoding, XapiProxy\$resp, and ILIAS\Repository\logger().

Here is the call graph for this function:

Field Documentation

$encoding

string ilRpcClient::$encoding = ''

protected

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

Referenced by __call().

$logger

ilLogger ilRpcClient::$logger

protected

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

$prefix

string ilRpcClient::$prefix = ''

protected

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

$timeout

int ilRpcClient::$timeout = 0

protected

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

$url

string ilRpcClient::$url

protected

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

---

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

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