.\" -*- 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 "CPANPLUS::Module::Author 3"
.TH CPANPLUS::Module::Author 3 2023-07-25 "perl v5.38.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
CPANPLUS::Module::Author \- CPAN author object for CPANPLUS
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\&    my $author = CPANPLUS::Module::Author\->new(
\&                    author  => \*(AqJack Ashton\*(Aq,
\&                    cpanid  => \*(AqJACKASH\*(Aq,
\&                    _id     => INTERNALS_OBJECT_ID,
\&                );
\&
\&    $author\->cpanid;
\&    $author\->author;
\&    $author\->email;
\&
\&    @dists  = $author\->distributions;
\&    @mods   = $author\->modules;
\&
\&    @accessors = CPANPLUS::Module::Author\->accessors;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`CPANPLUS::Module::Author\*(C'\fR creates objects from the information in the
source files. These can then be used to query on.
.PP
These objects should only be created internally. For \f(CW\*(C`fake\*(C'\fR objects,
there's the \f(CW\*(C`CPANPLUS::Module::Author::Fake\*(C'\fR class.
.SH ACCESSORS
.IX Header "ACCESSORS"
An objects of this class has the following accessors:
.IP author 4
.IX Item "author"
Name of the author.
.IP cpanid 4
.IX Item "cpanid"
The CPAN id of the author.
.IP email 4
.IX Item "email"
The email address of the author, which defaults to '' if not provided.
.IP parent 4
.IX Item "parent"
The \f(CW\*(C`CPANPLUS::Internals::Object\*(C'\fR that spawned this module object.
.SH METHODS
.IX Header "METHODS"
.ie n .SS "$auth = CPANPLUS::Module::Author\->new( author => AUTHOR_NAME, cpanid => CPAN_ID, _id => INTERNALS_ID [, email => AUTHOR_EMAIL] )"
.el .SS "\f(CW$auth\fP = CPANPLUS::Module::Author\->new( author => AUTHOR_NAME, cpanid => CPAN_ID, _id => INTERNALS_ID [, email => AUTHOR_EMAIL] )"
.IX Subsection "$auth = CPANPLUS::Module::Author->new( author => AUTHOR_NAME, cpanid => CPAN_ID, _id => INTERNALS_ID [, email => AUTHOR_EMAIL] )"
This method returns a \f(CW\*(C`CPANPLUS::Module::Author\*(C'\fR object, based on the given
parameters.
.PP
Returns false on failure.
.ie n .SS "@mod_objs = $auth\->\fBmodules()\fP"
.el .SS "\f(CW@mod_objs\fP = \f(CW$auth\fP\->\fBmodules()\fP"
.IX Subsection "@mod_objs = $auth->modules()"
Return a list of module objects this author has released.
.ie n .SS "@dists = $auth\->\fBdistributions()\fP"
.el .SS "\f(CW@dists\fP = \f(CW$auth\fP\->\fBdistributions()\fP"
.IX Subsection "@dists = $auth->distributions()"
Returns a list of module objects representing all the distributions
this author has released.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.SS "accessors ()"
.IX Subsection "accessors ()"
Returns a list of all accessor methods to the object