Lemonldap::NG::Common::PSGI::Router3pm

Initialization methods

addRoute ( $word, $dest, $methods )

Declare a REST route. Arguments:

Route types

As seen in "SYNOPSIS", you can declare routes with variable component. $dest can be:

a word:

the name of the method to call

undef:

$word is used as $dest

a ref to code:

an anonymous subroutin to call

a hash ref:

it's a recursive call to `{ $word => $dest }`

an array ref:

in this case each element of the array will be considered as `{ $element => $element }`. So each element must be a word that makes a correspondence between a path_info word and a subroutine

Some special $word:

':name':

the word in path_info will be stored in GET parameters

'*':

the subroutine will be called with the word of path_info as second argument (after $req)

'something.html':

if $word finishes with '.html', and $dest is undef, then sendHtml() will be called with 'something.tpl' as template name.

Examples:

to manage http://.../books/127 with book() where 127 is the book number, use:

  $self->addRoute( books => { ':bookId' => 'book' }, ['GET'] );

bookId parameter will be stored in $req->params('bookId');

to manage http://.../books/127/pages/5 with page(), use:

  $self->addRoute( books => { ':bookId' => { pages => { ':pageId' => 'page' } } }, ['GET'] );

to manage simultaneously the 2 previous examples

  $self->addRoute( books => { ':bookId' => { pages => { ':pageId' => 'page' } } }, ['GET'] )
       ->addRoute( books => { ':bookId' => { '*' => 'book' } }, ['GET'] );

Note that book() will be called for any path_info containing /books/<$bookid>/<$other> except if $other == 'pages'.

to manage /properties/p1, /properties/p2 with p1() and p2(), use:

  $self->addRoute( properties => [ 'p1', 'p2' ] );

defaultRoute($path)

This method defined which path_info to use if path_info is '/' or empty.

Accessors

See Lemonldap::NG::Common::PSGI for inherited accessors (error, languages, logLevel, staticPrefix, templateDir, links, syslog).