.\" -*- 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::Internals 3"
.TH CPANPLUS::Internals 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::Internals \- CPANPLUS internals
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    my $internals   = CPANPLUS::Internals\->_init( _conf => $conf );
\&    my $backend     = CPANPLUS::Internals\->_retrieve_id( $ID );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is the guts of CPANPLUS \-\- it inherits from all other
modules in the CPANPLUS::Internals::* namespace, thus defying normal
rules of OO programming \-\- but if you're reading this, you already
know what's going on ;)
.PP
Please read the \f(CW\*(C`CPANPLUS::Backend\*(C'\fR documentation for the normal API.
.SH ACCESSORS
.IX Header "ACCESSORS"
.IP _conf 4
.IX Item "_conf"
Get/set the configure object
.IP _id 4
.IX Item "_id"
Get/set the id
.SH METHODS
.IX Header "METHODS"
.ie n .SS "$internals = CPANPLUS::Internals\->_init( _conf => CONFIG_OBJ )"
.el .SS "\f(CW$internals\fP = CPANPLUS::Internals\->_init( _conf => CONFIG_OBJ )"
.IX Subsection "$internals = CPANPLUS::Internals->_init( _conf => CONFIG_OBJ )"
\&\f(CW\*(C`_init\*(C'\fR creates a new CPANPLUS::Internals object.
.PP
You have to pass it a valid \f(CW\*(C`CPANPLUS::Configure\*(C'\fR object.
.PP
Returns the object on success, or dies on failure.
.ie n .SS "$bool = $internals\->_flush( list => \e@caches )"
.el .SS "\f(CW$bool\fP = \f(CW$internals\fP\->_flush( list => \e@caches )"
.IX Subsection "$bool = $internals->_flush( list => @caches )"
Flushes the designated caches from the \f(CW\*(C`CPANPLUS\*(C'\fR object.
.PP
Returns true on success, false if one or more caches could not be
be flushed.
.ie n .SS "$bool = $internals\->_register_callback( name => CALLBACK_NAME, code => CODEREF );"
.el .SS "\f(CW$bool\fP = \f(CW$internals\fP\->_register_callback( name => CALLBACK_NAME, code => CODEREF );"
.IX Subsection "$bool = $internals->_register_callback( name => CALLBACK_NAME, code => CODEREF );"
Registers a callback for later use by the internal libraries.
.PP
Here is a list of the currently used callbacks:
.IP install_prerequisite 4
.IX Item "install_prerequisite"
Is called when the user wants to be \f(CW\*(C`asked\*(C'\fR about what to do with
prerequisites. Should return a boolean indicating true to install
the prerequisite and false to skip it.
.IP send_test_report 4
.IX Item "send_test_report"
Is called when the user should be prompted if he wishes to send the
test report. Should return a boolean indicating true to send the
test report and false to skip it.
.IP munge_test_report 4
.IX Item "munge_test_report"
Is called when the test report message has been composed, giving
the user a chance to programmatically alter it. Should return the
(munged) message to be sent.
.IP edit_test_report 4
.IX Item "edit_test_report"
Is called when the user should be prompted to edit test reports
about to be sent out by Test::Reporter. Should return a boolean
indicating true to edit the test report in an editor and false
to skip it.
.IP proceed_on_test_failure 4
.IX Item "proceed_on_test_failure"
Is called when 'make test' or 'Build test' fails. Should return
a boolean indicating whether the install should continue even if
the test failed.
.IP munge_dist_metafile 4
.IX Item "munge_dist_metafile"
Is called when the \f(CW\*(C`CPANPLUS::Dist::*\*(C'\fR metafile is created, like
\&\f(CW\*(C`control\*(C'\fR for \f(CW\*(C`CPANPLUS::Dist::Deb\*(C'\fR, giving the user a chance to
programmatically alter it. Should return the (munged) text to be
written to the metafile.
.ie n .SS "$bool = $internals\->_add_to_includepath( directories => \e@dirs )"
.el .SS "\f(CW$bool\fP = \f(CW$internals\fP\->_add_to_includepath( directories => \e@dirs )"
.IX Subsection "$bool = $internals->_add_to_includepath( directories => @dirs )"
Adds a list of directories to the include path.
This means they get added to \f(CW@INC\fR as well as \f(CW$ENV{PERL5LIB}\fR.
.PP
Returns true on success, false on failure.
.ie n .SS "$bool = $internals\->_add_to_path( directories => \e@dirs )"
.el .SS "\f(CW$bool\fP = \f(CW$internals\fP\->_add_to_path( directories => \e@dirs )"
.IX Subsection "$bool = $internals->_add_to_path( directories => @dirs )"
Adds a list of directories to the PATH, but only if they actually
contain anything.
.PP
Returns true on success, false on failure.
.ie n .SS "$id = CPANPLUS::Internals\->_last_id"
.el .SS "\f(CW$id\fP = CPANPLUS::Internals\->_last_id"
.IX Subsection "$id = CPANPLUS::Internals->_last_id"
Return the id of the last object stored.
.ie n .SS "$id = CPANPLUS::Internals\->_store_id( $internals )"
.el .SS "\f(CW$id\fP = CPANPLUS::Internals\->_store_id( \f(CW$internals\fP )"
.IX Subsection "$id = CPANPLUS::Internals->_store_id( $internals )"
Store this object; return its id.
.ie n .SS "$obj = CPANPLUS::Internals\->_retrieve_id( $ID )"
.el .SS "\f(CW$obj\fP = CPANPLUS::Internals\->_retrieve_id( \f(CW$ID\fP )"
.IX Subsection "$obj = CPANPLUS::Internals->_retrieve_id( $ID )"
Retrieve an object based on its ID \-\- return false on error.
.ie n .SS "CPANPLUS::Internals\->_remove_id( $ID )"
.el .SS "CPANPLUS::Internals\->_remove_id( \f(CW$ID\fP )"
.IX Subsection "CPANPLUS::Internals->_remove_id( $ID )"
Remove the object marked by \f(CW$ID\fR from storage.
.ie n .SS "@objs = CPANPLUS::Internals\->_return_all_objects"
.el .SS "\f(CW@objs\fP = CPANPLUS::Internals\->_return_all_objects"
.IX Subsection "@objs = CPANPLUS::Internals->_return_all_objects"
Return all stored objects.