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

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

NAME

       Jifty::Filter::DateTime -- A Jifty::DBI filter to work with
				 Jifty::DateTime objects

SYNOPSIS

	  # use it with Jifty::DBI::Filter::Date or J::D::F::DateTime
	   column created =>
	     type is 'timestamp',
	     filters are qw( Jifty::Filter::DateTime Jifty::DBI::Filter::DateTime),
	     label is 'Created',
	     is immutable;

DESCRIPTION

       Jifty::Filter::DateTime promotes DateTime objects to Jifty::DateTime (or your application's DateTime subclass) objects on load. This has
       the side effect of setting their time zone based on the record's current user's preferred time zone, when available.

       This is intended to be combined with "Jifty::DBI::Filter::Date" or "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;

   decode
       If the value is a DateTime, replace it with a Jifty::DateTime (or your application's subclass) representing the same time, setting the time
       zone in the process.

SEE ALSO

       Jifty::DBI::Filter::Date, Jifty::DBI::Filter::DateTime, Jifty::DateTime

LICENSE

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

perl v5.14.2							    2010-12-10					      Jifty::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)