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
   8 use DBIx::Class::ResultSource::Table;
   9 use Scalar::Util 'blessed';
  10 use namespace::clean;
  11
  12 __PACKAGE__->mk_classdata(table_class => 'DBIx::Class::ResultSource::Table');
  13
  14 __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do
  15                                           # anything yet!
  16
  17 sub _init_result_source_instance {
  18     my $class = shift;
  19
  20     $class->mk_classdata('result_source_instance')
  21         unless $class->can('result_source_instance');
  22
  23     my $table = $class->result_source_instance;
  24     my $class_has_table_instance = ($table and $table->result_class eq $class);
  25     return $table if $class_has_table_instance;
  26
  27     my $table_class = $class->table_class;
  28     $class->ensure_class_loaded($table_class);
  29
  30     if( $table ) {
  31         $table = $table_class->new({
  32             %$table,
  33             result_class => $class,
  34             source_name => undef,
  35             schema => undef
  36         });
  37     }
  38     else {
  39         $table = $table_class->new({
  40             name            => undef,
  41             result_class    => $class,
  42             source_name     => undef,
  43         });
  44     }
  45
  46     $class->result_source_instance($table);
  47
  48     return $table;
  49 }
  50
  51 =head1 NAME
  52
  53 DBIx::Class::ResultSourceProxy::Table - provides a classdata table
  54 object and method proxies
  55
  56 =head1 SYNOPSIS
  57
  58   __PACKAGE__->table('cd');
  59   __PACKAGE__->add_columns(qw/cdid artist title year/);
  60   __PACKAGE__->set_primary_key('cdid');
  61
  62 =head1 METHODS
  63
  64 =head2 add_columns
  65
  66   __PACKAGE__->add_columns(qw/cdid artist title year/);
  67
  68 Adds columns to the current class and creates accessors for them.
  69
  70 =cut
  71
  72 =head2 table
  73
  74   __PACKAGE__->table('tbl_name');
  75
  76 Gets or sets the table name.
  77
  78 =cut
  79
  80 sub table {
  81   my ($class, $table) = @_;
  82   return $class->result_source_instance->name unless $table;
  83
  84   unless (blessed $table && $table->isa($class->table_class)) {
  85
  86     my $table_class = $class->table_class;
  87     $class->ensure_class_loaded($table_class);
  88
  89     $table = $table_class->new({
  90         $class->can('result_source_instance')
  91           ? %{$class->result_source_instance||{}}
  92           : ()
  93         ,
  94         name => $table,
  95         result_class => $class,
  96     });
  97   }
  98
  99   $class->mk_classdata('result_source_instance')
 100     unless $class->can('result_source_instance');
 101
 102   $class->result_source_instance($table);
 103
 104   return $class->result_source_instance->name;
 105 }
 106
 107 =head2 has_column
 108
 109   if ($obj->has_column($col)) { ... }
 110
 111 Returns 1 if the class has a column of this name, 0 otherwise.
 112
 113 =cut
 114
 115 =head2 column_info
 116
 117   my $info = $obj->column_info($col);
 118
 119 Returns the column metadata hashref for a column. For a description of
 120 the various types of column data in this hashref, see
 121 L<DBIx::Class::ResultSource/add_column>
 122
 123 =cut
 124
 125 =head2 columns
 126
 127   my @column_names = $obj->columns;
 128
 129 =cut
 130
 131 1;
 132
 133 =head1 AUTHOR AND CONTRIBUTORS
 134
 135 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
 136
 137 =head1 LICENSE
 138
 139 You may distribute this code under the same terms as Perl itself.
 140
 141 =cut
 142