NAME
Perl::Dist::WiX::Asset::Module - Module asset for a Win32 Perl
VERSION
This document describes Perl::Dist::WiX::Asset::Module version 1.200.
SYNOPSIS
my $distribution = Perl::Dist::WiX::Asset::Module->new(
parent => $dist,
name => 'DBI',
force => 0,
assume_installed => 0,
);
$distribution->install();DESCRIPTION
This asset installs a module from CPAN.
METHODS
This class is a Perl::Dist::WiX::Role::Asset and shares its API.
new
The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::WiX::Asset::Module object, or throws an exception on error.
It inherits all the parameters described in the Perl::Dist::WiX::Role::Asset->new() method documentation, and adds some additional parameters.
name
The required name param is the name of the module to be installed.
force
The optional boolean force param allows you to specify that the tests should be skipped and the module installed without validating its installation.
This can be set to true when there are test bugs that cause failing tests, or where true testing would be too difficult (for example, when a database connection is required.)
This defaults to the force() attribute of the Perl::Dist::WiX parent object.
packlist
This tells the install() routine whether it has a packlist that can be found once the module is installed or not.
This parameter defaults to true.
assume_installed
Some distributions (Bio::Perl, for example) do not include their version numbers in such a way that CPAN can tell whether they are up to date after installation via the CPAN::Module->uptodate() call.
This parameter, when set to 1, tells Perl::Dist::WiX to skip that verification step.
install
The install method installs the module described by the Perl::Dist::WiX::Asset::Module object and returns the files that were installed as a File::List::Object object.
SUPPORT
Bugs should be reported via the CPAN bug tracker at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Dist-WiX
For other issues, contact the author.
AUTHOR
Curtis Jewell <csjewell@cpan.org>
Adam Kennedy <adamk@cpan.org>
SEE ALSO
Perl::Dist::WiX, Perl::Dist::WiX::Role::Asset
COPYRIGHT
Copyright 2009 - 2010 Curtis Jewell.
Copyright 2007 - 2009 Adam Kennedy.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.