ilCurlConnection Class Reference

Collaboration diagram for ilCurlConnection:

Public Member Functions
	__construct ($a_url='')
	Constructor. More...
	getResponseHeader ()
	Get response header as string. More...
	getResponseHeaderArray ()
	Get response header as array. More...
	init (bool $set_proxy=true)
	Init curl connection. More...
	setOpt ($a_option, $a_value)
	Wrapper for curl_setopt. More...
	exec ()
	Wrapper for curl_exec. More...
	parseResponse ($a_response)
	parse response body More...
	getResponseBody ()
	Get responce body. More...
	getInfo ($opt=0)
	Get informations about a specific transfer. More...
	close ()
	Close connection. More...
	__destruct ()
	Destructor public. More...

Static Public Member Functions
static	_isCurlExtensionLoaded ()
	Check if curl extension is loaded. More...

Protected Attributes
	$url = ''
	$ch = null

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

Private Attributes
	$header_plain = ''
	$header_arr = array()
	$response_body = ''

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCurlConnection::__construct

(

$a_url = ''

)

Constructor.

public

Parameters

string

url for connection

Exceptions

ilCurlConnectionException

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

    {
        $this->url = $a_url;

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

__destruct()

ilCurlConnection::__destruct

(

)

Destructor public.

Parameters

Definition at line 259 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

Check if curl extension is loaded.

public

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

Referenced by ilLinkChecker\__validateLinks(), ilNICKeyRegisteredObjective\achieve(), and ilMediaImageUtil\getImageSize().

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

Here is the caller graph for this function:

close()

ilCurlConnection::close ( )

final

Close connection.

public

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

Referenced by __destruct(), and init().

    {
        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.

public

Parameters

Definition at line 169 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 (strlen($err = curl_error($this->ch))) {
                throw new ilCurlConnectionException($err, curl_errno($this->ch));
            } else {
                throw new ilCurlConnectionException('Error calling curl_exec().');
            }
        }
        return $res;
    }

getInfo()

ilCurlConnection::getInfo

(

$opt = 0

)

Get informations about a specific transfer.

public

Parameters

int	option e.g CURLINFO_EFFECTIVE_URL

Returns

mixed

Definition at line 212 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

(

)

Get responce body.

Returns

type

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

References $response_body.

    {
        return $this->response_body;
    }

getResponseHeader()

ilCurlConnection::getResponseHeader

(

)

Get response header as string.

Returns

string

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

References $header_plain.

Referenced by parseHeader().

    {
        return $this->header_plain;
    }

Here is the caller graph for this function:

getResponseHeaderArray()

ilCurlConnection::getResponseHeaderArray

(

)

Get response header as array.

Returns

array

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

References $header_arr.

    {
        return (array) $this->header_arr;
    }

init()

ilCurlConnection::init ( bool  $set_proxy = true )

final

Init curl connection.

Parameters

bool

$set_proxy

public

Exceptions

ilCurlConnectionException

on error

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

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

Referenced by ilECSConnector\prepareConnection().

    {
        // teminate existing handles
        $this->close();
        if (strlen($this->url)) {
            $this->ch = curl_init($this->url);
        #$GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': ' . $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 = 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,   $header  )

private

Parse respone header.

Parameters

mixed	$handle
string	$header

Returns

int strlen of header

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

References $name, and getResponseHeader().

    {
        $this->header_plain = $header;

        $lines = explode('\r\n', $this->getResponseHeader());
        foreach ($lines as $line) {
            list($name, $value) = explode(':', $line, 2);
            $this->header_arr[$name] = $value;
        }
        return strlen($this->getResponseHeader());
    }

Here is the call graph for this function:

parseResponse()

ilCurlConnection::parseResponse

(

$a_response

)

parse response body

Parameters

type

$a_response

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

References getInfo().

    {
        $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 (   $a_option,   $a_value  )

final

Wrapper for curl_setopt.

public

Parameters

int	CURL_OPTION
mixed	bool string or resource

Exceptions

ilCurlConnectionException

on error

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

Referenced by init().

    {
        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 41 of file class.ilCurlConnection.php.

$header_arr

ilCurlConnection::$header_arr = array()

private

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

Referenced by getResponseHeaderArray().

$header_plain

ilCurlConnection::$header_plain = ''

private

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

Referenced by getResponseHeader().

$response_body

ilCurlConnection::$response_body = ''

private

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

Referenced by getResponseBody().

$url

ilCurlConnection::$url = ''

protected

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

---

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

• Services/WebServices/Curl/classes/class.ilCurlConnection.php