The URL plugin can be used to construct complex URLs from a base stem
and a hash array of additional query parameters.
The constructor should be passed a base URL and optionally, a hash array
reference of default parameters and values. Used from with a template,
it would look something like the following:
[% USE url(http://www.somewhere.com/cgi-bin/foo.pl) %]
[% USE url(/cgi-bin/bar.pl, mode=browse) %]
[% USE url(/cgi-bin/baz.pl, mode=browse, debug=1) %]
When the plugin is then called without any arguments, the default base
and parameters are returned as a formatted query string.
[% url %]
For the above three examples, these will produce the following outputs:
Note that additional parameters are separated by & rather than
simply &. This is the correct behaviour for HTML pages but is,
unfortunately, incorrect when creating URLs that do not need to be
encoded safely for HTML. This is likely to be corrected in a future
version of the plugin (most probably with TT3). In the mean time, you
can set $Template::Plugin::URL::JOINT to & to get the correct
Additional parameters may be also be specified to the URL:
[% url(mode=submit, id=wiz) %]
Which, for the same three examples, produces:
A new base URL may also be specified as the first option:
[% url(/cgi-bin/waz.pl, test=1) %]
The ordering of the parameters is non-deterministic due to fact that
Perls hashes themselves are unordered. This isnt a problem as the
ordering of CGI parameters is insignificant (to the best of my knowledge).
All values will be properly escaped thanks to some code borrowed from
Lincoln Steins CGI module. e.g.
[% USE url(/cgi-bin/woz.pl) %]
[% url(name="Elrich von Benjy dWeiro") %]
Here the spaces and "" character are escaped in the output:
An alternate name may be provided for the plugin at construction time
as per regular Template Toolkit syntax.
[% USE mycgi = url(cgi-bin/min.pl) %]
[% mycgi(debug=1) %]