.\" Automatically generated by Pod::Man 2.28 (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::Manual::Subclassing 3pm"
.TH Poet::Manual::Subclassing 3pm "2015-01-08" "perl v5.20.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::Manual::Subclassing \- Customizing Poet with subclasses
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
You can subclass the following Poet classes for your application:
.PP
.Vb 7
\&    Poet::Cache
\&    Poet::Conf
\&    Poet::Log
\&    Poet::Mason
\&    Poet::Import
\&    Poet::Plack::Request
\&    Poet::Plack::Response
.Ve
.PP
and arrange things so that Poet always uses your subclass instead of its
default class.
.PP
Place Poet subclasses under \f(CW\*(C`lib/MyApp/Class.pm\*(C'\fR in your environment, where
\&\f(CW\*(C`MyApp\*(C'\fR is your app name and \f(CW\*(C`Class\*(C'\fR is the class you are subclassing minus
the \f(CW\*(C`Poet\*(C'\fR prefix. A few of these subclasses are generated for you by \f(CW\*(C`poet
new\*(C'\fR.
.PP
For example, to subclass \f(CW\*(C`Poet::Cache\*(C'\fR:
.PP
.Vb 3
\&    package MyApp::Cache;
\&    use Poet::Moose;
\&    extends \*(AqPoet::Cache\*(Aq;
\&
\&    # put your modifications here
\&
\&    1;
.Ve
.PP
(Note: Poet::Moose is Moose plus a few Poet standards. You could
also use plain \f(CW\*(C`Moose\*(C'\fR here.)
.PP
Poet will automatically detect, load and use any such subclasses. Internally it
uses the app_class environment method whenever
it needs a classname, e.g.
.PP
.Vb 2
\&    # Do something with MyApp::Cache or Poet::Cache
\&    $poet\->app_class(\*(AqCache\*(Aq)\->...
.Ve
.SS "Subclassing Mason"
.IX Subsection "Subclassing Mason"
As long as you have even a bare-bones \f(CW\*(C`Poet::Mason\*(C'\fR subclass, e.g.
.PP
.Vb 3
\&    package MyApp::Mason;
\&    use Poet::Moose;
\&    extends \*(AqPoet::Mason\*(Aq;
\&
\&    1;
.Ve
.PP
then your Mason subclasses will be autodetected as well, e.g.
.PP
.Vb 5
\&    package MyApp::Mason::Interp;
\&    use Moose;
\&    extends \*(AqMason::Interp\*(Aq;
\&    # put your modifications here
\&    1;
.Ve
.PP
\&\f(CW\*(C`poet new\*(C'\fR will create the bare-bones subclass for you; it is otherwise
harmless.
.PP
See Mason::Manual::Subclasses for more
information.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.SS "Use \s-1INI\s0 instead of \s-1YAML\s0 for config files"
.IX Subsection "Use INI instead of YAML for config files"
.Vb 4
\&    package MyApp::Conf;
\&    use Config::INI;
\&    use Moose;
\&    extends \*(AqPoet::Conf\*(Aq;
\&
\&    override \*(Aqread_conf_file\*(Aq => sub {
\&        my ($self, $file) = @_;
\&        return Config::INI::Reader\->read_file($file);
\&    };
.Ve
.SS "Perform tasks before and after each Mason request"
.IX Subsection "Perform tasks before and after each Mason request"
.Vb 3
\&    package MyApp::Mason::Request;
\&    use Moose;
\&    extends \*(AqMason::Request\*(Aq;
\&
\&    override \*(Aqrun\*(Aq => sub {
\&        my $self = shift;
\&
\&        # Perform tasks before request
\&        my $result = super();
\&        # Perform tasks after request
\&
\&        return $result;
\&    };
.Ve
.SS "Add Perl code to the top of every compiled component"
.IX Subsection "Add Perl code to the top of every compiled component"
.Vb 3
\&    package MyApp::Mason::Compilation;
\&    use Moose;
\&    extends \*(AqMason::Compilation\*(Aq;
\&
\&    override \*(Aqoutput_class_header\*(Aq => sub {
\&         return join("\en", super(), \*(Aquse Foo;\*(Aq, \*(Aquse Bar qw(baz);\*(Aq);
\&    };
.Ve
.SS "Use Log::Dispatch instead of Log4perl for logging"
.IX Subsection "Use Log::Dispatch instead of Log4perl for logging"
.Vb 5
\&    package MyApp::Log;
\&    use Log::Any::Adapter;
\&    use Log::Dispatch;
\&    use Moose;
\&    extends \*(AqPoet::Log\*(Aq;
\&
\&    override \*(Aqinitialize_logging\*(Aq => sub {
\&        my $log = Log::Dispatch\->new( ... );
\&        Log::Any::Adapter\->set(\*(AqDispatch\*(Aq, dispatcher => $log);
\&    };
.Ve
.ie n .SS "Add your own $dbh quick var"
.el .SS "Add your own \f(CW$dbh\fP quick var"
.IX Subsection "Add your own $dbh quick var"
.Vb 4
\&    package MyApp::Import
\&    use DBI;
\&    use Poet::Moose;
\&    extends \*(AqPoet::Import\*(Aq;
\&    
\&    method provide_dbh ($caller, $poet) {
\&        $dbh = DBI\->connect(...);
\&    }
.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.