Path::Router(3pm) | User Contributed Perl Documentation | Path::Router(3pm) |
Path::Router - A tool for routing paths
version 0.15
my $router = Path::Router->new; $router->add_route('blog' => ( defaults => { controller => 'blog', action => 'index', }, # you can provide a fixed "target" # for a match as well, this can be # anything you want it to be ... target => My::App->get_controller('blog')->get_action('index') )); $router->add_route('blog/:year/:month/:day' => ( defaults => { controller => 'blog', action => 'show_date', }, # validate with ... validations => { # ... raw-Regexp refs year => qr/\d{4}/, # ... custom Moose types you created month => 'NumericMonth', # ... Moose anon-subtypes created inline day => subtype('Int' => where { $_ <= 31 }), } )); $router->add_route('blog/:action/?:id' => ( defaults => { controller => 'blog', }, validations => { action => qr/\D+/, id => 'Int', # also use plain Moose types too } )); # even include other routers $router->include_router( 'polls/' => $another_router ); # ... in your dispatcher # returns a Path::Router::Route::Match object my $match = $router->match('/blog/edit/15'); # ... in your code my $uri = $router->uri_for( controller => 'blog', action => 'show_date', year => 2006, month => 10, day => 5, );
This module provides a way of deconstructing paths into parameters suitable for dispatching on. It also provides the inverse in that it will take a list of parameters, and construct an appropriate uri for it.
This module places a high degree of importance on reversability. The value produced by a path match can be passed back in and you will get the same path you originally put in. The result of this is that it removes ambiguity and therefore reduces the number of possible mis-routings.
This module also provides additional tools you can use to test and verify the integrity of your router. These include:
Examples:
# You have more than three paths, insert a new route at # the 4th item $router->insert_route($path => ( at => 3, %options )); # If you have less items than the index, then it's the same as # as add_route -- it's just appended to the end of the list $router->insert_route($path => ( at => 1_000_000, %options )); # If you want to prepend, omit "at", or specify 0 $router->insert_Route($path => ( at => 0, %options ));
It should be noted that this does not do any kind of redispatch to the $other_router, it actually extracts all the paths from $other_router and inserts them into the invocant router. This means any changes to $other_router after inclusion will not be reflected in the invocant.
You can turn on the verbose debug logging with the "PATH_ROUTER_DEBUG" environment variable.
All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT.
Stevan Little <stevan@cpan.org>
Copyright 2008-2011 Infinity Interactive, Inc.
<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Stevan Little <stevan@cpan.org>
This software is copyright (c) 2016 by Infinity Interactive.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
2016-03-01 | perl v5.22.1 |