.\" 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 "Gantry::Utils::DBIxClass 3"
.TH Gantry::Utils::DBIxClass 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Gantry::Utils::DBIxClass \- a DBIx::Class subclass models can inherit from
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package YourModel;
.Ve
.PP
.Vb 1
\&    use base 'Gantry::Utils::DBIxClass';
.Ve
.PP
.Vb 1
\&    # standard DBIx::Class table definition
.Ve
.PP
.Vb 2
\&    __PACKAGE__->sequence_name( 'your_seq' );
\&    __PACKAGE__->base_model( 'Your::Schema' );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
By inheriting from this module instead of from DBIx::Class directly, you gain
additional helper methods which various parts of Gantry use.
.SH "METHODS"
.IX Header "METHODS"
.IP "get_listing" 4
.IX Item "get_listing"
Parameters: A hash reference with these keys:
.Sp
.Vb 2
\&    schema   - a DBIx::Class::Schema object
\&    order_by - [optional] a valid SQL ORDER BY clause
.Ve
.Sp
Returns: an array of all rows in your table.  The default order is the
foreign_display fields.
.IP "get_form_selections" 4
.IX Item "get_form_selections"
Parameters: A hash reference with this key:
.Sp
.Vb 1
\&    schema - a DBIx::Class::Schema object
.Ve
.Sp
Returns: A hash keyed by foreign table name storing an array of items.
Each item is a hash with two keys like this:
.Sp
.Vb 4
\&    {
\&        value => $item->$value_method
\&        label => $item->foreign_display(),
\&    }
.Ve
.Sp
This is precisely the format that all Gantry \s-1CRUD\s0 schemes expect in their
forms.
.Sp
The value_method is either id (the default) or the result of calling the
optional get_value_method on the relevant foreign table model class.
.IP "stringify_self" 4
.IX Item "stringify_self"
This is an overload callback used when database row objects are in
string context.  The one here calls id on the row object.  Children should
override if their primary key is not a single column called 'id'.
.IP "create" 4
.IX Item "create"
This method is provided for historical reasons and should no longer be used,
see gcreate below.
.PP
In addition to the above methods, this base class provides the following
convenience accessors to save typing.  For example, instead of typing:
.PP
.Vb 5
\&    my $schema = $self->get_schema();
\&    my @rows   = $schema->resultset( 'table_name' )->search(
\&            { ... },
\&            { ... }
\&    );
.Ve
.PP
These methods let you say:
.PP
.Vb 5
\&    my @rows => $TABLE_NAME->gsearch(
\&            $self,
\&            { ... },
\&            { ... }
\&    );
.Ve
.IP "gcreate" 4
.IX Item "gcreate"
.PD 0
.IP "gsearch" 4
.IX Item "gsearch"
.IP "gfind" 4
.IX Item "gfind"
.IP "gfind_or_create" 4
.IX Item "gfind_or_create"
.IP "gupdate_or_create" 4
.IX Item "gupdate_or_create"
.PD
.PP
For these methods to work, the invoking controller must use
Gantry::Plugins::DBIxClassConn.  It handles dbic connections and exports
get_schema which all of the g methods call.
.PP
Alternatively, if you are in a script, you may use other similar methods:
.PP
.Vb 5
\&    my $schema = AddressBook::Model->connect(
\&        $conf->{ dbconn },
\&        $conf->{ dbuser },
\&        $conf->{ dbpass },
\&    );
.Ve
.PP
.Vb 1
\&    my @rows => $TABLE_NAME->ssearch( $schema, ... );
.Ve
.PP
These methods expect a valid dbic schema as their first argument.
The available s* methods are:
.IP "screate" 4
.IX Item "screate"
.PD 0
.IP "ssearch" 4
.IX Item "ssearch"
.IP "sfind" 4
.IX Item "sfind"
.IP "sfind_or_create" 4
.IX Item "sfind_or_create"
.IP "supdate_or_create" 4
.IX Item "supdate_or_create"
.PD
.PP
Other helper methods:
.IP "datetime_now" 4
.IX Item "datetime_now"
returns the right \s-1SQL\s0 command for \s-1\fINOW\s0()\fR (datetime field) depending on
whether sqlite or mysql or pgsql are used.
.Sp
For example in controller to set the 'modified' column:
.Sp
.Vb 1
\&  $params->{modified} = $MY_MODEL->datetime_now($self);
.Ve
.Sp
where \f(CW$self\fR is \f(CW$gantry_site\fR object.
.SH "AUTHOR"
.IX Header "AUTHOR"
Phil Crow <philcrow2000@yahoo.com>
.SH "COPYRIGHT and LICENSE"
.IX Header "COPYRIGHT and LICENSE"
Copyright (c) 2006, 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.