The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Apache::Wombat::Response - Apache connector response class

SYNOPSIS

DESCRIPTION

Apache connector response class. Extends Wombat::Connector::HttpResponseBase. Overrides many superclass methods to delegate to an underlying Apache::Request instance.

CONSTRUCTOR

new($apr)

Create and return an instance, initializing fields to default values.

Parameters:

$apr

a Apache::Request instance representing the Apache request record

METHODS

addDateHeader($name, $date)

Add a date value for the named response header to the Apache headers_out table.

Parameters:

$name

the name of the response header

$date

the additional header value, as the number of seconds since the epoch

setDateHeader($name, $date)

Set the date value for the named response header in the Apache headers_out table.

Parameters:

$name

the name of the header

$date

the header value, as the number of seconds since the epoch

addHeader($name, $value)

Add a value for the named response header to the Apache headers_out table.

Parameters:

$name

the parameter name

$value

the parameter value, scalar

getHeader($name)

Return the first value for the named response header from the Apache headers_out table.

getHeaderNames()

Return the names of all the response headers from the Apache headers_out table.

getHeaders($name)

Return the list of values for the named response header from the Apache headers_out table.

Parameters:

$name

the header name

setHeader($name, $value)

Set the value for the named response header in the Apache headers_out table.

Parameters:

$name

the name of the response header

$value

the header value

clearHeaders()

Unset all response headers from the Apache headers_out table.

getStatus()

Return the HTTP status code for this Response.

setStatus($code)

Set the status code for this response.

Parameters:

$code

the HTTP status code

PACKAGE METHODS

sendHeaders()

Direct Apache API to send a response header, committing the response. Usually doesn't need to be called by other classes, but will be called the first time the buffer is flushed.

getRequestRec()

Return the Apache request record for this Request.

setRequestRec($apr)

Set the Apache request record for this Request.

Parameters:

$apr

the Apache::Request instance

recycle()

Release all object references and initialize instances variables in preparation for use or reuse of this object.

SEE ALSO

Apache, Apache::Request, Apache::Table, Apache::Util, Wombat::Connector::HttpResponseBase

AUTHOR

Brian Moseley, bcm@maz.org