Release 0.07047

[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / Base.pm

diff --git a/lib/DBIx/Class/Schema/Loader/Base.pm b/lib/DBIx/Class/Schema/Loader/Base.pm
index ba7d8b3..9103faf 100644 (file)
--- a/lib/DBIx/Class/Schema/Loader/Base.pm
+++ b/lib/DBIx/Class/Schema/Loader/Base.pm
@@ -30,7 +30,7 @@ use List::Util qw/all any none/;
 use File::Temp 'tempfile';
 use namespace::clean;
 
-our $VERSION = '0.07046';
+our $VERSION = '0.07047';
 
 __PACKAGE__->mk_group_ro_accessors('simple', qw/
                                 schema
@@ -418,9 +418,9 @@ this hash of parameters (as a list):
     rel_type        # the type of the relationship: 'belongs_to', 'has_many' or 'might_have'
     local_source    # the DBIx::Class::ResultSource object for the source the rel is *from*
     remote_source   # the DBIx::Class::ResultSource object for the source the rel is *to*
-    local_table     # a DBIx::Class::Schema::Loader::Table object for the table of the source the rel is from
+    local_table     # the DBIx::Class::Schema::Loader::Table object for the table of the source the rel is from
     local_cols      # an arrayref of column names of columns used in the rel in the source it is from
-    remote_table    # a DBIx::Class::Schema::Loader::Table object for the table of the source the rel is to
+    remote_table    # the DBIx::Class::Schema::Loader::Table object for the table of the source the rel is to
     remote_cols     # an arrayref of column names of columns used in the rel in the source it is to
     attrs           # the attributes that would be set
 
@@ -613,14 +613,27 @@ a hashref of unqualified table name keys and moniker values
 
 =item *
 
-a coderef for a translator function taking a L<table
-object|DBIx::Class::Schema::Loader::Table> argument (which stringifies to the
-unqualified table name) and returning a scalar moniker
+a coderef that returns the moniker, which is called with the following
+arguments:
 
-The function is also passed a coderef that can be called with either
-of the hashref forms to get the moniker mapped accordingly.  This is
-useful if you need to handle some monikers specially, but want to use
-the hashref form for the rest.
+=over
+
+=item *
+
+the L<DBIx::Class::Schema::Loader::Table> object for the table
+
+=item *
+
+the default moniker that DBIC would ordinarily give this table
+
+=item *
+
+a coderef that can be called with either of the hashref forms to get
+the moniker mapped accordingly.  This is useful if you need to handle
+some monikers specially, but want to use the hashref form for the
+rest.
+
+=back
 
 =back
 
@@ -664,23 +677,36 @@ L</moniker_map> takes precedence over this.
 Same as moniker_map, but for column accessor names.  The nested
 hashref form is traversed according to L</moniker_parts>, with an
 extra level at the bottom for the column name.  If a coderef is
-passed, the code is called with arguments of
+passed, the code is called with the following arguments:
+
+=over
+
+=item *
+
+the L<DBIx::Class::Schema::Loader::Column> object for the column
+
+=item *
+
+the default accessor name that DBICSL would ordinarily give this column
+
+=item *
+
+a hashref of this form:
 
-    the DBIx::Class::Schema::Loader::Column object for the column,
-    default accessor name that DBICSL would ordinarily give this column,
     {
         table_class     => name of the DBIC class we are building,
         table_moniker   => calculated moniker for this table (after moniker_map if present),
-        table           => table object of interface DBIx::Class::Schema::Loader::Table,
+        table           => the DBIx::Class::Schema::Loader::Table object for the table,
         full_table_name => schema-qualified name of the database table (RDBMS specific),
         schema_class    => name of the schema class we are building,
         column_info     => hashref of column info (data_type, is_nullable, etc),
     }
-    coderef ref that can be called with a hashref map
 
-The L<column|DBIx::Class::Schema::Loader::Column> and
-L<table|DBIx::Class::Schema::Loader::Table> objects stringify to their
-unqualified names.
+=item *
+
+a coderef that can be called with a hashref map
+
+=back
 
 =head2 rel_name_map
 
@@ -716,9 +742,9 @@ If it is a coderef, it will be passed a hashref of this form:
         remote_moniker => moniker of the DBIC class we are related to,
         remote_columns => columns in the other table in the relationship,
         # for type => "many_to_many" only:
-        link_class     => name of the DBIC class for the link table
-        link_moniker   => moniker of the DBIC class for the link table
-        link_rel_name  => name of the relationship to the link table
+        link_class     => name of the DBIC class for the link table,
+        link_moniker   => moniker of the DBIC class for the link table,
+        link_rel_name  => name of the relationship to the link table,
     }
 
 In addition it is passed a coderef that can be called with a hashref map.
@@ -885,8 +911,8 @@ L<column_info|DBIx::Class::ResultSource/column_info> for a column.
 
 Must be a coderef that returns a hashref with the extra attributes.
 
-Receives the L<table object|DBIx::Class::Schema::Loader::Table> (which
-stringifies to the unqualified table name), column name and column_info.
+Receives the L<DBIx::Class::Schema::Loader::Table> object, column name
+and column_info.
 
 For example: