/ 
Kelp-0.9012
River stage two • 22 direct dependents • 23 total dependents
/ Kelp::Request

NAME

Kelp::Request - Request class for a Kelp application

SYNOPSIS

my $request = Kelp::Request( app => $app, env => $env );

DESCRIPTION

This module provides a convenience layer on top of Plack::Request. It extends it to add several convenience methods.

ATTRIBUTES

app

A reference to the Kelp application.

stash

An all use, utility hash to use to pass information between routes.

named

This hash is initialized with the named placeholders of the path that the current route is processing.

param

Returns the HTTP parameters of the request. This method delegates all the work to "param" in Plack::Request, except when the content type of the request is application/json. In that case, it will decode the JSON body and return as follows:

  • If no arguments are passed, then it will return the names of the HTTP parameters when called in array contest, and a reference to the entire JSON hash when called in scalar context.

    # JSON body = { bar => 1, foo => 2 }
my @names = $self->param;   # @names = ('bar', 'foo')
my $json = $self->param;    # $json = { bar => 1, foo => 2 }

  • If a single argument is passed, then the corresponding value in the JSON document is returned.

    my $bar = $self->param('bar');  # $bar = 1

address, remote_host, user

These are shortcuts to the REMOTE_ADDR, REMOTE_HOST and REMOTE_USER environment variables.

if ( $self->req->address eq '127.0.0.1' ) {
    ...
}

Note. If you're running the web app behind nginx (or another web server), you need to use Plack::Middleware::ReverseProxy.

# app.psgi

builder {
    enable_if { $_[0]->{REMOTE_ADDR} =~ /127\.0\.0\.1/ }
    "Plack::Middleware::ReverseProxy";
    $app->run;
};

session

Returns the Plack session hash or dies if no Session middleware was included.

sub route_zero {
    my $self = shift;
    $self->session->{user} = 45;
}

If called with a single argument, returns that value from the session hash:

sub route_one {
    my $self = shift;
    my $user = $self->req->session('user');
}

Set values in the session using key-value pairs:

sub route_two {
    my $self = shift;
    $self->req->session(
        name  => 'Jill Andrews',
        age   => 24,
        email => 'jill@perlkelp.com'
    );
}

Common tasks with sessions

Initialize file sessions

In your config file:

middleware => ['Session'],
middleware_init => {
    Session => {
        store => 'File'
    }
}
Delete session values
delete $self->req->session->{'useless'};
Remove all session values
$self->req->session = {};

is_ajax

Returns true if the request was called with XMLHttpRequest.

is_json

Returns true if the request's content type was application/json.