.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Object::AUTHORITY 3pm"
.TH Object::AUTHORITY 3pm "2011-12-15" "perl v5.14.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"
Object::AUTHORITY \- adds an AUTHORITY method to your class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\& {
\&   package MyClass;
\&   use Object::AUTHORITY;
\&   BEGIN {
\&     $MyClass::AUTHORITY = \*(Aqcpan:TOBYINK\*(Aq;
\&     $MyClass::VERSION   = \*(Aq0.001\*(Aq;
\&   }
\& }
\& 
\& print MyClass\->AUTHORITY . "\en";   # prints "cpan:TOBYINK\en";
\& MyClass\->AUTHORITY(\*(Aqcpan:FOO\*(Aq);    # assertion fails, croaks.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module adds an \f(CW\*(C`AUTHORITY\*(C'\fR function to your package, which works along
the same lines as the \f(CW\*(C`VERSION\*(C'\fR function.
.PP
The authority of a package can be defined like this:
.PP
.Vb 2
\& package MyApp;
\& BEGIN { $MyApp::AUTHORITY = \*(Aqcpan:JOEBLOGGS\*(Aq; }
.Ve
.PP
The authority should be a \s-1URI\s0 identifying the person, team, organisation
or trained chimp responsible for the release of the package. The
pseudo-URI scheme \f(CW\*(C`cpan:\*(C'\fR is the most commonly used identifier.
.ie n .SS """AUTHORITY"""
.el .SS "\f(CWAUTHORITY\fP"
.IX Subsection "AUTHORITY"
Called with no parameters returns the authority of the module.
.ie n .SS """AUTHORITY($test)"""
.el .SS "\f(CWAUTHORITY($test)\fP"
.IX Subsection "AUTHORITY($test)"
If passed a test, will croak if the test fails. The authority is tested
against the test using something approximating Perl 5.10's smart match
operator. (Briefly, you can pass a string for \f(CW\*(C`eq\*(C'\fR comparison, a regular
expression, a code reference to use as a callback, or an array reference
that will be grepped.)
.SS "Utility Function"
.IX Subsection "Utility Function"
.ie n .IP """Object::AUTHORITY::reasonably_smart_match($a, $b)""" 4
.el .IP "\f(CWObject::AUTHORITY::reasonably_smart_match($a, $b)\fR" 4
.IX Item "Object::AUTHORITY::reasonably_smart_match($a, $b)"
Object::AUTHORITY exposes its smart match implementation in case
classes wish to reuse it for their own custom \f(CW\*(C`AUTHORITY\*(C'\fR methods. (There
are various interesting use cases for custom \f(CW\*(C`AUTHORITY\*(C'\fR methods, just as
there are for custom \f(CW\*(C`can\*(C'\fR and \f(CW\*(C`isa\*(C'\fR methods.)
.Sp
The \f(CW$a\fR parameter is always assumed to be a simple scalar.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to
http://rt.cpan.org/Dist/Display.html?Queue=Object\-AUTHORITY <http://rt.cpan.org/Dist/Display.html?Queue=Object-AUTHORITY>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
\&\fIObject::AUTHORITY\fR (this module) \- an \s-1AUTHORITY\s0 method for your class
.IP "\(bu" 4
authority::shared \- a more sophisticated \s-1AUTHORITY\s0 method for your class
.IP "\(bu" 4
\&\s-1UNIVERSAL::AUTHORITY\s0 \- an \s-1AUTHORITY\s0 method for every class (deprecated)
.IP "\(bu" 4
UNIVERSAL::AUTHORITY::Lexical \- an \s-1AUTHORITY\s0 method for every class, within a lexical scope
.IP "\(bu" 4
authority \- load modules only if they have a particular authority
.PP
Background reading: <http://feather.perl6.nl/syn/S11.html>,
<http://www.perlmonks.org/?node_id=694377>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2011 by Toby Inkster.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
\&\s-1THIS\s0 \s-1PACKAGE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1AND\s0 \s-1WITHOUT\s0 \s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0
\&\s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1WITHOUT\s0 \s-1LIMITATION\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0
\&\s-1MERCHANTIBILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.