GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MOJOLICIOUS::ROUTES (3)

.ds Aq ’

NAME

Mojolicious::Routes - Always find your destination with routes

CONTENTS

SYNOPSIS



  use Mojolicious::Routes;

  # Simple route
  my $r = Mojolicious::Routes->new;
  $r->route(/)->to(controller => blog, action => welcome);

  # More advanced routes
  my $blog = $r->under(/blog);
  $blog->get(/list)->to(blog#list);
  $blog->get(/:id => [id => qr/\d+/])->to(blog#show, id => 23);
  $blog->patch(sub { shift->render(text => Go away!, status => 405) });



DESCRIPTION

Mojolicious::Routes is the core of the Mojolicious web framework.

See Mojolicious::Guides::Routing for more.

ATTRIBUTES

Mojolicious::Routes inherits all attributes from Mojolicious::Routes::Route and implements the following new ones.

    base_classes



  my $classes = $r->base_classes;
  $r          = $r->base_classes([MyApp::Controller]);



Base classes used to identify controllers, defaults to Mojolicious::Controller and Mojo.

    cache



  my $cache = $r->cache;
  $r        = $r->cache(Mojo::Cache->new);



Routing cache, defaults to a Mojo::Cache object.

    conditions



  my $conditions = $r->conditions;
  $r             = $r->conditions({foo => sub {...}});



Contains all available conditions.

    hidden



  my $hidden = $r->hidden;
  $r         = $r->hidden([attr, has, new]);



Controller attributes and methods that are hidden from router, defaults to attr, has, new and tap.

    namespaces



  my $namespaces = $r->namespaces;
  $r             = $r->namespaces([MyApp::Controller, MyApp]);



Namespaces to load controllers from.



  # Add another namespace to load controllers from
  push @{$r->namespaces}, MyApp::MyController;



    shortcuts



  my $shortcuts = $r->shortcuts;
  $r            = $r->shortcuts({foo => sub {...}});



Contains all available shortcuts.

METHODS

Mojolicious::Routes inherits all methods from Mojolicious::Routes::Route and implements the following new ones.

    add_condition



  $r = $r->add_condition(foo => sub {...});



Register a condition.



  $r->add_condition(foo => sub {
    my ($route, $c, $captures, $arg) = @_;
    ...
    return 1;
  });



    add_shortcut



  $r = $r->add_shortcut(foo => sub {...});



Register a shortcut.



  $r->add_shortcut(foo => sub {
    my ($route, @args) = @_;
    ...
  });



    continue



  $r->continue(Mojolicious::Controller->new);



Continue dispatch chain and emit the hook around_action in Mojolicious for every action.

    dispatch



  my $bool = $r->dispatch(Mojolicious::Controller->new);



Match routes with match and dispatch with continue.

    hide



  $r = $r->hide(foo, bar);



Hide controller attributes and methods from router.

    is_hidden



  my $bool = $r->is_hidden(foo);



Check if controller attribute or method is hidden from router.

    lookup



  my $route = $r->lookup(foo);



Find route by name with find in Mojolicious::Routes::Route and cache all results for future lookups.

    match



  $r->match(Mojolicious::Controller->new);



Match routes with Mojolicious::Routes::Match.

SEE ALSO

Mojolicious, Mojolicious::Guides, <http://mojolicious.org>.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MOJOLICIOUS::ROUTES (3) 2016-03-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.