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

FreeBSD Manual Pages

  
 
  

home | help
Catalyst::ActionRole::UsermContributed Perl DocCatalyst::ActionRole::Scheme(3)

NAME
       Catalyst::ActionRole::Scheme - Match on HTTP Request Scheme

SYNOPSIS
	   package MyApp::Web::Controller::MyController;

	   use base 'Catalyst::Controller';

	   sub is_http :Path(scheme) Scheme(http) Args(0) {
	     my	($self,	$c) = @_;
	     Test::More::is $c->action->scheme,	'http';
	     $c->response->body("is_http");
	   }

	   sub is_https	:Path(scheme) Scheme(https) Args(0)  {
	     my	($self,	$c) = @_;
	     Test::More::is $c->action->scheme,	'https';
	     $c->response->body("is_https");
	   }

	   1;

DESCRIPTION
       This is an action role that lets	your Catalyst::Action match on the
       scheme type of the request.  Typically this is "http" or	"https"	but
       other common schemes that Catalyst can handle include "ws" and "wss"
       (web socket and web socket secure).

       This also ensures that if you use "uri_for" on an action	that specifies
       a match scheme, that the	generated URI object sets its scheme to	that
       automatically (rather than the scheme of	the current request object,
       which is	and remains the	default	behavior.)

       For matching purposes, we match strings but the casing is insensitive.

REQUIRES
       This role requires the following	methods	in the consuming class.

   match
   match_captures
       Returns 1 if the	action matches the existing request and	zero if	not.

METHODS
       This role defines the following methods

   match
   match_captures
       Around method modifier that return 1 if the scheme matches

   list_extra_info
       Add the scheme declaration if present to	the debug screen.

AUTHORS
       Catalyst	Contributors, see Catalyst

COPYRIGHT
       See Catalyst

perl v5.32.1			  2020-07-26   Catalyst::ActionRole::Scheme(3)

NAME | SYNOPSIS | DESCRIPTION | REQUIRES | METHODS | AUTHORS | COPYRIGHT

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

home | help