NAME
Perl::Dist::WiX::Role::Asset - Role for assets.
VERSION
This document describes Perl::Dist::WiX::Role::Asset version 1.500002.
SYNOPSIS
# Since this is a role, it is composed into classes that use it.
# It is not used independently.DESCRIPTION
Perl::Dist::WiX::Role::Asset is a role that provides methods, attributes, and error checking for assets to be installed in a Perl::Dist::WiX-based Perl distribution.
ATTRIBUTES
Attributes of this role also become parameters to the new() constructor for classes that use this role.
parent
This is the Perl::Dist::WiX object that uses an asset object that uses this role. The Perl::Dist::WiX object handles a number of private methods for the asset object.
It is required, and has no default, so an error will be thrown if it is not given.
url
This attribute is the location on the Internet of the thing the asset installs.
Either the 'url' or 'file' parameters are required.
file
This attribute is the location of the file the asset installs. This could be an archive containing multiple files to install.
Either the 'url' or 'file' parameters are required.
packlist_location
Some distributions create their packlist in an odd location (one not specified by the main module in the distribution.)
This optional parameter specifies the directory the packlist is in as a relative directory to image_dir() . "/install location/lib/author".
METHODS
install
This role requires that classes that use it implement an install method that installs the asset.
It does not provide the method itself, but makes classes that use the role implement the method based on their needs.
remove_path
The remove_path method is for the convienence of assets that need it.
It removes the path specified, and can take any object (e.g., a Path::Class::Dir) that stringifies to a name of a directory to remove.
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
COPYRIGHT AND LICENSE
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.