Dancer::Response3pm

Response object for dancer

Usage

    # 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);

Version

version 1.3521

Public API

new

    Dancer::Response->new(
        status  => 200,
        content => 'my content',
        headers => ['X-Foo' => 'foo-value', 'X-Bar' => 'bar-value'],
    );

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. The default status is 200.

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($content)

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

Stops the processing of the current request. See "halt" in Dancer.

halted

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

This flag will be true if the current response has been halted.

header

    # 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('X-Foo' => 'fff', 'X-Bar' => 'bbb');
    Dancer::SharedData->response->headers('X-Foo' => 'fff', 'X-Bar' => 'bbb');

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.

Copyright and license

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Releases

7 releases since Debian 7 (Wheezy); the text changed 5 times.

7
8
9
10
11
12–13