ceLTIc\LTI\Http\HttpMessage Class Reference

Class to represent an HTTP message request. More...

Public Member Functions
	__construct (string $url, string $method='GET', array|string|null $params=null, array|string|null $header=null)
	Class constructor.
string	getUrl ()
	Get the target URL for the request.
string	getMethod ()
	Get the HTTP method for the request.
bool	send ()
	Send the request to the target URL.
bool	hasRelativeLink (string $rel)
	Check whether a relative link of the specified type exists.
string null	getRelativeLink (string $rel)
	Get the URL from the relative link with the specified type.
array	getRelativeLinks ()
	Get the relative links.

Static Public Member Functions
static void	setHttpClient (?ClientInterface $httpClient=null)
	Set the HTTP client to use for sending the message.
static ClientInterface null	getHttpClient ()
	Get the HTTP client to use for sending the message.

Public Attributes
bool	$ok = false
	True if message was processed successfully.
string	$request = null
	Request body.
array	$requestHeaders = []
	Request headers.
string	$response = null
	Response body.
array	$responseHeaders = []
	Response headers.
object array null	$responseJson = null
	JSON response body.
array	$relativeLinks = []
	Relative links in response headers.
int	$status = 0
	Status of response (0 if undetermined).
string	$error = ''
	Error message.

Detailed Description

Class to represent an HTTP message request.

Author

Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com

Copyright

SPV Software Products

Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Constructor & Destructor Documentation

__construct()

ceLTIc\LTI\Http\HttpMessage::__construct	(	string	$url,
		string	$method = 'GET',
		array|string|null	$params = null,
		array|string|null	$header = null )

Class constructor.

Parameters

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

References ceLTIc\LTI\Util\logDebug().

Member Function Documentation

getHttpClient()

static ClientInterface null ceLTIc\LTI\Http\HttpMessage::getHttpClient ( )

static

Get the HTTP client to use for sending the message.

If one is not set, a default client is created.

Returns

ClientInterface|null The HTTP client

Referenced by getMethod().

getMethod()

string ceLTIc\LTI\Http\HttpMessage::getMethod

(

)

Get the HTTP method for the request.

Returns

string Message method

References getHttpClient().

getRelativeLink()

string null ceLTIc\LTI\Http\HttpMessage::getRelativeLink

(

string

$rel

)

Get the URL from the relative link with the specified type.

Parameters

string

$rel

Returns

string|null The URL associated with the relative link, null if it is not defined

getRelativeLinks()

array ceLTIc\LTI\Http\HttpMessage::getRelativeLinks

(

)

Get the relative links.

Returns

array Associative array of relative links

getUrl()

string ceLTIc\LTI\Http\HttpMessage::getUrl

(

)

Get the target URL for the request.

Returns

string Request URL

hasRelativeLink()

bool ceLTIc\LTI\Http\HttpMessage::hasRelativeLink

(

string

$rel

)

Check whether a relative link of the specified type exists.

Parameters

string

$rel

Returns

bool True if it exists

send()

bool ceLTIc\LTI\Http\HttpMessage::send

(

)

Send the request to the target URL.

Returns

bool True if the request was successful

setHttpClient()

static void ceLTIc\LTI\Http\HttpMessage::setHttpClient ( ?ClientInterface $httpClient = null )

static

Set the HTTP client to use for sending the message.

Parameters

ClientInterface | null

$httpClient

Member Data Documentation

$error

string ceLTIc\LTI\Http\HttpMessage::$error = ''

Error message.

$ok

bool ceLTIc\LTI\Http\HttpMessage::$ok = false

True if message was processed successfully.

$relativeLinks

array ceLTIc\LTI\Http\HttpMessage::$relativeLinks = []

Relative links in response headers.

$request

string ceLTIc\LTI\Http\HttpMessage::$request = null

Request body.

$requestHeaders

array ceLTIc\LTI\Http\HttpMessage::$requestHeaders = []

Request headers.

$response

string ceLTIc\LTI\Http\HttpMessage::$response = null

Response body.

$responseHeaders

array ceLTIc\LTI\Http\HttpMessage::$responseHeaders = []

Response headers.

$responseJson

object array null ceLTIc\LTI\Http\HttpMessage::$responseJson = null

JSON response body.

$status

int ceLTIc\LTI\Http\HttpMessage::$status = 0

Status of response (0 if undetermined).