Query(3pm) User Contributed Perl Documentation Query(3pm)
NAME
URI::Query - class providing URI query string manipulation
SYNOPSIS
# Constructor - using a GET query string
$qq = URI::Query->new($query_string);
# OR Constructor - using a hashref of key => value parameters
$qq = URI::Query->new($cgi->Vars);
# OR Constructor - using an array of successive keys and values
$qq = URI::Query->new(@params);
# Revert back to the initial constructor state (to do it all again)
$qq->revert;
# Remove all occurrences of the given parameters
$qq->strip('page', 'next');
# Remove all parameters except the given ones
$qq->strip_except('pagesize', 'order');
# Remove all empty/undefined parameters
$qq->strip_null;
# Replace all occurrences of the given parameters
$qq->replace(page => $page, foo => 'bar');
# Set the argument separator to use for output (default: unescaped '&')
$qq->separator(';');
# Output the current query string
print "$qq"; # OR $qq->stringify;
# Stringify with explicit argument separator
$qq->stringify(';');
# Get a flattened hash/hashref of the current parameters
# (single item parameters as scalars, multiples as an arrayref)
my %qq = $qq->hash;
# Get a non-flattened hash/hashref of the current parameters
# (parameter => arrayref of values)
my %qq = $qq->hash_arrayref;
# Get the current query string as a set of hidden input tags
print $qq->hidden;
DESCRIPTION
URI::Query provides simple URI query string manipulation, allowing you to create and manipulate URI query strings from GET and POST
requests in web applications. This is primarily useful for creating links where you wish to preserve some subset of the parameters to the
current request, and potentially add or replace others. Given a query string this is doable with regexes, of course, but making sure you
get the anchoring and escaping right is tedious and error-prone - this module is simpler.
CONSTRUCTOR
URI::Query objects can be constructed from scalar query strings ('foo=1&bar=2&bar=3'), from a hashref which has parameters as keys, and
values either as scalars or arrayrefs of scalars (to handle the case of parameters with multiple values e.g. { foo => '1', bar => [ '2',
'3' ] }), or arrays composed of successive parameters-value pairs e.g. ('foo', '1', 'bar', '2', 'bar', '3'). For instance:
# Constructor - using a GET query string
$qq = URI::Query->new($query_string);
# Constructor - using an array of successive keys and values
$qq = URI::Query->new(@params);
# Constructor - using a hashref of key => value parameters,
# where values are either scalars or arrayrefs of scalars
$qq = URI::Query->new($cgi->Vars);
URI::Query also handles CGI.pm-style hashrefs, where multiple values are packed into a single string, separated by the "