| Plack::Request::WithEncoding(3pm) | User Contributed Perl Documentation | Plack::Request::WithEncoding(3pm) |
Plack::Request::WithEncoding - Subclass of Plack::Request which supports encoding.
use Plack::Request::WithEncoding;
my $app_or_middleware = sub {
my $env = shift; # PSGI env
# Example of $env
#
# $env = {
# QUERY_STRING => 'query=%82%d9%82%b0', # <= encoded by 'cp932'
# REQUEST_METHOD => 'GET',
# HTTP_HOST => 'example.com',
# PATH_INFO => '/foo/bar',
# };
my $req = Plack::Request::WithEncoding->new($env);
$req->env->{'plack.request.withencoding.encoding'} = 'cp932'; # <= specify the encoding method.
my $query = $req->param('query'); # <= get parameters of 'query' that is decoded by 'cp932'.
my $res = $req->new_response(200); # new Plack::Response
$res->finalize;
};
Plack::Request::WithEncoding is the subclass of Plack::Request. This module supports the encoding for requests, the following attributes will return decoded request values.
Please refer also "SPECIFICATION OF THE ENCODING METHOD".
Returns a encoding method to use to decode parameters.
Returns a reference to a hash containing decoded query string (GET) parameters. This hash reference is Hash::MultiValue object.
Returns a reference to a hash containing decoded posted parameters in the request body (POST). As with "query_parameters", the hash reference is a Hash::MultiValue object.
Returns a Hash::MultiValue hash reference containing decoded (and merged) GET and POST parameters.
Returns decoded GET and POST parameters with a CGI.pm-compatible param method. This is an alternative method for accessing parameters in "$req->parameters". Unlike CGI.pm, it does not allow setting or modifying query parameters.
$value = $req->param( 'foo' );
@values = $req->param( 'foo' );
@params = $req->param;
This attribute is the same as "query_parameters" of Plack::Request.
This attribute is the same as "body_parameters" of Plack::Request.
This attribute is the same as "parameters" of Plack::Request.
This attribute is the same as "param" of Plack::Request.
You can specify the encoding method, like so;
$req->env->{'plack.request.withencoding.encoding'} = 'utf-7'; # <= set utf-7
And this encoding method will be used to decode.
When not once substituted for "$req->env->{'plack.request.withencoding.encoding'}", this module will use "utf-8" as encoding method. However the behavior of a program will become unclear if this function is used. Therefore YOU SHOULD NOT USE THIS. You should specify the encoding method explicitly.
In case of false value (e.g. `undef`, 0, '') is explicitly substituted for "$req->env->{'plack.request.withencoding.encoding'}", then this module will return raw value (with no encoding).
The example of a code is shown below.
print exists $req->env->{'plack.request.withencoding.encoding'} ? 'EXISTS'
: 'NOT EXISTS'; # <= NOT EXISTS
$query = $req->param('query'); # <= get parameters of 'query' that is decoded by 'utf-8' (*** YOU SHOULD NOT USE LIKE THIS ***)
$req->env->{'plack.request.withencoding.encoding'} = undef; # <= explicitly specify the `undef`
$query = $req->param('query'); # <= get parameters of 'query' that is not decoded (raw value)
$req->env->{'plack.request.withencoding.encoding'} = 'cp932'; # <= specify the 'cp932' as encoding method
$query = $req->param('query'); # <= get parameters of 'query' that is decoded by 'cp932'
Plack::Request
Copyright (C) moznion.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
moznion <moznion@gmail.com>
| 2018-06-18 | perl v5.26.2 |