_{Official ZPE/YASS documentation}Response

Introduction

The ResponseObject is used in web-enabled ZPE environments to configure HTTP response headers and status codes.

Internally, it stores response metadata in a global map named $_RESPONSE_HEADERS, which is later processed by the runtime to construct the outgoing HTTP response.

This object is primarily intended for server-side scripting scenarios such as APIs, dynamic web pages, or REST-style endpoints.

All functions exposed by this object require a permission level of 0.

Response object functions

The following is a list of internal functions the ResponseObject exposes. All functions are ZPEObjectNativeFunctions therefore run in native code.

set_header(string header, string value) ⇒ boolean

Sets an HTTP response header. The header name and value are stored in the global $_RESPONSE_HEADERS map. Returns true.

set_http_response(string status) ⇒ boolean

Sets the HTTP status code for the response. The status is stored internally under the key http_status within the $_RESPONSE_HEADERS map. Returns true.

Examples

Setting a simple content type header:

$response = new ResponseObject()

$response->set_header("Content-Type", "application/json")

Setting a custom header:

$response->set_header("X-Powered-By", "ZPE")

Setting the HTTP response status:

$response->set_http_response("404")

Notes:

• Global storage: Headers are stored in the global $_RESPONSE_HEADERS map.
• Status code: The HTTP status is stored under the key http_status.
• Server context: This object is meaningful only in web/server execution environments.