NAME Path::Resource - URI/Path::Class combination VERSION Version 0.072 SYNOPSIS use Path::Resource; # Map a resource on the local disk to a URI. # Its (disk) directory is "/var/dir" and its uri is "http://hostname/loc" my $rsc = new Path::Resource dir => "/var/dir", uri => "http://hostname/loc"; # uri: http://hostname/loc # dir: /var/dir my $apple_rsc = $rsc->child("apple"); # uri: http://hostname/loc/apple # dir: /var/dir/apple my $banana_txt_rsc = $apple_rsc->child("banana.txt"); # uri: http://hostname/loc/apple/banana.txt # file: /var/dir/apple/banana.txt my $size = -s $banana_txt_rsc->file; redirect($banana_txt_rsc->uri); # Redirect to "http://hostname/loc/apple/banana.txt" DESCRIPTION Path::Resource is a module for combining local file and directory manipulation with URI manipulation. It allows you to effortlessly map local file locations to their URI equivalent. It combines Path::Class and URI into one object. Given a base Path::Resource, you can descend (using ->child) or ascend (using ->parent) the path tree while maintaining URI equivalency, all in one object. As a convenience, if you do not need the full URI, you can use the ->loc method to just return the URI path. METHODS $rsc = Path::Resource->new $rsc = Path::Resource->new( dir => $dir, uri => $uri, [ path => $path ] ) Create and return a new Path::Resource object using $dir as the base dir and $uri as the base uri. The URI path of $uri will be automatically extracted and used as the base loc. If $path is given, then the $rsc will start at that point on the path. # For example, if the following $rsc is created like so: my $rsc = Path::Resource->new(uri => "http://example.com/a", dir => "/home/b/htdocs", path => "xyzzy"); my $dir = $rsc->dir; # The dir "/home/b/htdocs/xyzzy" my $uri = $rsc->uri; # The uri "http://example.com/a/xyzzy" # Note that path doesn't have to be a dir. # You can give it a file path if you like (Path::Resource doesn't care) $rsc = Path::Resource->new(uri => "http://example.com/a", dir => "/home/b/htdocs", path => "xyzzy/nothing.txt"); my $file = $rsc->file; # The file "/home/b/htdocs/xyzzy/nothing.txt" $uri = $rsc->uri; # The uri "http://example.com/a/xyzzy/nothing.txt" $rsc = Path::Resource->new( dir => $dir, uri => $uri, loc => $loc, [ path => $path ] ) Create and return a new Path::Resource object using $dir as the base dir, $uri as the base uri, and using $loc as the base loc (the uri path). If $loc is relative, then it will be appended to $uri->path, otherwise (being absolute) it will replace $uri->path. If $path is given, then the $rsc will start at that point on the path. # For example, if the following $rsc is created like so: my $rsc = Path::Resource->new(uri => "http://example.com/a", dir => "/home/b/htdocs", loc => "c"); my $dir = $rsc->dir; # The dir "/home/b/htdocs" my $uri = $rsc->uri; # The uri "http://example.com/a/c" # On the other hand: $rsc = Path::Resource->new(uri => "http://example.com/a", dir => "/home/b/htdocs", loc => "/g/h"); $dir = $rsc->dir; # The dir "/home/b/htdocs" $uri = $rsc->uri; # The uri "http://example.com/g/h $rsc = Path::Resource->new( file => $file, dir => $dir, uri => $uri, [ loc => $loc, path => $path ] ) Create and return a new Path::Resource object using $dir as the base dir, $uri as the base uri, and the difference between $file and $dir as the path (literally: $path = $file->relative($dir)) If $loc is given then if it is relative, then it will be appended to $uri->path, otherwise (being absolute) it will replace $uri->path. $rsc->path $rsc->path( , [ , ..., ] ) Return a clone of $rsc->path based on $rsc->path and any optional passed through my $rsc = Path::Resource->new(path => "b/c"); # $path is "b/c" my $path = $rsc->path; # $path is "b/c/d" my $path = $rsc->path("d"); $rsc->clone $rsc->clone( ) Return a Path::Resource object that is a copy of $rsc The optional argument will change (not append) the path of the cloned object $rsc->subdir( , [ , ..., ] ) $rsc->child( , [ , ..., ] ) Return a clone Path::Resource object whose path is the child of $rsc->path my $rsc = Path::Resource->new(dir => "/a", path => "b"); # $rsc->path is "b/c/d.tmp" $rsc = $rsc->child("c/d.tmp"); # ->subdir is an alias for ->child $rsc = $rsc->parent->subdir("e"); $rsc->parent Return a clone Path::Resource object whose path is the parent of $rsc->path my $rsc = Path::Resource->new(dir => "/a", path => "b/c"); # $rsc->path is "b" $rsc = $rsc->parent; # $rsc->path is "" $rsc = $rsc->parent; # $dir is "/a/f" my $dir = $rsc->parent->parent->dir("f"); $rsc->loc $rsc->loc( , [ , ..., ] ) Return a Path::Abstract object based on the path part of $rsc->base->uri ($rsc->base->loc), $rsc->path, and any optional passed through my $rsc = Path::Resource->new(uri => "http://example.com/a", path => "b/c"); # $loc is "/a/b/c" my $loc = $rsc->loc; # $dir is "/a/b/c/d.tmp" $loc = $rsc->loc("d.tmp"); $rsc->uri $rsc->uri( , [ , ..., ] ) Return a URI object based on $rsc->base->uri, $rsc->path, and any optional passed through my $rsc = Path::Resource->new(uri => "http://example.com/a", path => "b/c"); # $uri is "http://example.com/a/b/c" my $uri = $rsc->uri; # $uri is "http://example.com/a/b/c/d.tmp" $uri = $rsc->uri("d.tmp"); # $uri is "https://example.com/a/b/c/d.tmp" $uri->scheme("https"); $rsc->file $rsc->file( [ , , ..., ] ) Return a Path::Class::File object based on $rsc->base->dir, $rsc->path, and any optional passed through NOTE: This method will return a Path::Class::File object, *NOT* a new Path::Resource object (use ->child for that functionality) my $rsc = Path::Resource->new(dir => "/a", path => "b"); $rsc = $rsc->child("c/d.tmp"); # $file is "/a/b/c/d.tmp" my $file = $rsc->file; # $file is "/a/b/c/d.tmp/e.txt" $file = $rsc->file(qw/ e.txt /); $rsc->dir $rsc->dir( , [ , ..., ] ) Return a Path::Class::Dir object based on $rsc->base->dir, $rsc->path, and any optional passed through my $rsc = Path::Resource->new(dir => "/a", path => "b"); $rsc = $rsc->child("c/d.tmp"); # $dir is "/a/b/c/d.tmp" my $dir = $rsc->file; # $dir is "/a/b/c/d.tmp/e.tmp" $dir = $rsc->file(qw/ e.tmp /); $rsc->base Return the Path::Resource::Base object for $rsc AUTHOR Robert Krimen, "" SEE ALSO URI::ToDisk BUGS Please report any bugs or feature requests to "bug-path-resource at rt.cpan.org", or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. SUPPORT You can find documentation for this module with the perldoc command. perldoc Path::Resource You can also look for information at: * AnnoCPAN: Annotated CPAN documentation * CPAN Ratings * RT: CPAN's request tracker * Search CPAN ACKNOWLEDGEMENTS COPYRIGHT & LICENSE Copyright 2007 Robert Krimen, all rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.