jifty::dbi::filter::datetime(3pm) [debian man page]

Jifty::DBI::Filter::DateTime(3pm)			User Contributed Perl Documentation			 Jifty::DBI::Filter::DateTime(3pm)

NAME

       Jifty::DBI::Filter::DateTime - DateTime object wrapper around date columns

DESCRIPTION

       This filter allow you to work with DateTime objects instead of plain text dates.  If the column type is "date", then the hour, minute, and
       second information is discarded when encoding.

       Both input and output will always be coerced into UTC (or, in the case of Dates, the Floating timezone) for consistency.

   formatter
       This is an instance of the DateTime::Format object used for inflating the string in the database to a DateTime object. By default it is a
       DateTime::Format::Strptime object that uses the "_strptime" method as its pattern.

       You can use the _formatter classdata storage as a cache so you don't need to re-instantiate your format object every "decode".

   encode
       If value is DateTime object then converts it into ISO format "YYYY-MM-DD hh:mm:ss". Does nothing if value is not defined.

       Sets the value to undef if the value is a string and doesn't match an ISO date (at least).

   decode
       If value is defined then converts it into DateTime object otherwise do nothing.

SEE ALSO

       Jifty::DBI::Filter, DateTime

perl v5.14.2							    2010-09-21					 Jifty::DBI::Filter::DateTime(3pm)

Jifty::DBI::Filter(3pm) 				User Contributed Perl Documentation				   Jifty::DBI::Filter(3pm)

NAME

       Jifty::DBI::Filter - base class for Jifty::DBI filters

SYNOPSIS

	 # 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't 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't blow up on undef

	     $$value_ref = uc $$value_ref;
	 }

	 # To use a filter
	 use MyApp::Record schema {
	     column filtered =>
		 type is 'text',
		 filters are qw/ MyApp::Filter::Uppercase /;
	 };

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.

METHODS

   new
       Takes three arguments in a parameter hash:

       value_ref
	   A reference to the current value you're going to be massaging. "encode" works in place, massaging whatever value_ref refers to.

       column
	   A Jifty::DBI::Column object, whatever sort of column we're working with here.

       handle
	   A Jifty::DBI::Handle object, because some filters (i.e.  Jifty::DBI::Filter::Boolean) depend on what database system is being used.

   encode
       "encode" 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 ISO date to making sure that data is utf8 clean.

   decode
       "decode" takes data that the database is handing back to us and gets it into a form that's OK to hand back to the user. This could be
       anything from inflating an ISO date to a DateTime object to making sure that the string properly has the utf8 flag.

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

LICENSE

       Jifty::DBI is Copyright 2005-2007 Best Practical Solutions, LLC.  Jifty::DBI is distributed under the same terms as Perl itself.

perl v5.14.2							    2010-12-09						   Jifty::DBI::Filter(3pm)