.\" 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::SQL 3"
.TH Gantry::Utils::SQL 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Gantry::Utils::SQL \- SQL routines.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $sql = Gantry::Utils::SQL->new();
.Ve
.PP
.Vb 1
\& $sql_boolean = $sql->sql_bool( $string );
.Ve
.PP
.Vb 1
\& $sql = $sql->sql_insert( $table, %vals );
.Ve
.PP
.Vb 1
\& $sql_number = $sql->sql_num( $number );
.Ve
.PP
.Vb 1
\& $sql_string = $sql->sql_str( $string );
.Ve
.PP
.Vb 1
\& $sql = $sql->sql_update( $table, $clause, %vals );
.Ve
.PP
.Vb 1
\& $sql_quoted = $sql->sql_quote( $string );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module supplies easy ways to make strings sql safe as well as 
allowing the creation of sql commands. All of these commands should 
work with any database as they do not do anything database specfic, 
well as far as I know anyways.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
Standard constructor.  Call it first to gain a helper through which to
call the other methods.  Pass it nothing.
.ie n .IP "$sql_boolean = $sql_helper\fR\->sql_bool( \f(CW$string )" 4
.el .IP "$sql_boolean = \f(CW$sql_helper\fR\->sql_bool( \f(CW$string\fR )" 4
.IX Item "$sql_boolean = $sql_helper->sql_bool( $string )"
This function takes a string and returns either \s-1TRUE\s0 or \s-1FALSE\s0 depending 
on whether or not the function thinks it's true or not. True is defined 
as containing any of the following, 't', 'y', '1', or after
the false test if the string is defined. False is defined as 'f', 'n' or '0'.
Defined and not false is true, and not defined is false. Hopefully this 
is fairly confusing. 
.ie n .IP "$sql = $sql_helper\fR\->sql_insert( \f(CW$table\fR, \f(CW%vals )" 4
.el .IP "$sql = \f(CW$sql_helper\fR\->sql_insert( \f(CW$table\fR, \f(CW%vals\fR )" 4
.IX Item "$sql = $sql_helper->sql_insert( $table, %vals )"
This function takes the table to insert into \f(CW$table'\fR, and the information
to insert into said table, \f(CW%vals\fR. The function will build an insert 
statement based on this information. The \f(CW%vals\fR variable should contain
the keys corrisponding to the columns in the database where the values
should be the values to insert into those fields. The function will return,
hopefully, a valid sql insert string.
.ie n .IP "$sql_number = $sql_helper\fR\->sql_num( \f(CW$number )" 4
.el .IP "$sql_number = \f(CW$sql_helper\fR\->sql_num( \f(CW$number\fR )" 4
.IX Item "$sql_number = $sql_helper->sql_num( $number )"
This function takes a number, \f(CW$number\fR, and quotes it in such a way as 
it may be used in a sql call safely. It handles anything that is a number 
at all. A properly quoted number is return, including the quotes.
.ie n .IP "$sql_string = $sql_helper\fR\->sql_str( \f(CW$string )" 4
.el .IP "$sql_string = \f(CW$sql_helper\fR\->sql_str( \f(CW$string\fR )" 4
.IX Item "$sql_string = $sql_helper->sql_str( $string )"
This function takes a string, \f(CW$string\fR, and quotes in in such a way as 
it may be used safely in a sql call. The string is then returned, including
the quotes arround it.
.ie n .IP "$sql = $sql_helper\fR\->sql_update( \f(CW$table\fR, \f(CW$clause\fR, \f(CW%vals )" 4
.el .IP "$sql = \f(CW$sql_helper\fR\->sql_update( \f(CW$table\fR, \f(CW$clause\fR, \f(CW%vals\fR )" 4
.IX Item "$sql = $sql_helper->sql_update( $table, $clause, %vals )"
This function creates a valid sql update string. It is identical in form
to the \f(CW\*(C`sql_insert()\*(C'\fR function save it takes a where clause, \f(CW$clause\fR.
The clause must contain a valid test against the database, in a pinch use
a where clause that will always return true. The '\s-1WHERE\s0' in the clause need
not be supplied as it is assumed and alwas inserted into the update string.
A valid sql update string is returned, hopefully anyways.
.ie n .IP "$sql_quoted = $sql_helper\fR\->sql_quote( \f(CW$string )" 4
.el .IP "$sql_quoted = \f(CW$sql_helper\fR\->sql_quote( \f(CW$string\fR )" 4
.IX Item "$sql_quoted = $sql_helper->sql_quote( $string )"
This function works the same way as \f(CW\*(C`sql_str()\*(C'\fR save it doesn't really
care what it opperates on. A properly quoted version of whatever is passed
in is returned.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIGantry\fR\|(3), \fIGantry::Utils::DB\fR\|(3)
.SH "LIMITATIONS"
.IX Header "LIMITATIONS"
There is no sql_date function, which there probably should be.
.PP
The quoting method has been tested with Postgresql.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tim Keefer <tkeefer@gmail.com>
Nicholas Studt <nstudt@angrydwarf.org>
.SH "COPYRIGHT and LICENSE"
.IX Header "COPYRIGHT and LICENSE"
Copyright (c) 2006, Tim Keefer.
.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.