path::dispatcher::rule::under(3pm) [debian man page]

Path::Dispatcher::Rule::Under(3pm)			User Contributed Perl Documentation			Path::Dispatcher::Rule::Under(3pm)

NAME

       Path::Dispatcher::Rule::Under - rules under a predicate

SYNOPSIS

	   my $ticket = Path::Dispatcher::Rule::Tokens->new(
	       tokens => [ 'ticket' ],
	       prefix => 1,
	   );

	   my $create = Path::Dispatcher::Rule::Tokens->new(
	       tokens => [ 'create' ],
	       block  => sub { create_ticket() },
	   );

	   my $delete = Path::Dispatcher::Rule::Tokens->new(
	       tokens => [ 'delete', qr/^d+$/ ],
	       block  => sub { delete_ticket(shift->pos(2)) },
	   );

	   my $rule = Path::Dispatcher::Rule::Under->new(
	       predicate => $ticket,
	       rules	 => [ $create, $delete ],
	   );

	   $rule->match("ticket create");
	   $rule->match("ticket delete 3");

DESCRIPTION

       Rules of this class have two-phase matching: if the predicate is matched, then the contained rules are matched. The benefit of this is less
       repetition of the predicate, both in terms of code and in matching it.

ATTRIBUTES

   predicate
       A rule (which must match prefixes) whose match determines whether the contained rules are considered. The leftover path of the predicate is
       used as the path for the contained rules.

   rules
       A list of rules that will be try to be matched only if the predicate is matched.

perl v5.12.4							    2011-08-30					Path::Dispatcher::Rule::Under(3pm)

Path::Dispatcher::Match(3pm)				User Contributed Perl Documentation			      Path::Dispatcher::Match(3pm)

NAME

       Path::Dispatcher::Match - the result of a successful rule match

SYNOPSIS

	   my $rule = Path::Dispatcher::Rule::Tokens->new(
	       tokens => [ 'attack', qr/^w+$/ ],
	       block  => sub {
		   my $match = shift;
		   attack($match->pos(2))
	       },
	   );

	   my $match = $rule->match("attack dragon");

	   # introspection
	   $match->path 	       # "attack dragon"
	   $match->leftover	       # empty string (populated with prefix rules)
	   $match->rule 	       # $rule
	   $match->positional_captures # ["attack", "dragon"] (decided by the rule)
	   $match->pos(1)	       # "attack"
	   $match->pos(2)	       # "dragon"

	   $match->run		       # attack("dragon")

DESCRIPTION

       If a Path::Dispatcher::Rule successfully matches a path, it creates one or more "Path::Dispatcher::Match" objects.

ATTRIBUTES

   rule
       The Path::Dispatcher::Rule that created this match.

   path
       The path that the rule matched.

   leftover
       The rest of the path. This is populated when the rule matches a prefix of the path.

   positional_captures
       Any positional captures generated by the rule. For example, Path::Dispatcher::Rule::Regex populates this with the capture variables.

   named_captures
       Any named captures generated by the rule. For example, Path::Dispatcher::Rule::Regex populates this with named captures.

   parent
       The parent match object, if applicable (which may be set if this match is the child of, for exampl, a Path::Dispatcher::Rule::Under prefix)

METHODS

   run
       Executes the rule's codeblock with the same arguments.

   pos($i)
       Returns the $ith positional capture, 1-indexed.

perl v5.12.4							    2011-08-30					      Path::Dispatcher::Match(3pm)