Karen Etheridge > Moose > Moose::Exporter



Annotate this POD



New  11
Open  48
Stalled  7
View/Report Bugs
Module Version: 2.1604   Source  


Moose::Exporter - make an import() and unimport() just like Moose.pm


version 2.1604


  package MyApp::Moose;

  use Moose ();
  use Moose::Exporter;
  use Some::Random ();

      with_meta => [ 'has_rw', 'sugar2' ],
      as_is     => [ 'sugar3', \&Some::Random::thing, 'Some::Random::other_thing' ],
      also      => 'Moose',

  sub has_rw {
      my ( $meta, $name, %options ) = @_;
          is => 'rw',

  # then later ...
  package MyApp::User;

  use MyApp::Moose;

  has 'name' => ( is => 'ro' );
  has_rw 'size';

  no MyApp::Moose;


This module encapsulates the exporting of sugar functions in a Moose.pm-like manner. It does this by building custom import and unimport methods for your module, based on a spec you provide.

It also lets you "stack" Moose-alike modules so you can export Moose's sugar as well as your own, along with sugar from any random MooseX module, as long as they all use Moose::Exporter. This feature exists to let you bundle a set of MooseX modules into a policy module that developers can use directly instead of using Moose itself.

To simplify writing exporter modules, Moose::Exporter also imports strict and warnings into your exporter module, as well as into modules that use it.


This module provides two public methods:


When you call this method, Moose::Exporter builds custom import and unimport methods for your module. The import method will export the functions you specify, and can also re-export functions exported by some other module (like Moose.pm). If you pass any parameters for Moose::Util::MetaRole, the import method will also call Moose::Util::MetaRole::apply_metaroles and Moose::Util::MetaRole::apply_base_class_roles as needed, after making sure the metaclass is initialized.

The unimport method cleans the caller's namespace of all the exported functions. This includes any functions you re-export from other packages. However, if the consumer of your package also imports those functions from the original package, they will not be cleaned.

Note that if any of these methods already exist, they will not be overridden, you will have to use build_import_methods to get the coderef that would be installed.

This method accepts the following parameters:

You can also provide parameters for Moose::Util::MetaRole::apply_metaroles and Moose::Util::MetaRole::apply_base_class_roles. Specifically, valid parameters are "class_metaroles", "role_metaroles", and "base_class_roles".


Returns three code refs, one for import, one for unimport and one for init_meta.

Accepts the additional install option, which accepts an arrayref of method names to install into your exporting package. The valid options are import and unimport. Calling setup_import_methods is equivalent to calling build_import_methods with install => [qw(import unimport)] except that it doesn't also return the methods.

The import method is built using Sub::Exporter. This means that it can take a hashref of the form { into => $package } to specify the package it operates on.

Used by setup_import_methods.

IMPORTING AND init_meta ^

If you want to set an alternative base object class or metaclass class, see above for details on how this module can call Moose::Util::MetaRole for you.

If you want to do something that is not supported by this module, simply define an init_meta method in your class. The import method that Moose::Exporter generates for you will call this method (if it exists). It will always pass the caller to this method via the for_class parameter.

Most of the time, your init_meta method will probably just call Moose->init_meta to do the real work:

  sub init_meta {
      shift; # our class name
      return Moose->init_meta( @_, metaclass => 'My::Metaclass' );


The import method generated by Moose::Exporter will allow the user of your module to specify metaclass traits in a -traits parameter passed as part of the import:

  use Moose -traits => 'My::Meta::Trait';

  use Moose -traits => [ 'My::Meta::Trait', 'My::Other::Trait' ];

These traits will be applied to the caller's metaclass instance. Providing traits for an exporting class that does not create a metaclass for the caller is an error.


See "BUGS" in Moose for details on reporting bugs.



This software is copyright (c) 2006 by Infinity Interactive, Inc..

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

syntax highlighting: