Class to represent an HTTP message. More...

Collaboration diagram for IMSGlobal\LTI\HTTPMessage:

Public Member Functions
	__construct ($url, $method='GET', $params=null, $header=null)
	Class constructor. More...

	send ()
	Send the request to the target URL. More...

Data Fields
	$ok = false
	True if message was sent successfully. More...

	$request = null
	Request body. More...

	$requestHeaders = ''
	Request headers. More...

	$response = null
	Response body. More...

	$responseHeaders = ''
	Response headers. More...

	$status = 0
	Status of response (0 if undetermined). More...

	$error = ''
	Error message. More...

Private Attributes
	$url = null
	Request URL. More...

	$method = null
	Request method. More...

Detailed Description

Class to represent an HTTP message.

Author: Stephen P Vickers svick.nosp@m.ers@.nosp@m.imsgl.nosp@m.obal.nosp@m..org

Copyright: IMS Global Learning Consortium Inc

Date: 2016

Version: 3.0.0 http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0

Definition at line 14 of file HTTPMessage.php.

Constructor & Destructor Documentation

◆ __construct()

IMSGlobal\LTI\HTTPMessage::__construct	(	$url,
		$method = `'GET'`,
		$params = `null`,
		$header = `null`
	)

Class constructor.

Parameters

string	$url	URL to send request to
string	$method	Request method to use (optional, default is GET)
mixed	$params	Associative array of parameter values to be passed or message body (optional, default is none)
string	$header	Values to include in the request header (optional, default is none)

Definition at line 88 of file HTTPMessage.php.

References $header, IMSGlobal\LTI\HTTPMessage\$method, $params, and IMSGlobal\LTI\HTTPMessage\$url.

     {
 
         $this->url = $url;
         $this->method = strtoupper($method);
         if (is_array($params)) {
             $this->request = http_build_query($params);
         } else {
             $this->request = $params;
         }
         if (!empty($header)) {
             $this->requestHeaders = explode("\n", $header);
         }
 
     }

Member Function Documentation

◆ send()

IMSGlobal\LTI\HTTPMessage::send ( )

Send the request to the target URL.

Returns: boolean True if the request was successful

Definition at line 109 of file HTTPMessage.php.

References IMSGlobal\LTI\HTTPMessage\$ok, IMSGlobal\LTI\HTTPMessage\$requestHeaders, array, ilLogLevel\DEBUG, and ilLoggerFactory\getLogger().

     {
 
         $this->ok = false;
 // Try using curl if available
         if (function_exists('curl_init')) {
             $resp = '';
             $ch = curl_init();
             curl_setopt($ch, CURLOPT_URL, $this->url);
             if (!empty($this->requestHeaders)) {
                 curl_setopt($ch, CURLOPT_HTTPHEADER, $this->requestHeaders);
             } else {
                 curl_setopt($ch, CURLOPT_HEADER, 0);
             }
             if ($this->method === 'POST') {
                 curl_setopt($ch, CURLOPT_POST, true);
                 curl_setopt($ch, CURLOPT_POSTFIELDS, $this->request);
             } else if ($this->method !== 'GET') {
                 curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $this->method);
                 if (!is_null($this->request)) {
                     curl_setopt($ch, CURLOPT_POSTFIELDS, $this->request);
                 }
             }
             curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
             curl_setopt($ch, CURLINFO_HEADER_OUT, true);
             curl_setopt($ch, CURLOPT_HEADER, true);
             // begin-patch ilias
             #curl_setopt($ch, CURLOPT_SSLVERSION,3);
             $chResp = curl_exec($ch);
             \ilLoggerFactory::getLogger('lti')->dump(curl_getinfo($ch), \ilLogLevel::DEBUG);
             \ilLoggerFactory::getLogger('lti')->dump(curl_error($ch), \ilLogLevel::DEBUG);
 
             $this->ok = $chResp !== false;
             if ($this->ok) {
                 $chResp = str_replace("\r\n", "\n", $chResp);
                 $chRespSplit = explode("\n\n", $chResp, 2);
                 if ((count($chRespSplit) > 1) && (substr($chRespSplit[1], 0, 5) === 'HTTP/')) {
                     $chRespSplit = explode("\n\n", $chRespSplit[1], 2);
                 }
                 $this->responseHeaders = $chRespSplit[0];
                 $resp = $chRespSplit[1];
                 $this->status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
                 $this->ok = $this->status < 400;
                 if (!$this->ok) {
                     $this->error = curl_error($ch);
                 }
             }
             $this->requestHeaders = str_replace("\r\n", "\n", curl_getinfo($ch, CURLINFO_HEADER_OUT));
             curl_close($ch);
             $this->response = $resp;
         } else {
 // Try using fopen if curl was not available
             $opts = array('method' => $this->method,
                           'content' => $this->request
                          );
             if (!empty($this->requestHeaders)) {
                 $opts['header'] = $this->requestHeaders;
             }
             try {
                 $ctx = stream_context_create(array('http' => $opts));
                 $fp = @fopen($this->url, 'rb', false, $ctx);
                 if ($fp) {
                     $resp = @stream_get_contents($fp);
                     $this->ok = $resp !== false;
                 }
             } catch (\Exception $e) {
                 $this->ok = false;
             }
         }
 
         return $this->ok;
 
     }

Here is the call graph for this function:

Field Documentation

◆ $error

error IMSGlobal\LTI\HTTPMessage::$error = ''

Error message.

Definition at line 64 of file HTTPMessage.php.

◆ $method

method IMSGlobal\LTI\HTTPMessage::$method = null

private

Request method.

Definition at line 78 of file HTTPMessage.php.

Referenced by IMSGlobal\LTI\HTTPMessage\__construct().

◆ $ok

boolean IMSGlobal\LTI\HTTPMessage::$ok = false

True if message was sent successfully.

Definition at line 22 of file HTTPMessage.php.

Referenced by IMSGlobal\LTI\HTTPMessage\send().

◆ $request

request IMSGlobal\LTI\HTTPMessage::$request = null

Request body.

Definition at line 29 of file HTTPMessage.php.

◆ $requestHeaders

request_headers IMSGlobal\LTI\HTTPMessage::$requestHeaders = ''

Request headers.

Definition at line 36 of file HTTPMessage.php.

Referenced by IMSGlobal\LTI\HTTPMessage\send().

◆ $response

response IMSGlobal\LTI\HTTPMessage::$response = null

Response body.

Definition at line 43 of file HTTPMessage.php.

◆ $responseHeaders

response_headers IMSGlobal\LTI\HTTPMessage::$responseHeaders = ''

Response headers.

Definition at line 50 of file HTTPMessage.php.

◆ $status

status IMSGlobal\LTI\HTTPMessage::$status = 0

Status of response (0 if undetermined).

Definition at line 57 of file HTTPMessage.php.

◆ $url

url IMSGlobal\LTI\HTTPMessage::$url = null