.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Poet::Import 3pm"
.TH Poet::Import 3pm "2014-02-26" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Poet::Import \-\- Import Poet quick vars and utilities
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # In a script...
\&    use Poet::Script qw($conf $poet $log :file);
\&
\&    # In a module...
\&    use Poet qw($conf $poet $log :file);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Poet makes it easy to import certain variables (known as \*(L"quick vars\*(R") and
utility sets into any script or module in your environment.
.PP
In a script:
.PP
.Vb 1
\&    use Poet::Script qw(...);
.Ve
.PP
and in a module:
.PP
.Vb 1
\&    use Poet qw(...);
.Ve
.PP
where \f(CW\*(C`...\*(C'\fR contains one or more quick var names (e.g. \f(CW$conf\fR, \f(CW$poet\fR)
and/or utility tags (e.g. \f(CW\*(C`:file\*(C'\fR, \f(CW\*(C`:web\*(C'\fR).
.PP
(Note that \f(CW\*(C`use Poet::Script\*(C'\fR is also necessary for initializing the
environment, even if you don't care to import anything, whereas \f(CW\*(C`use Poet\*(C'\fR has
no effect other than importing.)
.SH "QUICK VARS"
.IX Header "QUICK VARS"
Here is the built-in list of quick vars you can import. Some of the variables
are singletons, and some of them are specific to each package they are imported
into.
.ie n .IP "$poet" 4
.el .IP "\f(CW$poet\fR" 4
.IX Item "$poet"
The global environment object, provided by
Poet::Environment. This provides information such as the
root directory and paths to subdirectories.
.Sp
For backward compatibility this is also available as \f(CW$env\fR.
.ie n .IP "$conf" 4
.el .IP "\f(CW$conf\fR" 4
.IX Item "$conf"
The global configuration object, provided by Poet::Conf.
.ie n .IP "$cache" 4
.el .IP "\f(CW$cache\fR" 4
.IX Item "$cache"
The cache for the current package, provided by Poet::Cache.
.ie n .IP "$log" 4
.el .IP "\f(CW$log\fR" 4
.IX Item "$log"
The logger for the current package, provided by Poet::Log.
.SH "UTILITIES"
.IX Header "UTILITIES"
.SS "Default utilities"
.IX Subsection "Default utilities"
The utilities in Poet::Util::Debug are always imported,
with no tag necessary.
.SS ":file"
.IX Subsection ":file"
This tag imports all the utilities in Poet::Util::File.
.SS ":web"
.IX Subsection ":web"
This tag imports all the utilities in Poet::Util::Web. It is
automatically included in all Mason components.
.SH "MASON COMPONENTS"
.IX Header "MASON COMPONENTS"
Every Mason component automatically gets this on top:
.PP
.Vb 1
\&    use Poet qw($conf $poet :web);
.Ve
.PP
\&\f(CW\*(C`$m\->cache\*(C'\fR and \f(CW\*(C`$m\->log\*(C'\fR will get you the cache and log objects for
a particular Mason component.
.SH "CUSTOMIZING"
.IX Header "CUSTOMIZING"
.SS "Adding variables"
.IX Subsection "Adding variables"
To add your own variable, define a method called provide_var_\fIvarname\fR in
\&\f(CW\*(C`MyApp::Import\*(C'\fR. For example to add a variable \f(CW$dbh\fR:
.PP
.Vb 3
\&    package MyApp::Import;
\&    use Poet::Moose;
\&    extends \*(AqPoet::Import\*(Aq;
\&
\&    method provide_var_dbh ($caller) {
\&        # Generate and return a dbh.
\&        # $caller is the package importing the variable.
\&        # $poet is the current Poet environment.
\&    }
.Ve
.PP
\&\f(CW\*(C`provide_dbh\*(C'\fR can return a single global value, or a dynamic value depending
on \f(CW$caller\fR.
.PP
Now your scripts and libraries can do
.PP
.Vb 2
\&    use Poet::Script qw($dbh);
\&    use Poet qw($dbh);
.Ve
.SS "Adding utility tags"
.IX Subsection "Adding utility tags"
To add your own utility tag, define a class \f(CW\*(C`MyApp::Util::Mytagname\*(C'\fR that
exports a set of functions via the ':all' tag. For example:
.PP
.Vb 3
\&    package MyApp::Util::Hash;
\&    use Hash::Util qw(hash_seed all_keys);
\&    use Hash::MoreUtils qw(slice slice_def slice_exists);
\&    
\&    our @EXPORT_OK = qw(hash_seed all_keys slice slice_def slice_exists);
\&    our %EXPORT_TAGS = ( \*(Aqall\*(Aq => \e@EXPORT_OK );
\&
\&    1;
.Ve
.PP
Now your scripts and libraries can do
.PP
.Vb 2
\&    use Poet::Script qw(:hash);
\&    use Poet qw(:hash);
.Ve
.SS "Other exports"
.IX Subsection "Other exports"
To export other general things to the calling class, you can override
\&\f(CW\*(C`export_to_class\*(C'\fR, which takes the calling class as its argument. e.g.
.PP
.Vb 3
\&    package MyApp::Import;
\&    use Poet::Moose;
\&    extends \*(AqPoet::Import\*(Aq;
\&
\&    before \*(Aqexport_to_class\*(Aq => sub {
\&        my ($self, $class) = @_;
\&        no strict \*(Aqrefs\*(Aq;
\&        %{$class . "::some_name"} = ...;
\&    }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Poet
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.