Collaboration diagram for ilCurlConnection:

Public Member Functions
	__construct (protected string $url='', protected ?ilProxySettings $proxySettings=null,)

	getResponseHeader ()

	getResponseHeaderArray ()

	init (bool $set_proxy=true)

	setOpt (int $a_option, $a_value)
	Wrapper for curl_setopt. More...

	exec ()
	Wrapper for curl_exec. More...

	parseResponse (string $a_response)

	getResponseBody ()

	getInfo ($opt=0)
	Get information about a specific transfer. More...

	close ()

	__destruct ()

Static Public Member Functions
static	_isCurlExtensionLoaded ()

Protected Attributes
	$ch = null

Private Member Functions
	parseHeader ($handle, string $header)
	Parse respone header. More...

Private Attributes
string	$header_plain = ''

array	$header_arr = array()

string	$response_body = ''

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilCurlConnection::__construct	(	protected string	$url = `''`,
		protected ?ilProxySettings	$proxySettings = `null`
	)

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

       {
         if (!self::_isCurlExtensionLoaded()) {
             throw new ilCurlConnectionException('Curl extension not enabled.');
         }
     }

◆ __destruct()

ilCurlConnection::__destruct ( )

Definition at line 185 of file class.ilCurlConnection.php.

References close().

     {
         $this->close();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _isCurlExtensionLoaded()

static ilCurlConnection::_isCurlExtensionLoaded ( )

staticfinal

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

Referenced by ilNICKeyRegisteredObjective\achieve(), and ilSessionMaxIdleIsSetObjective\getPreconditions().

                                                          : bool
     {
         if (!function_exists('curl_init')) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ close()

ilCurlConnection::close ( )

final

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

Referenced by __destruct(), and init().

                                  : void
     {
         if ($this->ch !== null) {
             curl_close($this->ch);
             $this->ch = null;
         }
     }

Here is the caller graph for this function:

◆ exec()

ilCurlConnection::exec ( )

final

Wrapper for curl_exec.

Returns: bool|string

Definition at line 117 of file class.ilCurlConnection.php.

References $res.

     {
         // Add header function
         curl_setopt($this->ch, CURLOPT_HEADERFUNCTION, array($this, 'parseHeader'));
         if (($res = curl_exec($this->ch)) === false) {
             if (($err = curl_error($this->ch)) !== '') {
                 throw new ilCurlConnectionException($err, curl_errno($this->ch));
             }
 
             throw new ilCurlConnectionException('Error calling curl_exec().');
         }
         return $res;
     }

◆ getInfo()

ilCurlConnection::getInfo ( $opt = 0 )

Get information about a specific transfer.

Parameters

int	option e.g CURLINFO_EFFECTIVE_URL

Returns: mixed

Definition at line 151 of file class.ilCurlConnection.php.

References $res.

Referenced by parseResponse().

     {
         if ($opt) {
             $res = curl_getinfo($this->ch, $opt);
         } else {
             $res = curl_getinfo($this->ch);
         }
         return $res;
     }

Here is the caller graph for this function:

◆ getResponseBody()

ilCurlConnection::getResponseBody ( )

Definition at line 139 of file class.ilCurlConnection.php.

References $response_body.

                                      : string
     {
         return $this->response_body;
     }

◆ getResponseHeader()

ilCurlConnection::getResponseHeader ( )

Definition at line 54 of file class.ilCurlConnection.php.

References $header_plain.

                                        : string
     {
         return $this->header_plain;
     }

◆ getResponseHeaderArray()

ilCurlConnection::getResponseHeaderArray ( )

Definition at line 59 of file class.ilCurlConnection.php.

References $header_arr.

                                             : array
     {
         return $this->header_arr;
     }

◆ init()

ilCurlConnection::init ( bool $set_proxy = true )

final

Definition at line 64 of file class.ilCurlConnection.php.

References ilProxySettings\_getInstance(), close(), and setOpt().

Referenced by ilECSConnector\prepareConnection().

                                                       : bool
     {
         // teminate existing handles
         $this->close();
         if ($this->url !== '') {
             $this->ch = curl_init($this->url);
         } else {
             $this->ch = curl_init();
         }
         if (!$this->ch) {
             throw new ilCurlConnectionException('Cannot init curl connection.');
         }
         if (curl_errno($this->ch)) {
             throw new ilCurlConnectionException(curl_error($this->ch), curl_errno($this->ch));
         }
 
         if ($set_proxy) {
             // use a proxy, if configured by ILIAS
             $proxy = $this->proxySettings ?? ilProxySettings::_getInstance();
             if ($proxy->isActive()) {
                 $this->setOpt(CURLOPT_HTTPPROXYTUNNEL, true);
 
                 if (!empty($proxy->getHost())) {
                     $this->setOpt(CURLOPT_PROXY, $proxy->getHost());
                 } else {
                     throw new ilCurlConnectionException("Proxy host is not set on activated proxy");
                 }
                 if (!empty($proxy->getPort())) {
                     $this->setOpt(CURLOPT_PROXYPORT, $proxy->getPort());
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseHeader()

ilCurlConnection::parseHeader	(		$handle,
		string	$header
	)

private

Parse respone header.

Parameters

mixed	$handle
string	$header

Returns: int strlen of header

Definition at line 167 of file class.ilCurlConnection.php.

                                                          : int
     {
         $len = strlen($header);
         $header = explode(':', $header, 2);
         if (count($header) === 2) { // ignore invalid headers
             $this->header_arr[strtolower(trim($header[0]))] = trim($header[1]);
         }
         return $len;
     }

◆ parseResponse()

ilCurlConnection::parseResponse ( string $a_response )

Definition at line 131 of file class.ilCurlConnection.php.

References getInfo().

                                                      : void
     {
         $header_size = $this->getInfo(CURLINFO_HEADER_SIZE);
 
         $this->header_plain = substr($a_response, 0, $header_size);
         $this->response_body = substr($a_response, $header_size);
     }

Here is the call graph for this function:

◆ setOpt()

ilCurlConnection::setOpt	(	int	$a_option,
			$a_value
	)

final

Wrapper for curl_setopt.

Parameters

int	$a_option
mixed	$a_value

Returns: bool

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

Referenced by init().

                                                          : bool
     {
         if (!curl_setopt($this->ch, $a_option, $a_value)) {
             throw new ilCurlConnectionException('Invalid option given for: ' . $a_option, curl_errno($this->ch));
         }
         return true;
     }

Here is the caller graph for this function:

Field Documentation

◆ $ch

ilCurlConnection::$ch = null

protected

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

◆ $header_arr

array ilCurlConnection::$header_arr = array()

private

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

Referenced by getResponseHeaderArray().

◆ $header_plain

string ilCurlConnection::$header_plain = ''

private

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

Referenced by getResponseHeader().

◆ $response_body

string ilCurlConnection::$response_body = ''

private

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

Referenced by getResponseBody().

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

components/ILIAS/WebServices/Curl/classes/class.ilCurlConnection.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ _isCurlExtensionLoaded()

◆ close()

◆ exec()

◆ getInfo()

◆ getResponseBody()

◆ getResponseHeader()

◆ getResponseHeaderArray()

◆ init()

◆ parseHeader()

◆ parseResponse()

◆ setOpt()

Field Documentation

◆ $ch

◆ $header_arr

◆ $header_plain

◆ $response_body