.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Plugin::HeaderCondition 3pm"
.TH Mojolicious::Plugin::HeaderCondition 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mojolicious::Plugin::HeaderCondition \- Header condition plugin
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  # Mojolicious
\&  $app\->plugin(\*(AqHeaderCondition\*(Aq);
\&  $app\->routes\->get(\*(Aq/foo\*(Aq)\->requires(headers => {Referer => qr/example\e.com/});
\&
\&  # Mojolicious::Lite
\&  plugin \*(AqHeaderCondition\*(Aq;
\&  get \*(Aq/\*(Aq => (headers => {Referer => qr/example\e.com/}) => sub {...};
\&
\&  # All headers need to match
\&  $app\->routes\->get(\*(Aq/foo\*(Aq)\->requires(headers => {
\&    \*(AqX\-Secret\-Header\*(Aq => \*(AqFoo\*(Aq,
\&    Referer => qr/example\e.com/
\&  });
\&
\&  # The "agent" condition is a shortcut for the "User\-Agent" header
\&  get \*(Aq/\*(Aq => (agent => qr/Firefox/) => sub {...};
\&
\&  # The "host" condition is a shortcut for the detected host
\&  get \*(Aq/\*(Aq => (host => qr/mojolicious\e.org/) => sub {...};
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Mojolicious::Plugin::HeaderCondition is a route condition for header-based routes.
.PP
This is a core plugin, that means it is always enabled and its code a good example for learning to build new plugins,
you're welcome to fork it.
.PP
See "PLUGINS" in Mojolicious::Plugins for a list of plugins that are available by default.
.SH METHODS
.IX Header "METHODS"
Mojolicious::Plugin::HeaderCondition inherits all methods from Mojolicious::Plugin and implements the following
new ones.
.SS register
.IX Subsection "register"
.Vb 1
\&  $plugin\->register(Mojolicious\->new);
.Ve
.PP
Register conditions in Mojolicious application.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.