[Jifty-commit] r1723 - jifty/trunk/lib/Jifty/Filter

[jifty-commit at lists.jifty.org]

Author: nelhage
Date: Tue Aug  1 16:06:57 2006
New Revision: 1723

Modified:
   jifty/trunk/lib/Jifty/Filter/DateTime.pm

Log:
POD++

Modified: jifty/trunk/lib/Jifty/Filter/DateTime.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Filter/DateTime.pm	(original)
+++ jifty/trunk/lib/Jifty/Filter/DateTime.pm	Tue Aug  1 16:06:57 2006
@@ -13,11 +13,29 @@
 based on the record's current user's preferred time zone, when
 available.
 
+This is intended to be combined with C<Jifty::DBI::Filter::Date> or
+C<Jifty::DBI::Filter::DateTime>, e.g.
+
+    column created =>
+      type is 'timestamp',
+      filters are qw( Jifty::Filter::DateTime Jifty::DBI::Filter::DateTime),
+      label is 'Created',
+      is immutable;
+
 =cut
 
 package Jifty::Filter::DateTime;
 use base qw(Jifty::DBI::Filter);
 
+
+=head2 decode
+
+If the value is a DateTime, replace it with a Jifty::DateTime
+representing the same time, setting the time zone in the process.
+
+=cut
+
+
 sub decode {
     my $self = shift;
     my $value_ref = $self->value_ref;