Curtis Jewell > Perl-Dist-WiX-1.500002 > Perl::Dist::WiX::Asset::File

Download:
Perl-Dist-WiX-1.500002.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  3
View/Report Bugs
Module Version: 1.500002   Source  

NAME ^

Perl::Dist::WiX::Asset::File - "Single File" asset for a Win32 Perl

VERSION ^

This document describes Perl::Dist::WiX::Asset::File version 1.500002.

SYNOPSIS ^

  my $binary = Perl::Dist::Asset::File->new(
      url        => 'http://host/path/file',
      install_to => 'perl/foo.txt',
  );

DESCRIPTION ^

Perl::Dist::Asset::File is a data class that provides encapsulation and error checking for a single file to be installed unmodified into a Perl::Dist::WiX-based Perl distribution.

It is normally created on the fly by the <Perl::Dist::WiX> install_file method (and other things that call it).

This asset exists to allow for cases where very small tweaks need to be done to distributions by dropping in specific single files.

The specification of the location to retrieve the package is done via the standard mechanism implemented in Perl::Dist::WiX::Role::Asset.

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::File object.

It inherits all the parameters described in the Perl::Dist::WiX::Role::Asset->new method documentation, and adds an additional parameter described below.

install_to

The install_to parameter is the location that the file needs installed to, relative to the distribution's image directory.

install

The install method installs the file described by the Perl::Dist::WiX::Asset::File object and returns true or throws an exception.

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>

SEE ALSO ^

Perl::Dist::WiX, Perl::Dist::WiX::Role::Asset

COPYRIGHT AND LICENSE ^

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.

syntax highlighting: