lib/DBIx/Class/TableInstance.pm

   1 package DBIx::Class::TableInstance;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/DBIx::Class::ResultSourceInstance/;
   7 use DBIx::Class::ResultSource::Table;
   8
   9 __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
  10
  11 __PACKAGE__->mk_classdata('table_class' => 'DBIx::Class::ResultSource::Table');
  12
  13 =head1 NAME
  14
  15 DBIx::Class::TableInstance - provides a classdata table object and method proxies
  16
  17 =head1 SYNOPSIS
  18
  19   __PACKAGE__->table('foo');
  20   __PACKAGE__->add_columns(qw/id bar baz/);
  21   __PACKAGE__->set_primary_key('id');
  22
  23 =head1 METHODS
  24
  25 =head2 add_columns
  26
  27   __PACKAGE__->add_columns(qw/col1 col2 col3/);
  28
  29 Adds columns to the current class and creates accessors for them.
  30
  31 =cut
  32
  33 =head2 table
  34
  35   __PACKAGE__->table('tbl_name');
  36
  37 Gets or sets the table name.
  38
  39 =cut
  40
  41 sub table {
  42   my ($class, $table) = @_;
  43   return $class->result_source_instance->name unless $table;
  44   unless (ref $table) {
  45     $table = $class->table_class->new(
  46       {
  47         name => $table,
  48         result_class => $class,
  49       });
  50     if ($class->can('result_source_instance')) {
  51       $table->{_columns} = { %{$class->result_source_instance->{_columns}||{}} };
  52       $table->{_ordered_columns} =
  53         [ @{$class->result_source_instance->{_ordered_columns}||[]} ];
  54     }
  55   }
  56   $class->mk_classdata('result_source_instance' => $table);
  57   if ($class->can('schema_instance')) {
  58     $class =~ m/([^:]+)$/;
  59     $class->schema_instance->register_class($class, $class);
  60   }
  61 }
  62
  63 =head2 has_column
  64
  65   if ($obj->has_column($col)) { ... }
  66
  67 Returns 1 if the class has a column of this name, 0 otherwise.
  68
  69 =cut
  70
  71 =head2 column_info
  72
  73   my $info = $obj->column_info($col);
  74
  75 Returns the column metadata hashref for a column.
  76
  77 =cut
  78
  79 =head2 columns
  80
  81   my @column_names = $obj->columns;
  82
  83 =cut
  84
  85 1;
  86
  87 =head1 AUTHORS
  88
  89 Matt S. Trout <mst@shadowcatsystems.co.uk>
  90
  91 =head1 LICENSE
  92
  93 You may distribute this code under the same terms as Perl itself.
  94
  95 =cut
  96