NAME

       Mojo::Parameters - Parameters

SYNOPSIS

         use Mojo::Parameters;

         # Parse
         my $params = Mojo::Parameters->new('foo=bar&baz=23');
         say $params->param('baz');

         # Build
         my $params = Mojo::Parameters->new(foo => 'bar', baz => 23);
         push @$params, i => 'X mojolicious';
         say "$params";

DESCRIPTION

       Mojo::Parameters is a container for form parameters used by Mojo::URL.

ATTRIBUTES

       Mojo::Parameters implements the following attributes.

   charset
         my $charset = $params->charset;
         $params     = $params->charset('UTF-8');

       Charset used for encoding and decoding parameters, defaults to "UTF-8".

         # Disable encoding and decoding
         $params->charset(undef);

METHODS

       Mojo::Parameters inherits all methods from Mojo::Base and implements the following new
       ones.

   new
         my $params = Mojo::Parameters->new;
         my $params = Mojo::Parameters->new('foo=b%3Bar&baz=23');
         my $params = Mojo::Parameters->new(foo => 'b;ar');
         my $params = Mojo::Parameters->new(foo => ['ba;r', 'b;az']);
         my $params = Mojo::Parameters->new(foo => ['ba;r', 'b;az'], bar => 23);

       Construct a new Mojo::Parameters object and "parse" parameters if necessary.

   append
         $params = $params->append(foo => 'ba;r');
         $params = $params->append(foo => ['ba;r', 'b;az']);
         $params = $params->append(foo => ['ba;r', 'b;az'], bar => 23);

       Append parameters. Note that this method will normalize the parameters.

         # "foo=bar&foo=baz"
         Mojo::Parameters->new('foo=bar')->append(foo => 'baz');

         # "foo=bar&foo=baz&foo=yada"
         Mojo::Parameters->new('foo=bar')->append(foo => ['baz', 'yada']);

         # "foo=bar&foo=baz&foo=yada&bar=23"
         Mojo::Parameters->new('foo=bar')->append(foo => ['baz', 'yada'], bar => 23);

   clone
         my $params2 = $params->clone;

       Clone parameters.

   merge
         $params = $params->merge(Mojo::Parameters->new(foo => 'b;ar', baz => 23));

       Merge Mojo::Parameters objects. Note that this method will normalize the parameters.

   param
         my @names = $params->param;
         my $foo   = $params->param('foo');
         my @foo   = $params->param('foo');
         my $foo   = $params->param(foo => 'ba;r');
         my @foo   = $params->param(foo => qw(ba;r ba;z));

       Check and replace parameter value. Be aware that if you request a parameter by name in
       scalar context, you will receive only the first value for that parameter, if there are
       multiple values for that name. In list context you will receive all of the values for that
       name. Note that this method will normalize the parameters.

   params
         my $array = $params->params;
         $params   = $params->params([foo => 'b;ar', baz => 23]);

       Parsed parameters. Note that this method will normalize the parameters.

   parse
         $params = $params->parse('foo=b%3Bar&baz=23');

       Parse parameters.

   remove
         $params = $params->remove('foo');

       Remove parameters. Note that this method will normalize the parameters.

         # "bar=yada"
         Mojo::Parameters->new('foo=bar&foo=baz&bar=yada')->remove('foo');

   to_hash
         my $hash = $params->to_hash;

       Turn parameters into a hash reference. Note that this method will normalize the
       parameters.

         # "baz"
         Mojo::Parameters->new('foo=bar&foo=baz')->to_hash->{foo}[1];

   to_string
         my $str = $params->to_string;
         my $str = "$params";

       Turn parameters into a string.

PARAMETERS

       Direct array reference access to the parsed parameters is also possible. Note that this
       will normalize the parameters.

         say $params->[0];
         say for @$params;

SEE ALSO

       Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.