.\" 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::Environment 3pm"
.TH Poet::Environment 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::Environment \-\- Poet environment
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # In a script...
\&    use Poet::Script qw($poet);
\&
\&    # In a module...
\&    use Poet qw($poet);
\&
\&    # $poet is automatically available in Mason components
\&
\&    # then...
\&    my $root_dir       = $poet\->root_dir;
\&    my $file           = $poet\->path("some/file.txt");
\&    my $path_to_script = $poet\->bin_path("foo/bar.pl");
\&    my $path_to_lib    = $poet\->lib_path("Foo/Bar.pm");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Poet::Environment object contains information about the current environment
and its directory paths.
.SH "PATH METHODS"
.IX Header "PATH METHODS"
.IP "root_dir" 4
.IX Item "root_dir"
Returns the root directory of the environment, i.e. where \fI.poet_root\fR is
located.
.IP "path (subpath)" 4
.IX Item "path (subpath)"
Returns the root directory with a relative \fIsubpath\fR added. e.g. if the Poet
environment root is \f(CW\*(C`/my/env/root\*(C'\fR, then
.Sp
.Vb 2
\&    $poet\->path("somefile.txt");
\&       ==> returns /my/env/root/somefile.txt
.Ve
.IP "bin_dir" 4
.IX Item "bin_dir"
.PD 0
.IP "comps_dir" 4
.IX Item "comps_dir"
.IP "conf_dir" 4
.IX Item "conf_dir"
.IP "data_dir" 4
.IX Item "data_dir"
.IP "db_dir" 4
.IX Item "db_dir"
.IP "lib_dir" 4
.IX Item "lib_dir"
.IP "logs_dir" 4
.IX Item "logs_dir"
.IP "static_dir" 4
.IX Item "static_dir"
.PD
Returns the specified subdirectory, which by default will be just below the
root dirctory. e.g. if the Poet environment root is \f(CW\*(C`/my/env/root\*(C'\fR, then
.Sp
.Vb 2
\&    $poet\->conf_dir
\&       ==> returns /my/env/root/conf
\&
\&    $poet\->lib_dir
\&       ==> returns /my/env/root/lib
.Ve
.IP "bin_path (subpath)" 4
.IX Item "bin_path (subpath)"
.PD 0
.IP "comps_path (subpath)" 4
.IX Item "comps_path (subpath)"
.IP "conf_path (subpath)" 4
.IX Item "conf_path (subpath)"
.IP "data_path (subpath)" 4
.IX Item "data_path (subpath)"
.IP "db_path (subpath)" 4
.IX Item "db_path (subpath)"
.IP "lib_path (subpath)" 4
.IX Item "lib_path (subpath)"
.IP "logs_path (subpath)" 4
.IX Item "logs_path (subpath)"
.IP "static_path (subpath)" 4
.IX Item "static_path (subpath)"
.PD
Returns the specified subdirectory with a relative \fIsubpath\fR added. e.g. if
the Poet environment root is \f(CW\*(C`/my/env/root\*(C'\fR, then
.Sp
.Vb 2
\&    $poet\->conf_path("log4perl.conf");
\&       ==> returns /my/env/root/conf/log4perl.conf
\&
\&    $poet\->lib_path("Data/Type.pm");
\&       ==> returns /my/env/root/lib/Data/Type.pm
.Ve
.SH "OTHER METHODS"
.IX Header "OTHER METHODS"
.IP "app_class" 4
.IX Item "app_class"
Returns the full class name to use for the specified class, depending on
whether there is a subclass in the environment. e.g.
.Sp
.Vb 1
\&    $poet\->app_class(\*(AqCache\*(Aq)
.Ve
.Sp
will return \f(CW\*(C`MyApp::Cache\*(C'\fR if that module exists, and otherwise
\&\f(CW\*(C`Poet::Cache\*(C'\fR.  This is used internally by Poet to implement auto
subclassing.
.IP "app_name" 4
.IX Item "app_name"
Returns the app name, e.g. 'MyApp', found in .poet_root.
.IP "conf" 4
.IX Item "conf"
Returns the Poet::Conf object associated with the environment.
Usually you'd access this by importing \f(CW$conf\fR.
.IP "current_env" 4
.IX Item "current_env"
A class method that returns the current (singleton) environment for the
process. Usually you'd access this by importing \f(CW$poet\fR.
.ie n .SH "OBTAINING $poet SINGLETON"
.el .SH "OBTAINING \f(CW$poet\fP SINGLETON"
.IX Header "OBTAINING $poet SINGLETON"
In a script:
.PP
.Vb 1
\&    use Poet::Script qw($poet);
.Ve
.PP
In a module:
.PP
.Vb 1
\&    use Poet qw($poet);
.Ve
.PP
\&\f(CW$poet\fR is automatically available in components.
.PP
You can also get it via
.PP
.Vb 1
\&    my $poet = Poet::Environment\->current_env;
.Ve
.SH "CONFIGURING ENVIRONMENT SUBDIRECTORIES"
.IX Header "CONFIGURING ENVIRONMENT SUBDIRECTORIES"
Any subdirectories other than conf_dir can be overridden in configuration. e.g.
.PP
.Vb 2
\&    # Override bin_dir
\&    env.bin_dir: /some/other/bin/dir
.Ve
.PP
With this configuration in place,
.PP
.Vb 2
\&    $poet\->bin_dir
\&       ==> returns /some/other/bin/dir
\&
\&    $poet\->bin_path("foo/bar.pl")
\&       ==> returns /some/other/bin/dir/foo/bar.pl
.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.