.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Apache2::SiteControl::Rule 3pm"
.TH Apache2::SiteControl::Rule 3pm "2018-08-31" "perl v5.26.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"
Apache2::SiteControl::Rule \- Permission manager access rule.
.SS "\s-1DESCRIPTION\s0"
.IX Subsection "DESCRIPTION"
Each rule is a custom-written class that implements some aspect of your site's
access logic. Rules can choose to grant or deny a request.
.PP
.Vb 1
\&   package sample::Test;
\&
\&   use strict;
\&   use warnings;
\&   use Carp;
\&   use Apache2::SiteControl::Rule;
\&
\&   use base qw(Apache2::SiteControl::Rule);
\&
\&   sub grants($$$$)
\&   {
\&      my $this = shift;
\&      my $user = shift;
\&      my $action = shift;
\&      my $resource = shift;
\&
\&      if($action eq "edit" && $resource\->isa("sample::Record")) {
\&         return 1 if($user{name} eq "root");
\&      }
\&
\&      return 0;
\&   }
\&
\&   sub denies($$$$)
\&   {
\&      return 0;
\&   }
\&
\&   1;
.Ve
.PP
The PermissionManager will only give permission if \fIat least\fR one rule grants
permission, \fIand no\fR rule denies it.
.PP
It is important that your rules never grant or deny a request they do not
understand, so it is a good idea to use type checking to prevent strangeness.
\&\fBAssertions should not be used\fR if you expect different rules to accept
different resource types or user types, since each rule is used on every access
request.
.SH "EXPORT"
.IX Header "EXPORT"
None by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Apache2::SiteControl::UserFactory, Apache::SiteControl::ManagerFactory,
Apache2::SiteControl::PermissionManager, Apache::SiteControl
.SH "AUTHOR"
.IX Header "AUTHOR"
This module was written by Tony Kay, <tkay@uoregon.edu>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"