Symphony.

static integer HTTP_NOT_MODIFIED = 304

Refers to the HTTP status code, 304 Not Modified

static integer HTTP_STATUS_BAD_REQUEST = 400

Refers to the HTTP status code, 400 Bad Request

static integer HTTP_STATUS_ERROR = 500

Refers to the HTTP status code, 500 Internal Server Error

static integer HTTP_STATUS_FORBIDDEN = 403

Refers to the HTTP status code, 403 Forbidden

static integer HTTP_STATUS_FOUND = 302

Refers to the HTTP status code, 302 Found This is used as a temporary redirect

static integer HTTP_STATUS_MOVED_PERMANENT = 301

Refers to the HTTP status code, 301 Moved Permanently

static integer HTTP_STATUS_NOT_FOUND = 404

Refers to the HTTP status code, 404 Not Found

static integer HTTP_STATUS_OK = 200

Refers to the HTTP status code, 200 OK

static integer HTTP_STATUS_UNAUTHORIZED = 401

Refers to the HTTP status code, 401 Unauthorized

static array $HTTP_STATUSES

Keyed array of all the string

void __construct()

Initialises the Page object by setting the headers to empty

void addHeaderToPage(string $name, string $value, integer $response_code)

Adds a header to the $_headers array using the $name as the key.

Parameters

• $name stringThe header name, eg. Content-Type.

• $value string(optional) The value for the header, eg. text/xml. Defaults to null.

• $response_code integer(optional) The HTTP response code that should be set by PHP with this header, eg. 200

void generate(mixed $page)

This function calls __renderHeaders().

See Also

• __renderHeaders()

static string getHeaderStatusString(integer $status_code)

This method format the provided $status_code to used php's header() function.

Parameters

• $status_code integerThe HTTP Status code to get the value for

Returns

The formatted HTTP Status string

integer getHttpStatusCode()

Gets the current HTTP Status. If none is set, it assumes HTTPSTATUSOK

static array|string getHttpStatusValue(integer $status_code)

This method returns the string HTTP Status value. If $status_code is null, it returns all the values currently registered.

Parameters

• $status_code integer(optional) The HTTP Status code to get the value for.

Returns

Returns string if the $status_code is not null. Array otherwise

See Also

• http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

array headers()

Accessor function for $_headers

void isRequestValid()

This function will check to ensure that this post request is not larger than what the server is set to handle. If it is, a notice is shown.

See Also

• https://github.com/symphonycms/symphony-2/issues/1187

void removeHeaderFromPage(string $name)

Removes a header from the $_headers array using the $name as the key.

Parameters

• $name stringThe header name, eg. Expires.

static void renderStatusCode(integer $status_code)

This method calls php's header() function in order to set the HTTP status code properly on all platforms.

See Also

• https://github.com/symphonycms/symphony-2/issues/1558#issuecomment-10663716

void setHttpStatus(integer $status_code)

Shorthand for addHeaderToPage in order to set the HTTP Status header.

Parameters

• $status_code integerThe HTTP Status numeric value.

static void setHttpStatusValue(integer $status_code, string $string_value)

Sets the $sting_value for the specified $status_code. If $sting_value is null, the $status_code is removed from the array.

This allow developers to register customs HTTP_STATUS into the static Page::$HTTP_STATUSES array and use $page->setHttpStatus().

Parameters

• $status_code integerThe HTTP Status numeric code.

• $string_value stringThe HTTP Status string value.