.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.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 "MooseX::AuthorizedMethods 3"
.TH MooseX::AuthorizedMethods 3 "2010-11-25" "perl v5.34.0" "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"
MooseX::AuthorizedMethods \- Syntax sugar for authorized methods
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package Foo::Bar;
\&  use MooseX::AuthorizedMethods; # includes Moose
\&  
\&  has user => (is => \*(Aqro\*(Aq);
\&  
\&  authorized foo => [\*(Aqfoo\*(Aq], sub {
\&     # this is going to happen only if the user has the \*(Aqfoo\*(Aq role
\&  };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This method exports the \*(L"authorized\*(R" declarator that makes a
verification if the user has the required permissions before the acual
invocation. The default verification method will take the \*(L"user\*(R"
method result and call \*(L"roles\*(R" to list the roles given to that user.
.SH "DECLARATOR"
.IX Header "DECLARATOR"
.ie n .IP "authorized $name => [qw(required permissions)], $code" 4
.el .IP "authorized \f(CW$name\fR => [qw(required permissions)], \f(CW$code\fR" 4
.IX Item "authorized $name => [qw(required permissions)], $code"
This declarator will use the default verifier to check if the user has
one of the given roles, it will die otherwise.
.SH "CUSTOM VERIFIERS"
.IX Header "CUSTOM VERIFIERS"
The default verifier used is
MooseX::Meta::Method::Authorized::CheckRoles, you might send an
additional \*(L"verifier\*(R" option to the declarator with another object or
class. A verifier is simply a duck type with the \*(L"authorized_do\*(R"
method that is called as:
.PP
.Vb 1
\&  $verifier\->authorized_do($method, $code, @_)
.Ve
.PP
It is expected that the verifier code die if the user doesn't fulfill
the authorization requests.
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel Ruoso <daniel@ruoso.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010 by Daniel Ruoso et al
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.