Sympa::Request::Handler(3Sympa)

πŸ’– Sympa::Request::Handler πŸ’–

okay so bestie, welcome to Sympa::Request::Handler(3Sympa) β€” yes that's the manual section, we're in the 3Sympa girlies πŸ’… β€” this is the base class energy, the mother of all request handler classes. sit down, hydrate, let's go πŸ“


✨ NAME ✨

Sympa::Request::Handler β€” the base class of request handler classes. it's giving blueprint, it's giving "everybody else inherits from me" πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

here's the vibe, copy-paste blessed:

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;

literally that's it. that's the whole starter pack 🌸


🌈 DESCRIPTION 🌈

so Sympa::Request::Handler is the base class β€” meaning all its subclasses are the ones doing the actual work of processing an instance of Sympa::Request. it's the parent, the blueprint, the "you shall not pass unless you inherit from me" of it all. no cap πŸ’œ

πŸŽ€ Methods πŸŽ€

TBD.

(yeah bestie, it really just says TBD. the docs said "we'll get to it" and then never got to it. iconic honestly 😭)

🧚 Methods subclass should implement 🧚

these are the ones YOU gotta write. the homework. the assignments. the main character duties πŸ‘‘

  • _action_regexp ( ) β€” instance method, and it's mandatory if _action_scenario() returns a true value. it returns a regexp that matches the available scenario results. and listen β€” the i modifier is necessary, no skipping it, periodt.
  • _action_scenario ( ) β€” instance method, mandatory, no exceptions. it returns the name of the scenario used to authorize the request under the given context. and if authorization isn't required? it returns undef. that's the escape hatch, slay.
  • _context_class ( ) β€” instance method. returns the class name of the context under which the request will be executed β€” like Sympa::List etc. but by default? it returns the robot context. just so you know 🫢
  • _owner_action ( ) β€” instance method. returns the name of the action to be stored in spool when the scenario returns "owner". default is "undef" β€” nothing, nada, the void ✨
  • _twist ( $request ) β€” instance method, mandatory, the big one. see "_twist" in Sympa::Spindle for the deets.

πŸ‘€ SEE ALSO πŸ‘€

go bother these when you're done here, they're all connected fr fr:

  • Sympa::Request
  • Sympa::Spindle

πŸ“œ HISTORY πŸ“œ

Sympa::Request::Handler appeared on Sympa 6.2.15. she's been around. she's seen things. a legend πŸ’–


and that's the whole page bestie!! this was pulled fresh outta sympa 6.2.80, dated 2026-10-19 β€” so yeah, shoutout to the source + version + date for keeping it real, and shoutout to you for reading all the way through πŸŽ€ mwah, go implement those mandatory methods, i believe in you πŸ¦‹βœ¨πŸ’œ

πŸ“¦ where this page comes from