cpanplus::internals::utils(3pm) [suse man page]
CPANPLUS::Internals::Utils(3pm) Perl Programmers Reference Guide CPANPLUS::Internals::Utils(3pm) NAME
CPANPLUS::Internals::Utils SYNOPSIS
my $bool = $cb->_mkdir( dir => 'blah' ); my $bool = $cb->_chdir( dir => 'blah' ); my $bool = $cb->_rmdir( dir => 'blah' ); my $bool = $cb->_move( from => '/some/file', to => '/other/file' ); my $bool = $cb->_move( from => '/some/dir', to => '/other/dir' ); my $cont = $cb->_get_file_contents( file => '/path/to/file' ); my $version = $cb->_perl_version( perl => $^X ); DESCRIPTION
"CPANPLUS::Internals::Utils" holds a few convenience functions for CPANPLUS libraries. METHODS
$cb->_mkdir( dir => '/some/dir' ) "_mkdir" creates a full path to a directory. Returns true on success, false on failure. $cb->_chdir( dir => '/some/dir' ) "_chdir" changes directory to a dir. Returns true on success, false on failure. $cb->_rmdir( dir => '/some/dir' ); Removes a directory completely, even if it is non-empty. Returns true on success, false on failure. $cb->_perl_version ( perl => 'some/perl/binary' ); "_perl_version" returns the version of a certain perl binary. It does this by actually running a command. Returns the perl version on success and false on failure. $cb->_version_to_number( version => $version ); Returns a proper module version, or '0.0' if none was available. $cb->_whoami Returns the name of the subroutine you're currently in. _get_file_contents( file => $file ); Returns the contents of a file Moves a file or directory to the target. Returns true on success, false on failure. Moves a file or directory to the target. Returns true on success, false on failure. $cb->_mode_plus_w( file => '/path/to/file' ); Sets the +w bit for the file. Returns true on success, false on failure. $uri = $cb->_host_to_uri( scheme => SCHEME, host => HOST, path => PATH ); Turns a CPANPLUS::Config style "host" entry into an URI string. Returns the uri on success, and false on failure $cb->_vcmp( VERSION, VERSION ); Normalizes the versions passed and does a '<=>' on them, returning the result. $cb->_home_dir Returns the user's homedir, or "cwd" if it could not be found $path = $cb->_safe_path( path => $path ); Returns a path that's safe to us on Win32 and VMS. Only cleans up the path on Win32 if the path exists. On VMS, it encodes dots to _ using "VMS::Filespec::vmsify" ($pkg, $version, $ext) = $cb->_split_package_string( package => PACKAGE_STRING ); Splits the name of a CPAN package string up into its package, version and extension parts. For example, "Foo-Bar-1.2.tar.gz" would return the following parts: Package: Foo-Bar Version: 1.2 Extension: tar.gz perl v5.12.1 2010-04-26 CPANPLUS::Internals::Utils(3pm)
Check Out this Related Man Page
CPANPLUS::Internals(3pm) Perl Programmers Reference Guide CPANPLUS::Internals(3pm) NAME
CPANPLUS::Internals - CPANPLUS internals SYNOPSIS
my $internals = CPANPLUS::Internals->_init( _conf => $conf ); my $backend = CPANPLUS::Internals->_retrieve_id( $ID ); 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 ;) Please read the "CPANPLUS::Backend" documentation for the normal API. ACCESSORS
_conf Get/set the configure object _id Get/set the id METHODS
$internals = CPANPLUS::Internals->_init( _conf => CONFIG_OBJ ) "_init" creates a new CPANPLUS::Internals object. You have to pass it a valid "CPANPLUS::Configure" object. Returns the object on success, or dies on failure. $bool = $internals->_flush( list => @caches ) Flushes the designated caches from the "CPANPLUS" object. Returns true on success, false if one or more caches could not be be flushed. $bool = $internals->_register_callback( name => CALLBACK_NAME, code => CODEREF ); Registers a callback for later use by the internal libraries. Here is a list of the currently used callbacks: install_prerequisite Is called when the user wants to be "asked" about what to do with prerequisites. Should return a boolean indicating true to install the prerequisite and false to skip it. 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. munge_test_report Is called when the test report message has been composed, giving the user a chance to programatically alter it. Should return the (munged) message to be sent. 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. 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. munge_dist_metafile Is called when the "CPANPLUS::Dist::*" metafile is created, like "control" for "CPANPLUS::Dist::Deb", giving the user a chance to programatically alter it. Should return the (munged) text to be written to the metafile. $bool = $internals->_add_to_includepath( directories => @dirs ) Adds a list of directories to the include path. This means they get added to @INC as well as $ENV{PERL5LIB}. Returns true on success, false on failure. $bool = $internals->_add_to_path( directories => @dirs ) Adds a list of directories to the PATH, but only if they actually contain anything. Returns true on success, false on failure. $id = CPANPLUS::Internals->_last_id Return the id of the last object stored. $id = CPANPLUS::Internals->_store_id( $internals ) Store this object; return its id. $obj = CPANPLUS::Internals->_retrieve_id( $ID ) Retrieve an object based on its ID -- return false on error. CPANPLUS::Internals->_remove_id( $ID ) Remove the object marked by $ID from storage. @objs = CPANPLUS::Internals->_return_all_objects Return all stored objects. perl v5.18.2 2014-01-06 CPANPLUS::Internals(3pm)