.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Bigtop::Backend::Model::GantryDBIxClass 3"
.TH Bigtop::Backend::Model::GantryDBIxClass 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
[% app_name %]::Model \- schema class for [% app_name +%]
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your base module:
.PP
.Vb 3
\&    use [% app_name %]::Model;
\&    sub schema_base_class { return '[% app_name %]::Model'; }
\&    use Gantry::Plugins::DBIxClassConn qw( get_schema );
.Ve
.PP
[%\- \s-1FOREACH\s0 table_model \s-1IN\s0 table_models \-%]
    use [% app_name %]::Model::[% table_model %] qw( $[% table_model | upper %] );
.PP
[%\- \s-1END\s0 \-%]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module was generated by Bigtop.  But, feel free to edit it.  You
might even want to update these docs.
.IP "get_db_options" 4
.IX Item "get_db_options"
The generated version sets AutoCommit to 1, this assumes that you will
do all transaction work via the DBIx::Class \s-1API\s0.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.Vb 2
\&    Gantry::Utils::DBIxClass
\&    [% app_name %]::GENModel
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
[% \s-1FOREACH\s0 author \s-1IN\s0 authors %]
[% author.0 %][% \s-1IF\s0 author.1 %], <[% author.1 %]>[% \s-1END\s0 %]
.PP
[% \s-1END\s0 %]
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) [% year %] [% copyright_holder %]
.PP
[% \s-1IF\s0 license_text %]
[% \s-1ELSE\s0 %]
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.
[% \s-1END\s0 %]
.SH "NAME"
[% app_name %]::GENModel \- regenerating schema for [% app_name %]
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your base schema:
.PP
.Vb 2
\&    use base 'DBIx::Class::Schema';
\&    use [% app_name %]::GENModel;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module was generated by Bigtop (and \s-1IS\s0 subject to regeneration).
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
.Vb 1
\&    Gantry::Utils::DBIxClass
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
[% \s-1FOREACH\s0 author \s-1IN\s0 authors %]
[% author.0 %][% \s-1IF\s0 author.1 %], <[% author.1 %]>[% \s-1END\s0 %]
.PP
[% \s-1END\s0 %]
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) [% year %] [% copyright_holder %]
.PP
[% \s-1IF\s0 license_text %]
[% \s-1ELSE\s0 %]
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.
[% \s-1END\s0 %]
.SH "NAME"
[% package_name %] \- model for [% table_name %] table (stub part)
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This model inherits from its generated helper, which inherits from
[% base_class || base_class_default %].  It was generated by Bigtop, but is
\&\s-1NOT\s0 subject to regeneration.
.SH "METHODS (mixed in from [% gen_package_name %])"
.IX Header "METHODS (mixed in from [% gen_package_name %])"
You may use all normal [% base_class || base_class_default %] methods and the
ones listed here:
.IP "get_foreign_display_fields" 4
.IX Item "get_foreign_display_fields"
.PD 0
.IP "get_foreign_tables" 4
.IX Item "get_foreign_tables"
.IP "foreign_display" 4
.IX Item "foreign_display"
.IP "table_name [% \s-1FOREACH\s0 option_field \s-1IN\s0 option_fields %]" 4
.IX Item "table_name [% FOREACH option_field IN option_fields %]"
.IP "[% option_field.name %]_display [% \s-1END\s0 %]" 4
.IX Item "[% option_field.name %]_display [% END %]"
.PD
.SH "NAME"
[% gen_package_name %] \- model for [% table_name %] table (generated part)
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This model inherits from [% base_class || base_class_default %].
It was generated by Bigtop, and \s-1IS\s0 subject to regeneration.
.SH "METHODS"
.IX Header "METHODS"
You may use all normal [% base_class || base_class_default %] methods and the
ones listed here:
.IP "get_foreign_display_fields" 4
.IX Item "get_foreign_display_fields"
.PD 0
.IP "get_foreign_tables" 4
.IX Item "get_foreign_tables"
.IP "foreign_display" 4
.IX Item "foreign_display"
.IP "table_name [% \s-1FOREACH\s0 extra_method \s-1IN\s0 extra_methods %]" 4
.IX Item "table_name [% FOREACH extra_method IN extra_methods %]"
.IP "[% extra_method +%] [% \s-1END\s0 %]" 4
.IX Item "[% extra_method +%] [% END %]"
.PD
.SH "NAME"
[% stub_package %] \- model for [% table_name %] table (stub part)
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This model inherits from its generated helper, which inherits from
Gantry::Utils::DBIxClass.  It was generated by Bigtop, but is
\&\s-1NOT\s0 subject to regeneration.
.SH "NAME"
[% gen_package %] \- model for [% table_name %] table (generated part)
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This model inherits from Gantry::Utils::DBIxClass.
It was generated by Bigtop, and \s-1IS\s0 subject to regeneration.
.SH "METHODS"
.IX Header "METHODS"
You may use all normal Gantry::Utils::DBIxClass methods and the
ones listed here:
.IP "get_foreign_display_fields" 4
.IX Item "get_foreign_display_fields"
.PD 0
.IP "get_foreign_tables" 4
.IX Item "get_foreign_tables"
.IP "foreign_display" 4
.IX Item "foreign_display"
.IP "table_name [% \s-1FOREACH\s0 extra_method \s-1IN\s0 extra_methods %]" 4
.IX Item "table_name [% FOREACH extra_method IN extra_methods %]"
.IP "[% extra_method +%] [% \s-1END\s0 %]" 4
.IX Item "[% extra_method +%] [% END %]"
.PD
.SH "NAME"
Bigtop::Backend::Model::GantryDBIxClass \- Bigtop backend generating DBIx::Class models
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
If your bigtop file looks like this:
.PP
.Vb 6
\&    config {
\&        base_dir `/home/user`;
\&        ...
\&        Model GantryDBIxClass {}
\&    }
\&    app Name {...}
.Ve
.PP
and there are tables in the app block, when you type:
.PP
.Vb 1
\&    bigtop your.bigtop Model
.Ve
.PP
or
    bigtop your.bigtop all
