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

FreeBSD Manual Pages

  
 
  

home | help
Sympa::Request::Handler(3Sympa)	 sympa 6.2.16  Sympa::Request::Handler(3Sympa)

NAME
       Sympa::Request::Handler - Base class of request handler classes

SYNOPSYS
	 package Sympa::Request::Handler::foo;
	 use base qw(Sympa::Request::Handler);

	 use constant _action_regexp   => qr{reject|request_auth|do_it}i;
	 use constant _action_scenario => 'review';
	 use constant _context_class   => 'Sympa::List';

	 sub _twist {
	     ...
	 }

	 1;

DESCRIPTION
       Sympa::Request::Handler is the base class of subclasses to process
       instance	of Sympa::Request.

   Methods
       TBD.

   Methods subclass should implement
       _action_regexp (	)
	   Instance method, mandatory if _action_scenario() returns true
	   value.  Returns a regexp matching available scenario	results.  Note
	   that	"i" modifier is	necessary.

       _action_scenario	( )
	   Instance method, mandatory.	Returns	the name of scenario to
	   authorize the request under given context.  If authorization	is not
	   required, returns "undef".

       _context_class (	)
	   Instance method.  Returns the class name of context under which the
	   request will	be executed, Sympa::List etc.  By default, returns
	   robot context.

       _owner_action ( )
	   Instance method.  Returns name of action to be stored in spool when
	   scenario returns "owner".  By default, returns "undef".

       _twist (	$request )
	   Instance method, mandatory.	See "_twist" in	Sympa::Spindle.

SEE ALSO
       Sympa::Request, Sympa::Spindle.

HISTORY
       Sympa::Request::Handler appeared	on Sympa 6.2.15.

6.2.16				  2016-03-31   Sympa::Request::Handler(3Sympa)

NAME | SYNOPSYS | DESCRIPTION | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Sympa::Request::Handler&sektion=3sympa&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help