/ 
Dancer-1.3059_04
River stage three • 211 direct dependents • 215 total dependents
/ Dancer::Response

NAME

Dancer::Response - Response object for Dancer

SYNOPSIS

# create a new response object
Dancer::Response->new(
    status => 200,
    content => 'this is my content'
);

Dancer::SharedData->response->status; # 200

# fetch current response object
my $response = Dancer::SharedData->response;

# fetch the current status
$response->status; # 200

# change the status
$response->status(500);

PUBLIC API

new

Dancer::Response->new(
    status  => 200,
    content => 'my content',
    headers => HTTP::Headers->new(...),
);

create and return a new Dancer::Response object

current

my $response = Dancer::SharedData->response->current();

return the current Dancer::Response object, and reset the object

exists

if ($response->exists) {
    ...
}

test if the Dancer::Response object exists

content

# get the content
my $content = $response->content;
my $content = Dancer::SharedData->response->content;

# set the content
$response->content('my new content');
Dancer::SharedData->response->content('my new content');

set or get the content of the current response object

status

# get the status
my $status = $response->status;
my $status = Dancer::SharedData->response->status;

# set the status
$response->status(201);
Dancer::SharedData->response->status(201);

set or get the status of the current response object

content_type

# get the status
my $ct = $response->content_type;
my $ct = Dancer::SharedData->response->content_type;

# set the status
$response->content_type('application/json');
Dancer::SharedData->response->content_type('application/json');

set or get the status of the current response object

pass

$response->pass;
Dancer::SharedData->response->pass;

set the pass value to one for this response

has_passed

if ($response->has_passed) {
    ...
}

if (Dancer::SharedData->response->has_passed) {
    ...
}

test if the pass value is set to true

halt

Dancer::SharedData->response->halt();
$response->halt;

halted

if (Dancer::SharedData->response->halted) {
   ...
}

if ($response->halted) {
    ...
}
# set the header
$response->header('X-Foo' => 'bar');
Dancer::SharedData->response->header('X-Foo' => 'bar');

# get the header
my $header = $response->header('X-Foo');
my $header = Dancer::SharedData->response->header('X-Foo');

get or set the value of a header

headers

$response->headers(HTTP::Headers->new(...));
Dancer::SharedData->response->headers(HTTP::Headers->new(...));

return the list of headers for the current response

headers_to_array

my $headers_psgi = $response->headers_to_array();
my $headers_psgi = Dancer::SharedData->response->headers_to_array();

this method is called before returning a PSGI response. It transforms the list of headers to an array reference.