From: Jess Robinson Date: Sat, 3 Nov 2007 02:17:11 +0000 (+0000) Subject: Improve inflatecolumn docs X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=ef7a8b67862cb8d034591cdc564945dc2c7a61a4;p=dbsrgits%2FDBIx-Class-Historic.git Improve inflatecolumn docs --- diff --git a/lib/DBIx/Class/InflateColumn.pm b/lib/DBIx/Class/InflateColumn.pm index 422d8b9..ee3081c 100644 --- a/lib/DBIx/Class/InflateColumn.pm +++ b/lib/DBIx/Class/InflateColumn.pm @@ -25,12 +25,19 @@ the column data. It also "deflates" references into an appropriate format for the database. It can be used, for example, to automatically convert to and from -L objects for your date and time fields. +L objects for your date and time fields. There's a +conveniece component to actually do that though, try +L. -It will accept arrayrefs, hashrefs and blessed references (objects), -but not scalarrefs. Scalar references are passed through to the -database to deal with, to allow such settings as C< \'year + 1'> and -C< \'DEFAULT' > to work. +It will handle all types of references except scalar references. It +will not handle scalar values, these are ignored and thus passed +through to L. This is to allow setting raw values to +"just work". Scalar references are passed through to the database to +deal with, to allow such settings as C< \'year + 1'> and C< \'DEFAULT' > +to work. + +If you want to filter plain scalar values and replace them with +something else, contribute a filtering component. =head1 METHODS @@ -57,8 +64,7 @@ database, or consider L.) The coderefs you set for inflate and deflate are called with two parameters, the first is the value of the column to be inflated/deflated, the second is the -row object itself. Thus you can call C<< ->result_source->schema->storage->dbh >> on -it, to feed to L. +row object itself. Thus you can call C<< ->result_source->schema->storage->dbh >> in your inflate/defalte subs, to feed to L. In this example, calls to an event's C accessor return a L object. This L object is later "deflated" when