.PP
this module will make model modules which are subclasses of
Gantry::Utils::DBIxClass (which inherits from DBIx::Class).
.PP
All modules will live in the lib subdirectory of the app's build directory.
See Bigtop::Init::Std for an explanation of how base_dir and the
build directory are related.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Bigtop backend which generates data model modules which are
subclasses of Gantry::Utils::DBIxClass.
.SH "KEYWORDS"
.IX Header "KEYWORDS"
This module does not register any keywords.  See Bigtop::Model for
a list of keywords models understand.
.PP
The default for the model_base_class keyword is Gantry::Utils::DBIxClass.
.SH "METHODS"
.IX Header "METHODS"
To keep podcoverage tests happy.
.IP "backend_block_keywords" 4
.IX Item "backend_block_keywords"
Tells tentmaker that I understand these config section backend block keywords:
.Sp
.Vb 3
\&    no_gen
\&    model_base_class
\&    template
.Ve
.IP "what_do_you_make" 4
.IX Item "what_do_you_make"
Tells tentmaker what this module makes.  Summary: DBIx::Class models and
schema.
.IP "gen_Model" 4
.IX Item "gen_Model"
Called by Bigtop::Parser to get me to do my thing.
.IP "setup_template" 4
.IX Item "setup_template"
Called by Bigtop::Parser so the user can substitute an alternate template
for the hard coded one here.
.SH "AUTHOR"
.IX Header "AUTHOR"
Phil Crow <crow.phil@gmail.com>
.SH "COPYRIGHT and LICENSE"
.IX Header "COPYRIGHT and LICENSE"
Copyright (C) 2005 by Phil Crow
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.