Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | List of all members
mod_lti\local\ltiservice\response Class Reference

The mod_lti::local::ltiservice::response class. More...

Public Member Functions

 __construct ()
 Class constructor.
 
 add_additional_header ($header)
 Add an additional header. More...
 
 get_accept ()
 Get the request accept header. More...
 
 get_code ()
 Get the response code. More...
 
 get_content_type ()
 Get the response content type. More...
 
 get_reason ()
 Get the response reason. More...
 
 get_request_data ()
 Get the request body. More...
 
 get_request_method ()
 Get the request method. More...
 
 send ()
 Send the response.
 
 set_accept ($accept)
 Set the request accept header. More...
 
 set_body ($body)
 Set the response body. More...
 
 set_code ($code)
 Set the response code. More...
 
 set_content_type ($contenttype)
 Set the response content type. More...
 
 set_reason ($reason)
 Set the response reason. More...
 
 set_request_data ($data)
 Set the response body. More...
 

Detailed Description

The mod_lti::local::ltiservice::response class.

Since
Moodle 2.8
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_additional_header()

mod_lti\local\ltiservice\response::add_additional_header (   $header)

Add an additional header.

Parameters
string$headerThe new header

◆ get_accept()

mod_lti\local\ltiservice\response::get_accept ( )

Get the request accept header.

Return values
string

◆ get_code()

mod_lti\local\ltiservice\response::get_code ( )

Get the response code.

Return values
int

◆ get_content_type()

mod_lti\local\ltiservice\response::get_content_type ( )

Get the response content type.

Return values
string

◆ get_reason()

mod_lti\local\ltiservice\response::get_reason ( )

Get the response reason.

Return values
string

◆ get_request_data()

mod_lti\local\ltiservice\response::get_request_data ( )

Get the request body.

Return values
string

◆ get_request_method()

mod_lti\local\ltiservice\response::get_request_method ( )

Get the request method.

Return values
string

◆ set_accept()

mod_lti\local\ltiservice\response::set_accept (   $accept)

Set the request accept header.

Parameters
string$acceptAccept header value

◆ set_body()

mod_lti\local\ltiservice\response::set_body (   $body)

Set the response body.

Parameters
string$bodyBody data

◆ set_code()

mod_lti\local\ltiservice\response::set_code (   $code)

Set the response code.

Parameters
int$codeResponse code

◆ set_content_type()

mod_lti\local\ltiservice\response::set_content_type (   $contenttype)

Set the response content type.

Parameters
string$contenttypeContent type

◆ set_reason()

mod_lti\local\ltiservice\response::set_reason (   $reason)

Set the response reason.

Parameters
string$reasonReason

◆ set_request_data()

mod_lti\local\ltiservice\response::set_request_data (   $data)

Set the response body.

Parameters
string$dataBody data

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