X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FCDBICompat.pm;h=c221a617c41e70dac4c236b772fe22c9e6e432c0;hb=fab31d8c753ec27ee5b5a16d1568cc337a245858;hp=aa88e4b8c3155831839d43c0a62ca6ba8d7587db;hpb=95a70f01eae4b2c325a3a527a72cf8ae91796e8c;p=dbsrgits%2FDBIx-Class-Historic.git

diff --git a/lib/DBIx/Class/CDBICompat.pm b/lib/DBIx/Class/CDBICompat.pm
index aa88e4b..c221a61 100644
--- a/lib/DBIx/Class/CDBICompat.pm
+++ b/lib/DBIx/Class/CDBICompat.pm
@@ -2,39 +2,132 @@ package DBIx::Class::CDBICompat;
 
 use strict;
 use warnings;
+use base qw/DBIx::Class/;
 
-use base qw/DBIx::Class::CDBICompat::Triggers
-            DBIx::Class::CDBICompat::GetSet
-            DBIx::Class::CDBICompat::LiveObjectIndex
-            DBIx::Class::CDBICompat::AttributeAPI
-            DBIx::Class::CDBICompat::Stringify
-            DBIx::Class::CDBICompat::DestroyWarning
-            DBIx::Class::CDBICompat::Constructor
-            DBIx::Class::CDBICompat::AccessorMapping
-            DBIx::Class::CDBICompat::ColumnCase
-            DBIx::Class::CDBICompat::HasMany
-            DBIx::Class::CDBICompat::HasA
-            DBIx::Class::CDBICompat::LazyLoading
-            DBIx::Class::CDBICompat::AutoUpdate
-            DBIx::Class::CDBICompat::ColumnGroups
-            DBIx::Class::CDBICompat::ImaDBI/;
-
-            #DBIx::Class::CDBICompat::ObjIndexStubs
+__PACKAGE__->load_own_components(qw/
+  Constraints
+  Triggers
+  ReadOnly
+  GetSet
+  LiveObjectIndex
+  AttributeAPI
+  Stringify
+  DestroyWarning
+  Constructor
+  AccessorMapping
+  ColumnCase
+  MightHave
+  HasMany
+  HasA
+  LazyLoading
+  AutoUpdate
+  TempColumns
+  Retrieve
+  Pager
+  ColumnGroups
+  ImaDBI/);
+
+            #DBIx::Class::ObjIndexStubs
 1;
 
 =head1 NAME 
 
 DBIx::Class::CDBICompat - Class::DBI Compatability layer.
 
+=head1 SYNOPSIS
+
+  use base qw/DBIx::Class/;
+  __PACKAGE__->load_components(qw/CDBICompat Core DB/);
+
 =head1 DESCRIPTION
 
-This class just inherits from the various modules that makes 
-up the Class::DBI compability layer.
+DBIx::Class features a fully featured compability layer with L<Class::DBI>
+to ease transition for existing CDBI users. In fact, this class is just a
+receipe containing all the features emulated. If you like, you can choose
+which features to emulate by building your own class and loading it like 
+this:
+
+  __PACKAGE__->load_own_components(qw/CDBICompat/);
+
+this will automatically load the features included in My::DB::CDBICompat, 
+provided it looks something like this:
+
+  package My::DB::CDBICompat;
+  __PACKAGE__->load_components(qw/
+    CDBICompat::ColumnGroups
+    CDBICompat::Retrieve
+    CDBICompat::HasA
+    CDBICompat::HasMany
+    CDBICompat::MightHave
+  /);
+
+=head1 Components
+
+=over 4
+
+=item AccessorMapping
+
+=item AttributeAPI
+
+=item AutoUpdate
+
+Allows you to turn on automatic updates for column values.
+
+=item ColumnCase
+
+=item ColumnGroups
+
+=item Constraints
+
+=item Constructor
+
+=item DestroyWarning
+
+=item GetSet
+
+=item HasA
+
+Responsible for HasA relationships. 
+
+=item HasMany
+
+Responsible for HasMany relationships. 
+
+=item ImaDBI
+
+=item LazyLoading
+
+=item LiveObjectIndex
+
+The live object index tries to ensure there is only one version of a object
+in the perl interprenter.
+
+=item MightHave
+
+Responsible for MightHave relationships. 
+
+=item ObjIndexStubs
+
+=item ReadOnly
+
+=item Retrieve
+
+=item Stringify
+
+=item TempColumns
+
+=item Triggers
+
+This class implements the trigger functionality.
+
+=item PassThrough
+
+=back
 
 
 =head1 AUTHORS
 
-Matt S. Trout <perl-stuff@trout.me.uk>
+Matt S. Trout <mst@shadowcatsystems.co.uk>
 
 =head1 LICENSE