lib/DBIx/Class/ResultSourceProxy/Table.pm

   1 package DBIx::Class::ResultSourceProxy::Table;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base qw/DBIx::Class::ResultSourceProxy/;
   7 __PACKAGE__->load_components(qw/AccessorGroup/);
   8
   9 __PACKAGE__->mk_group_accessors('component_class' => 'table_class');
  10 __PACKAGE__->table_class('DBIx::Class::ResultSource::Table');
  11
  12 __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do
  13                                           # anything yet!
  14
  15 =head1 NAME
  16
  17 DBIx::Class::ResultSourceProxy::Table - provides a classdata table
  18 object and method proxies
  19
  20 =head1 SYNOPSIS
  21
  22   __PACKAGE__->table('cd');
  23   __PACKAGE__->add_columns(qw/cdid artist title year/);
  24   __PACKAGE__->set_primary_key('cdid');
  25
  26 =head1 METHODS
  27
  28 =head2 add_columns
  29
  30   __PACKAGE__->add_columns(qw/cdid artist title year/);
  31
  32 Adds columns to the current class and creates accessors for them.
  33
  34 =cut
  35
  36 =head2 table
  37
  38   __PACKAGE__->table('tbl_name');
  39
  40 Gets or sets the table name.
  41
  42 =cut
  43
  44 sub table {
  45   my ($class, $table) = @_;
  46   return $class->result_source_instance->name unless $table;
  47   unless (ref $table) {
  48     $table = $class->table_class->new({
  49         $class->can('result_source_instance') ?
  50           %{$class->result_source_instance} : (),
  51         name => $table,
  52         result_class => $class,
  53         source_name => undef,
  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. For a description of
  76 the various types of column data in this hashref, see
  77 L<DBIx::Class::ResultSource/add_column>
  78
  79 =cut
  80
  81 =head2 columns
  82
  83   my @column_names = $obj->columns;
  84
  85 =cut
  86
  87 1;
  88
  89 =head1 AUTHORS
  90
  91 Matt S. Trout <mst@shadowcatsystems.co.uk>
  92
  93 =head1 LICENSE
  94
  95 You may distribute this code under the same terms as Perl itself.
  96
  97 =cut
  98