universal::exports(3pm) [debian man page]

UNIVERSAL::exports(3pm) 				User Contributed Perl Documentation				   UNIVERSAL::exports(3pm)

NAME

       UNIVERSAL::exports - Lightweight, universal exporting of variables

SYNOPSIS

	 package Foo;
	 use UNIVERSAL::exports;

	 # Just like Exporter.
	 @EXPORT       = qw($This &That);
	 @EXPORT_OK    = qw(@Left %Right);

	 # Meanwhile, in another piece of code!
	 package Bar;
	 use Foo;  # exports $This and &That.

DESCRIPTION

       This is an alternative to Exporter intended to provide a universal, lightweight subset of its functionality.  It uses Exporter::Lite, so
       look there for details.

       Additionally, "exports()" is provided to find out what symbols a module exports.

       UNIVERSAL::exports places its methods in the UNIVERSAL namespace, so there is no need to subclass from it.

Methods
       UNIVERSAL::exports has two public methods, import() derived from Exporter::Lite, and exports().

       import
	     Some::Module->import;
	     Some::Module->import(@symbols);

	   This is Exporter::Lite's import() method.  Look in Exporter::Lite for details.

       exports
	     @exported_symbols = Some::Module->exports;
	     Some::Module->exports($symbol);

	   Reports what symbols are exported by Some::Module.  With no arguments, it simply returns a list of all exportable symbols.  Otherwise,
	   it reports if it will export a given $symbol.

DIAGNOSTICS

       '"%s" is not exported by the %s module'
	   Attempted to import a symbol which is not in @EXPORT or @EXPORT_OK.

       'Can't export symbol: %s'
	   Attempted to import a symbol of an unknown type (ie. the leading $@% salad wasn't recognized).

AUTHORS

       Michael G Schwern <schwern@pobox.com>

BUGS and ISSUES
       Please report bugs and issues via <http://rt.cpan.org>

LICENSE and COPYRIGHT
       Copyright 2001, 2006 Michael G Schwern

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

       See <http://www.perl.com/perl/misc/Artistic.html>

SEE ALSO

       Other ways to Export: Exporter, Exporter::Lite, Sub::Exporter, Exporter::Simple

       The Perl 6 RFC that started it all:  <http://dev.perl.org/rfc/257.pod>

       More UNIVERSAL magic:  UNIVERSAL::require

perl v5.10.1							    2006-09-03						   UNIVERSAL::exports(3pm)

UNIVERSAL::require(3)					User Contributed Perl Documentation				     UNIVERSAL::require(3)

NAME

       UNIVERSAL::require - require() modules from a variable

SYNOPSIS

	 # This only needs to be said once in your program.
	 require UNIVERSAL::require;

	 # Same as "require Some::Module"
	 my $module = 'Some::Module';
	 $module->require or die $@;

	 # Same as "use Some::Module"
	 BEGIN { $module->use or die $@ }

DESCRIPTION

       If you've ever had to do this...

	   eval "require $module";

       to get around the bareword caveats on require(), this module is for you.  It creates a universal require() class method that will work with
       every Perl module and its secure.  So instead of doing some arcane eval() work, you can do this:

	   $module->require;

       It doesn't save you much typing, but it'll make alot more sense to someone who's not a ninth level Perl acolyte.

Methods
       require

	 my $return_val = $module->require	     or die $@;
	 my $return_val = $module->require($version) or die $@;

       This works exactly like Perl's require, except without the bareword restriction, and it doesn't die.  Since require() is placed in the
       UNIVERSAL namespace, it will work on any module.  You just have to use UNIVERSAL::require somewhere in your code.

       Should the module require fail, or not be a high enough $version, it will simply return false and not die.  The error will be in $@ as well
       as $UNIVERSAL::require::ERROR.

	   $module->require or die $@;

       use

	   my $require_return = $module->use	       or die $@;
	   my $require_return = $module->use(@imports) or die $@;

       Like "UNIVERSAL::require", this allows you to "use" a $module without having to eval to work around the bareword requirement.  It returns
       the same as require.

       Should either the require or the import fail it will return false.  The error will be in $@.

       If possible, call this inside a BEGIN block to emulate a normal "use" as closely as possible.

	   BEGIN { $module->use }

SECURITY NOTES

       UNIVERSAL::require makes use of "eval STRING".  In previous versions of UNIVERSAL::require it was discovered that one could craft a class
       name which would result in code being executed.	This hole has been closed.  The only variables now exposed to "eval STRING" are the
       caller's package, filename and line which are not tainted.

       UNIVERSAL::require is taint clean.

COPYRIGHT

       Copyright 2001, 2005 by Michael G Schwern <schwern@pobox.com>.

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

       See http://www.perl.com/perl/misc/Artistic.html

AUTHOR

       Michael G Schwern <schwern@pobox.com>

SEE ALSO

       Module::Load,  "require" in perlfunc, <http://dev.perl.org/rfc/253.pod>

perl v5.16.2							    2009-03-30						     UNIVERSAL::require(3)