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.22'
[liburi-template-perl.git]
/
README
diff --git
a/README
b/README
index
f621fca
..
6dc86bd
100644
(file)
--- a/
README
+++ b/
README
@@
-1,16
+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' );
+
+ # 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
# uri is a URI object with value 'http://example.com/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-03.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
@@
-21,14
+28,15
@@
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)
.
- template
- This method returns the original template string.
+ 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
(in the
+
order of appearance)
.
expansions
This method returns an list of expansions found in the template.
expansions
This method returns an list of expansions found in the template.
@@
-44,13
+52,13
@@
METHODS
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.
-AUTHOR
- Brian Cassidy <bricas@cpan.org>
+AUTHOR
S
+
*
Brian Cassidy <bricas@cpan.org>
- Ricardo SIGNES <rjbs@cpan.org>
+
*
Ricardo SIGNES <rjbs@cpan.org>
COPYRIGHT AND LICENSE
COPYRIGHT AND LICENSE
- Copyright 2007-20
09
by Brian Cassidy
+ Copyright 2007-20
15
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.