Exporter::Lite(3) lightweight exporting of functions and variables

SYNOPSIS


package Foo;
use Exporter::Lite;
our @EXPORT = qw($This That); # default exports
our @EXPORT_OK = qw(@Left %Right); # optional exports

Then in code using the module: 

  use Foo;
  # $This and &That are imported here

You have to explicitly ask for optional exports: 

 use Foo qw/ @Left %Right /;

DESCRIPTION

Exporter::Lite is an alternative to Exporter, intended to provide a lightweight subset of the most commonly-used functionality. It supports "import()", @EXPORT and @EXPORT_OK and not a whole lot else.

Unlike Exporter, it is not necessary to inherit from Exporter::Lite; Ie you don't need to write: 

 @ISA = qw(Exporter::Lite);

Exporter::Lite simply exports its import() function into your namespace. This might be called a ``mix-in'' or a ``role''.

Setting up a module to export its variables and functions is simple: 

    package My::Module;
    use Exporter::Lite;
    our @EXPORT = qw($Foo bar);

Functions and variables listed in the @EXPORT package variable are automatically exported if you use the module and don't explicitly list any imports. Now, when you "use My::Module", $Foo and "bar()" will show up.

Optional exports are listed in the @EXPORT_OK package variable: 

    package My::Module;
    use Exporter::Lite;
    our @EXPORT_OK = qw($Foo bar);

When My::Module is used, $Foo and "bar()" will not show up, unless you explicitly ask for them: 

    use My::Module qw($Foo bar);

Note that when you specify one or more functions or variables to import, then you must also explicitly list any of the default symbols you want to use. So if you have an exporting module: 

    package Games;
    our @EXPORT    = qw/ pacman defender  /;
    our @EXPORT_OK = qw/ galaga centipede /;

Then if you want to use both "pacman" and "galaga", then you'd write: 

    use Games qw/ pacman galaga /;

Methods

Export::Lite has one public method, import(), which is called automatically when your modules is use()'d.

In normal usage you don't have to worry about this at all.

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

Works just like "Exporter::import()" excepting it only honors @Some::Module::EXPORT and @Some::Module::EXPORT_OK.

The given @symbols are exported to the current package provided they are in @Some::Module::EXPORT or @Some::Module::EXPORT_OK. Otherwise an exception is thrown (ie. the program dies).

If @symbols is not given, everything in @Some::Module::EXPORT is exported.

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).

REPOSITORY

<https://github.com/neilb/Exporter-Lite>

AUTHORS

Michael G Schwern <[email protected]>

LICENSE

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

LAST SEARCHED