.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Jifty::DBI::Filter 3pm"
.TH Jifty::DBI::Filter 3pm "2022-06-15" "perl v5.34.0" "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"
Jifty::DBI::Filter \- base class for Jifty::DBI filters
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  # To implement your own filter
\&  package MyApp::Filter::Uppercase;
\&  use base qw/ Jifty::DBI::Filter /;
\&
\&  # Setup for DB storage, store in lowercase
\&  sub encode {
\&      my $self = shift;
\&
\&      my $value_ref = $self\->value_ref;
\&      return unless defined $$value_ref; # don\*(Aqt blow up on undef
\&
\&      $$value_ref = lc $$value_ref;
\&  }
\&
\&  # Setup for Perl code to use, always sees uppercase
\&  sub decode {
\&      my $self = shift;
\&
\&      my $value_ref = $self\->value_ref;
\&      return unless defined $$value_ref; # don\*(Aqt blow up on undef
\&
\&      $$value_ref = uc $$value_ref;
\&  }
\&
\&  # To use a filter
\&  use MyApp::Record schema {
\&      column filtered =>
\&          type is \*(Aqtext\*(Aq,
\&          filters are qw/ MyApp::Filter::Uppercase /;
\&  };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A filter allows Jifty::DBI models to tweak data prior to being stored and/or loaded. This is useful for marshalling and unmarshalling complex objects.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Takes three arguments in a parameter hash:
.IP "value_ref" 4
.IX Item "value_ref"
A reference to the current value you're going to be
massaging. \f(CW\*(C`encode\*(C'\fR works in place, massaging whatever value_ref
refers to.
.IP "column" 4
.IX Item "column"
A Jifty::DBI::Column object, whatever sort of column we're working
with here.
.IP "handle" 4
.IX Item "handle"
A Jifty::DBI::Handle object, because some filters (i.e.
Jifty::DBI::Filter::Boolean) depend on what database system is being used.
.SS "encode"
.IX Subsection "encode"
\&\f(CW\*(C`encode\*(C'\fR takes data that users are handing to us and marshals it into
a form suitable for sticking it in the database. This could be anything
from flattening a DateTime object into an \s-1ISO\s0 date to making sure
that data is utf8 clean.
.SS "decode"
.IX Subsection "decode"
\&\f(CW\*(C`decode\*(C'\fR takes data that the database is handing back to us and gets
it into a form that's \s-1OK\s0 to hand back to the user. This could be
anything from inflating an \s-1ISO\s0 date to a DateTime object to
making sure that the string properly has the utf8 flag.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Jifty::DBI::Filter::Date, Jifty::DBI::Filter::DateTime, Jifty::DBI::Filter:SaltHash, Jifty::DBI::Filter::Storable, Jifty::DBI::Filter::Time, Jifty::DBI::Filter::Truncate, Jifty::DBI::Filter::YAML, Jifty::DBI::Filter::base64, Jifty::DBI::Filter::utf8
.SH "LICENSE"
.IX Header "LICENSE"
Jifty::DBI is Copyright 2005\-2007 Best Practical Solutions, \s-1LLC.\s0
Jifty::DBI is distributed under the same terms as Perl itself.