mixed $data = NULL (line 156)

Data to render following the status line in the response.

This value can either be a scalar (single value, e.g. int, string, float), or an array. If it is a single scalar, it is rendered as a single line. If it is an array, then each element becomes one line. If an element is a scalar, then it is directly output onto the line. If an element is an array, then each child element is output as a separate field on the same line. Optional. Ignored if NULL.

• see: SloodleLSLResponse::clear_data()
• see: SloodleLSLResponse::add_data_line()
• see: SloodleLSLResponse::set_data()
• see: SLOODLE_LINE_SEPARATOR
• see: SLOODLE_FIELD_SEPARATOR
• access: private

integer $page_total = NULL (line 129)

Total number of pages.

If a response requires multiple pages, this value indicates how many pages there are. Optional, unless $page_number is specified. Ignored if NULL. Not yet supported.

• access: private

integer $request_timestamp = NULL (line 90)

Timestamp when the request was originally made by the LSL script.

This is not filled-in automatically. You must do it manually if you need it. Optional. Ignored if NULL.

• access: private

mixed $side_effects = NULL (line 71)

Integer side effect(s) codes.

Status code(s) of side effect(s) incurred during the operation. Can be a single integer, or an array of integers. Optional. Ignored if NULL.

• access: private

string $status_descriptor = NULL (line 61)

Status descriptor string.

Should contain a generalised description/category of the status code. Optional but recommended. Ignored if NULL.

• access: private

string $user_key = NULL (line 111)

SL agent key.

Should be a string specifying the UUID key of the agent in-world being handled. (Typically of the user who initiated the request). Optional. Ignored if NULL.

• access: private

add_data_line (line 421)

Adds one line of data to the $data member

• mixed $par: A scalar, or an array of scalars

add_side_effects (line 228)

Adds one or more integer side effect codes to member $status_code.

• mixed $par: An integer side effect code, or an array of them.

quick_output (line 640)

Quick output of data to avoid several accessor calls if the response is very basic.

Can be called statically to allow simple output of basic data. The status code is required, but the other parameters are optional If an error occurs, the LSL-friendly error message is output to the HTTP response, and the script terminated

• access: public

• int $status_code: The status code for the response (required)
• string $status_descriptor: The status descriptor for the response (optional - ignored if NULL)
• mixed $data: The data for the response, which can be a scalar, or a mixed array of scalars/scalar-arrays (see SloodleLSLResponse::$data) (optional - ignored if NULL)
• bool $static: If TRUE (default), then this function will assume it is being call statically, and construct its own response object. Otherwise, it will all the existing member data to render the output.

render_to_string (line 480)

Renders the response to a string.

Prior to rendering, this function will perform final validation on all the data. If anything fails, then the script will terminate with an LSL-friendly error message.

• access: public
• usedby: SloodleLSLResponse::render_to_output() - Outputs the result from this function directly to the HTTP response stream.

• string &$str: Reference to a string object which the response should be rendered to.

set_page_number (line 367)

Accessor function to set member value $page_number

• mixed $par: A positive page number, or NULL to clear it

set_request_descriptor (line 282)

Accessor function to set member value $request_descriptor

• mixed $par: A string request descriptor, or NULL to clear it

set_response_timestamp (line 312)

Accessor function to set member value $response_timestamp

• mixed $par: An integer timestamp, or NULL to clear it

set_status_code (line 168)

Accessor function to set member value $status_code

• integer $par: A non-zero status code

set_tracking_code (line 342)

Accessor function to set member value $tracking_code

• mixed $par: Any scalar value

_internal_validation_error (line 666)

Internal function to report a data validation error.

Outputs an LSL-friendly error message, and terminates the script

• access: private

• string $msg: The error message to output.