projects
/
liburi-template-perl.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge tag 'upstream/0.20'
[liburi-template-perl.git]
/
README
diff --git
a/README
b/README
index
fd4982a
..
86648fa
100644
(file)
--- a/
README
+++ b/
README
@@
-1,19
+1,23
@@
NAME
NAME
- URI::Template - Object for handling URI templates
+ URI::Template - Object for handling URI templates
(RFC 6570)
SYNOPSIS
use URI::Template;
SYNOPSIS
use URI::Template;
+
my $template = URI::Template->new( 'http://example.com/{x}' );
my $uri = $template->process( x => 'y' );
my $template = URI::Template->new( 'http://example.com/{x}' );
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' )
+ # or
+
+ my $template = URI::Template->new();
+ $template->template( 'http://example.com/{x}' );
+ my $uri = $template->process( x => 'y' );
+
+ # uri is a URI object with value 'http://example.com/y'
DESCRIPTION
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: <http://tools.ietf.org/html/rfc6570>.
INSTALLATION
perl Makefile.PL
INSTALLATION
perl Makefile.PL
@@
-24,38
+28,37
@@
INSTALLATION
METHODS
new( $template )
Creates a new URI::Template instance with the template passed in as the
METHODS
new( $template )
Creates a new URI::Template instance with the template passed in as the
- first parameter.
+ first parameter
(optional)
.
-
as_string(
)
- Returns the original template string. Also used when the object is
-
stringified
.
+
template( $template
)
+ This method returns the original template string. If provided, it will
+
also set and parse a new template string
.
- variables
( )
+ variables
Returns an array of unique variable names found in the template. NB:
they are returned in random order.
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|\@value
s )
+ process(
\%var
s )
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.
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|\@value
s )
+ process_to_string(
\%var
s )
Processes input like the "process" method, but doesn't inflate the
result to a URI object.
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 <bricas@cpan.org>
-AUTHOR
- Brian Cassidy <bricas@cpan.org>
+ * Ricardo SIGNES <rjbs@cpan.org>
COPYRIGHT AND LICENSE
COPYRIGHT AND LICENSE
- Copyright 2007 by Brian Cassidy
+ Copyright 2007
-2015
by Brian Cassidy
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.