Docpatch for ::FilterColumn (component loading)
hakim [Fri, 9 Jul 2010 21:59:16 +0000 (22:59 +0100)]
lib/DBIx/Class/FilterColumn.pm

index 45b798c..3c3f04f 100644 (file)
@@ -158,7 +158,12 @@ DBIx::Class::FilterColumn - Automatically convert column data
 
 =head1 SYNOPSIS
 
- # In your result classes
+In your Schema or DB class add "FilterColumn" to the top of the component list.
+
+  __PACKAGE__->load_components(qw( FilterColumn ... ));
+
+Set up filters for the columns you want to convert.
+
  __PACKAGE__->filter_column( money => {
      filter_to_storage => 'to_pennies',
      filter_from_storage => 'from_pennies',
@@ -170,6 +175,7 @@ DBIx::Class::FilterColumn - Automatically convert column data
 
  1;
 
+
 =head1 DESCRIPTION
 
 This component is meant to be a more powerful, but less DWIM-y,