NAME
Mojolicious::Routes::Pattern - Routes pattern engine
SYNOPSIS
use Mojolicious::Routes::Pattern;
# Create pattern
my $pattern = Mojolicious::Routes::Pattern->new('/test/:name');
# Match routes
my $result = $pattern->match('/test/sebastian');
say $result->{name};DESCRIPTION
Mojolicious::Routes::Pattern is the core of Mojolicious::Routes.
ATTRIBUTES
Mojolicious::Routes::Pattern implements the following attributes.
defaults
my $defaults = $pattern->defaults;
$pattern = $pattern->defaults({foo => 'bar'});Default parameters.
format
my $regex = $pattern->format;
$pattern = $pattern->format($regex);Compiled regex for format matching.
pattern
my $pattern = $pattern->pattern;
$pattern = $pattern->pattern('/(foo)/(bar)');Raw unparsed pattern.
quote_end
my $quote = $pattern->quote_end;
$pattern = $pattern->quote_end(']');Character indicating the end of a quoted placeholder, defaults to ).
quote_start
my $quote = $pattern->quote_start;
$pattern = $pattern->quote_start('[');Character indicating the start of a quoted placeholder, defaults to (.
regex
my $regex = $pattern->regex;
$pattern = $pattern->regex($regex);Pattern in compiled regex form.
relaxed_start
my $relaxed = $pattern->relaxed_start;
$pattern = $pattern->relaxed_start('*');Character indicating a relaxed placeholder, defaults to #.
reqs
my $reqs = $pattern->reqs;
$pattern = $pattern->reqs({foo => qr/\w+/});Regex constraints.
symbol_start
my $symbol = $pattern->symbol_start;
$pattern = $pattern->symbol_start(':');Character indicating a placeholder, defaults to :.
symbols
my $symbols = $pattern->symbols;
$pattern = $pattern->symbols(['foo', 'bar']);Placeholder names.
tree
my $tree = $pattern->tree;
$pattern = $pattern->tree([ ... ]);Pattern in parsed form.
wildcard_start
my $wildcard = $pattern->wildcard_start;
$pattern = $pattern->wildcard_start('*');Character indicating the start of a wildcard placeholder, defaults to *.
METHODS
Mojolicious::Routes::Pattern inherits all methods from Mojo::Base and implements the following ones.
new
my $pattern = Mojolicious::Routes::Pattern->new('/:action');
my $pattern
= Mojolicious::Routes::Pattern->new('/:action', action => qr/\w+/);
my $pattern = Mojolicious::Routes::Pattern->new(format => 0);Construct a new pattern object.
match
my $result = $pattern->match('/foo/bar');
my $result = $pattern->match('/foo/bar', 1);Match pattern against entire path, format detection is disabled by default.
parse
$pattern = $pattern->parse('/:action');
$pattern = $pattern->parse('/:action', action => qr/\w+/);
$pattern = $pattern->parse(format => 0);Parse a raw pattern.
render
my $path = $pattern->render({action => 'foo'});
my $path = $pattern->render({action => 'foo'}, 1);Render pattern into a path with parameters, format rendering is disabled by default.
shape_match
my $result = $pattern->shape_match(\$path);
my $result = $pattern->shape_match(\$path, 1);Match pattern against path and remove matching parts, format detection is disabled by default.