LTI Integration Library 5.0.0-rc2
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
HTTPMessage Class Reference

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

Inheritance diagram for HTTPMessage:
HttpMessage

Public Member Functions

 __construct ($url, $method='GET', $params=null, $header=null)
 Class constructor.
 
- Public Member Functions inherited from HttpMessage
 __construct ($url, $method='GET', $params=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 ($rel)
 Check whether a relative link of the specified type exists.
 
string null getRelativeLink ($rel)
 Get the URL from the relative link with the specified type.
 
array getRelativeLinks ()
 Get the relative links.
 

Additional Inherited Members

- Static Public Member Functions inherited from HttpMessage
static void setHttpClient ($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 inherited from HttpMessage
bool $ok = false
 True if message was processed successfully.
 
string null $request = null
 Request body.
 
string array $requestHeaders = ''
 Request headers.
 
string null $response = null
 Response body.
 
string array $responseHeaders = ''
 Response headers.
 
array $relativeLinks = array()
 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.

Deprecated:
Use Http::HttpMessage instead
See also
Http::HttpMessage
Author
Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com
Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Constructor & Destructor Documentation

◆ __construct()

__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)

Reimplemented from HttpMessage.

References Util\logDebug().


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