X-Git-Url: http://erislabs.net/gitweb/?p=liburi-template-perl.git;a=blobdiff_plain;f=README;h=b07c19f8f74521c0fac69f3f546414bb3b5a5732;hp=eb4da93e24feb49ef3a407cc13891d73b8e83f06;hb=e0de6ab08282e52476e36abb99a35be9eff9ca8e;hpb=7c69490596e221b9d4be4d94de939429258ff7b3 diff --git a/README b/README index eb4da93..b07c19f 100644 --- a/README +++ b/README @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION This is an initial attempt to provide a wrapper around URI templates as described at - http://www.ietf.org/internet-drafts/draft-gregorio-uritemplate-00.txt + http://www.ietf.org/internet-drafts/draft-gregorio-uritemplate-01.txt INSTALLATION To install this module via Module::Build: @@ -43,13 +43,18 @@ METHODS Returns an array of variable names found in the template. NB: they are returned in random order. - process( %vars ) - Given a list of key-value pairs, it will URI escape the values and - substitute them in to the template. Returns a URI object. + all_variables( ) + Returns an array of variable names found as they appear in template -- + in order, duplicates included. - process_to_string( %vars ) - Processes key-values pairs like the "process" method, but doesn't - inflate the result to a URI object. + process( %vars|\@values ) + Given a list of key-value pairs or an array ref of values (for + positional substitution), it will URI escape the values and substitute + them in to the template. Returns a URI object. + + process_to_string( %vars|\@values ) + Processes input like the "process" method, but doesn't inflate the + result to a URI object. deparse( $uri ) Does some rudimentary deparsing of a uri based on the current template.