Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
IMSGlobal\LTI\HTTPMessage Class Reference

Public Member Functions

 __construct ($url, $method='GET', $params=null, $header=null)
 Class constructor.
 
 send ()
 Send the request to the target URL.
 

Public Attributes

error $error = ''
 Error message.
 
boolean $ok = false
 True if message was sent successfully.
 
request $request = null
 Request body.
 
request_headers $requestHeaders = ''
 Request headers.
 
response $response = null
 Response body.
 
response_headers $responseHeaders = ''
 Response headers.
 
status $status = 0
 Status of response (0 if undetermined).
 

Constructor & Destructor Documentation

◆ __construct()

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

Class constructor.

Parameters
string$urlURL to send request to
string$methodRequest method to use (optional, default is GET)
mixed$paramsAssociative array of parameter values to be passed or message body (optional, default is none)
string$headerValues to include in the request header (optional, default is none)

Member Function Documentation

◆ send()

IMSGlobal\LTI\HTTPMessage::send ( )

Send the request to the target URL.

Return values
booleanTrue if the request was successful

Member Data Documentation

◆ $error

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

Error message.

$error

◆ $ok

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

True if message was sent successfully.

$ok

◆ $request

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

Request body.

$request

◆ $requestHeaders

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

Request headers.

$requestHeaders

◆ $response

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

Response body.

$response

◆ $responseHeaders

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

Response headers.

$responseHeaders

◆ $status

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

Status of response (0 if undetermined).

$status


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