/ 
Perl-Dist-WiX-1.250
River stage one • 1 direct dependent • 1 total dependent
/ Perl::Dist::WiX::Fragment::Files

NAME

Perl::Dist::WiX::Fragment::Files - A <Fragment> with file handling.

VERSION

This document describes Perl::Dist::WiX::Fragment::Files version 1.250.

SYNOPSIS

my $fragment = Perl::Dist::WiX::Fragment::Files->new(
	id              => 'perl',
	files           => $perl_files_object, # File::List::Object object
	in_merge_module => 0,
	can_overwrite   => 0,
);

my $files_object = $fragment->get_files();

DESCRIPTION

This object defines an XML fragment that specifies files for the installer to include within itself and install on end-user systems.

Usually a fragment is one module, or a C library.

INTERFACE

METHODS

This class inherits from WiX3::XML::Fragment and shares its API.

new

The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::WiX::Fragment::Files object.

It inherits all the parameters described in the WiX3::XML::Fragment->new() method documentation, and adds the additional parameters described below.

can_overwrite

The optional can_overwrite parameter specifies whether files in this fragment will be overwritten by files in another fragment.

in_merge_module

The optional in_merge_module parameter specifies whether files in this fragment will be overwritten by files in another fragment.

files

The required files parameter is the list of files that are in the fragment.

get_files

Retrieves the list of files.

add_file, add_files

    $fragment->add_files(@files);
	$fragment->add_file($file);

Adds file(s) to the current fragment.

This must be done before Perl::Dist::WiX-regenerate_fragments()> is called.

find_file_id, find_file

$file_tag_id = $fragment_tag->find_file_id($file);

Finds the ID of the file tag for the filename passed in.

Returns undef if no file tag could be found.

This must be done before Perl::Dist::WiX-regenerate_fragments()> is called.

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

COPYRIGHT

Copyright 2009 - 2010 Curtis Jewell.

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.