Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Mojolicious::Routes::PUserrContributed Perl DocMojolicious::Routes::Pattern(3)

NAME
       Mojolicious::Routes::Pattern - Route pattern

SYNOPSIS
	 use Mojolicious::Routes::Pattern;

	 # Create pattern
	 my $pattern = Mojolicious::Routes::Pattern->new('/test/:name');

	 # Match routes
	 my $captures =	$pattern->match('/test/sebastian');
	 say $captures->{name};

DESCRIPTION
       Mojolicious::Routes::Pattern is the core	of Mojolicious::Routes.

ATTRIBUTES
       Mojolicious::Routes::Pattern implements the following attributes.

   constraints
	 my $constraints = $pattern->constraints;
	 $pattern	 = $pattern->constraints({foo => qr/\w+/});

       Regular expression constraints.

   defaults
	 my $defaults =	$pattern->defaults;
	 $pattern     =	$pattern->defaults({foo	=> 'bar'});

       Default parameters.

   placeholder_start
	 my $start = $pattern->placeholder_start;
	 $pattern  = $pattern->placeholder_start(':');

       Character indicating a placeholder, defaults to ":".

   placeholders
	 my $placeholders = $pattern->placeholders;
	 $pattern	  = $pattern->placeholders(['foo', 'bar']);

       Placeholder names.

   quote_end
	 my $end  = $pattern->quote_end;
	 $pattern = $pattern->quote_end('}');

       Character indicating the	end of a quoted	placeholder, defaults to ">".

   quote_start
	 my $start = $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 regular expression form.

   relaxed_start
	 my $start = $pattern->relaxed_start;
	 $pattern  = $pattern->relaxed_start('*');

       Character indicating a relaxed placeholder, defaults to "#".

   tree
	 my $tree = $pattern->tree;
	 $pattern = $pattern->tree([['text', '/foo']]);

       Pattern in parsed form. Note that this structure	should only be used
       very carefully since it is very dynamic.

   type_start
	 my $start = $pattern->type_start;
	 $pattern  = $pattern->type_start('|');

       Character indicating the	start of a placeholder type, defaults to ":".

   types
	 my $types = $pattern->types;
	 $pattern  = $pattern->types({int => qr/[0-9]+/});

       Placeholder types.

   unparsed
	 my $unparsed =	$pattern->unparsed;
	 $pattern     =	$pattern->unparsed('/:foo/:bar');

       Raw unparsed pattern.

   wildcard_start
	 my $start = $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	new ones.

   match
	 my $captures =	$pattern->match('/foo/bar');
	 my $captures =	$pattern->match('/foo/bar', 1);

       Match pattern against entire path, format detection is disabled by
       default.

   match_partial
	 my $captures =	$pattern->match_partial(\$path);
	 my $captures =	$pattern->match_partial(\$path,	1);

       Match pattern against path and remove matching parts, format detection
       is disabled by default.

   new
	 my $pattern = Mojolicious::Routes::Pattern->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 Mojolicious::Routes::Pattern object and "parse" pattern
       if necessary.

   parse
	 $pattern = $pattern->parse('/:action');
	 $pattern = $pattern->parse('/:action',	action => qr/\w+/);
	 $pattern = $pattern->parse(format => 0);

       Parse 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.

SEE ALSO
       Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.

perl v5.32.1			  2020-12-07   Mojolicious::Routes::Pattern(3)

NAME | SYNOPSIS | DESCRIPTION | ATTRIBUTES | METHODS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Mojolicious::Routes::Pattern&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help