X-Git-Url: http://erislabs.net/gitweb/?p=liburi-template-perl.git;a=blobdiff_plain;f=README;h=b8e622498b34c87d41469717b5ddbac37ab2cfc0;hp=c632c13503d537995163b22783686f7bd6bb5fa6;hb=142608d2df1288332140ed21c03b383cd6eed66f;hpb=6ce2a97438a9ca90e550caeefb1d3cecf259ded4 diff --git a/README b/README index c632c13..b8e6224 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ NAME - URI::Template - Object for handling URI templates + URI::Template - Object for handling URI templates (RFC 6570) SYNOPSIS use URI::Template; @@ -7,13 +7,9 @@ SYNOPSIS my $uri = $template->process( x => 'y' ); # uri is a URI object with value 'http://example.com/y' - my %result = $template->deparse( $uri ); - # %result is ( x => 'y' ) - 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-01.txt + This module provides a wrapper around URI templates as described in RFC + 6570: . INSTALLATION perl Makefile.PL @@ -26,36 +22,34 @@ METHODS Creates a new URI::Template instance with the template passed in as the first parameter. - as_string( ) - Returns the original template string. Also used when the object is - stringified. + template + This method returns the original template string. - variables( ) + variables Returns an array of unique variable names found in the template. NB: they are returned in random order. - all_variables( ) - Returns an array of variable names found as they appear in template -- - in order, duplicates included. + expansions + This method returns an list of expansions found in the template. + Currently, these are just coderefs. In the future, they will be more + interesting. - process( %vars|\@values ) + process( \%vars ) 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 ) + process_to_string( \%vars ) 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. - Returns a hash with the extracted values. +AUTHORS + * Brian Cassidy -AUTHOR - Brian Cassidy + * Ricardo SIGNES COPYRIGHT AND LICENSE - Copyright 2008 by Brian Cassidy + Copyright 2007-2013 by Brian Cassidy This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.