NAME

HTTP::Rollup - translate an HTTP query string to a hierarchal structure

SYNOPSIS

 my $hashref = HTTP::Rollup::RollupQueryString($query_string);

 my $hashref = HTTP::Rollup::RollupQueryString($query_string,
                                              { FORCE_LIST => 1 });

DESCRIPTION

Given input text of the format:

  employee.name.first=Jane
  employee.name.last=Smith
  employee.address=123%20Main%20St.
  employee.city=New%20York
  id=444
  phone=(212)123-4567
  phone=(212)555-1212
  @fax=(212)999-8877

Construct an output data structure like this:

  $hashref = {
    $employee => {
                  name => {
                           "first" => "Jane",
                           "last" => "Smith",
                          },
                  address => "123 Main St.",
                  city => "New York"
                 },
    $phone => [
               "(212)123-4567",
               "(212)555-1212"
              ],
    $fax => [
             "(212)999-8877"
            ],
    $id => 444
  };

This is intended as a drop-in replacement for the HTTP query string parsing implemented in CGI.pm. CGI.pm constructs purely flat structures, e.g. with the above example:

  $hashref = {
    "employee.name.first" => [ "Jason" ],
    "employee.name.last" => [ "Smith" ],
    "employee.name.address" => [ "123 Main St." ],
    "employee.name.city" => [ "New York" ],
    "phone" => [ "(212)123-4567", "(212)555-1212" ],
    "@fax"=> [ "(212)999-8877" ],
    "id" => [ 444 ]
  };

The FORCE_LIST switch causes CGI.pm-style behavior, as above, for backward compatibility.

FEATURES

• Data nesting using dot notation

• Recognizes a list if there is more than one value with the same name

• Lists can be forced with a leading @-sign, to allow for lists that could have just one element (eliminating ambiguity between scalar and single- element list). The @ will be stripped.

AUTHOR

Jason W. May <jmay@pobox.com>

COPYRIGHT

Copyright (C) 2002 Jason W. May. All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.