Codex

Sub::Install

Section: User Contributed Perl Documentation (3pm)

Updated: 2014-06-26

Index?action=index Return to Main Contents


NAME

Sub::Install - install subroutines into packages easily

VERSION

version 0.928

SYNOPSIS

DESCRIPTION

This module makes it easy to install subroutines into packages without the unsightly mess of or typeglobs lying about where just anyone can see them.

FUNCTIONS

install_sub

This routine installs a given code reference into a package as a normal subroutine. The above is equivalent to:

If is not given, the sub is installed into the calling package.
If is not a code reference, it is looked for as an existing sub in the package named in the parameter. If is not given, it will look in the calling package.
If is not given, and if is a name, will default to . If is not given, but if is a code ref, Sub::Install will try to find the name of the given code ref and use that as .

That means that this code:

is the same as:

reinstall_sub

This routine behaves exactly like , but does not emit a warning if warnings are on and the destination is already defined.

install_installers

This routine is provided to allow Sub::Install compatibility with Sub::Installer. It installs and methods into the package named by its argument.
The installed installers are similar, but not identical, to those provided by Sub::Installer. They accept a single hash as an argument. The key/value pairs are used as the and parameters to the routine detailed above. The package name on which the method is called is used as the parameter.
Unlike Sub::Installer's will not eval strings into code, but will look for named code in the calling package.

EXPORTS

Sub::Install exports and only if they are requested.

exporter

Sub::Install has a never-exported subroutine called , which is used to implement its routine. It takes a hashref of named arguments, only one of which is currently recognize: . This must be an arrayref of subroutines to offer for export.

This routine is mainly for Sub::Install's own consumption. Instead, consider Sub::Exporter.

SEE ALSO

Sub
:Installer:This module is (obviously) a reaction to Damian Conway's Sub::Installer, which does the same thing, but does it by getting its greasy fingers all over UNIVERSAL. I was really happy about the idea of making the installation of coderefs less ugly, but I couldn't bring myself to replace the ugliness of typeglobs and loosened strictures with the ugliness of UNIVERSAL methods.:
Sub
:Exporter:This is a complete Exporter.pm replacement, built atop Sub::Install.:

EXTRA CREDITS

Several of the tests are adapted from tests that shipped with Damian Conway's Sub-Installer distribution.

AUTHOR

Ricardo SIGNES <[email protected]>

COPYRIGHT AND LICENSE

This software is copyright (c) 2005 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.


Index

NAME

VERSION

SYNOPSIS

DESCRIPTION

FUNCTIONS

install_sub

reinstall_sub

install_installers

EXPORTS

exporter

SEE ALSO

EXTRA CREDITS

AUTHOR

COPYRIGHT AND LICENSE