Corrected columns_info_for indent level - 2 space indent everyone please, you may...
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSourceProxy / Table.pm
CommitLineData
80c90f5d 1package DBIx::Class::ResultSourceProxy::Table;
cda04c3a 2
3use strict;
4use warnings;
5
80c90f5d 6use base qw/DBIx::Class::ResultSourceProxy/;
fc969005 7__PACKAGE__->load_components(qw/AccessorGroup/);
cda04c3a 8
fc969005 9__PACKAGE__->mk_group_accessors('component_class' => 'table_class');
10__PACKAGE__->table_class('DBIx::Class::ResultSource::Table');
cda04c3a 11
24d67825 12__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do
13 # anything yet!
cda04c3a 14
cda04c3a 15=head1 NAME
16
24d67825 17DBIx::Class::ResultSourceProxy::Table - provides a classdata table
18object and method proxies
cda04c3a 19
20=head1 SYNOPSIS
21
24d67825 22 __PACKAGE__->table('cd');
23 __PACKAGE__->add_columns(qw/cdid artist title year/);
24 __PACKAGE__->set_primary_key('cdid');
cda04c3a 25
26=head1 METHODS
27
cda04c3a 28=head2 add_columns
29
24d67825 30 __PACKAGE__->add_columns(qw/cdid artist title year/);
cda04c3a 31
32Adds columns to the current class and creates accessors for them.
33
34=cut
35
cda04c3a 36=head2 table
37
38 __PACKAGE__->table('tbl_name');
39
40Gets or sets the table name.
41
42=cut
43
44sub table {
45 my ($class, $table) = @_;
b98e75f6 46 return $class->result_source_instance->name unless $table;
cda04c3a 47 unless (ref $table) {
5a879106 48 $table = $class->table_class->new({
24d67825 49 $class->can('result_source_instance') ?
50 %{$class->result_source_instance} : (),
cda04c3a 51 name => $table,
52 result_class => $class,
5a879106 53 });
cda04c3a 54 }
b98e75f6 55 $class->mk_classdata('result_source_instance' => $table);
7fb16f1a 56 if ($class->can('schema_instance')) {
57 $class =~ m/([^:]+)$/;
58 $class->schema_instance->register_class($class, $class);
59 }
cda04c3a 60}
61
988bf309 62=head2 has_column
63
64 if ($obj->has_column($col)) { ... }
65
66Returns 1 if the class has a column of this name, 0 otherwise.
67
68=cut
69
70=head2 column_info
71
72 my $info = $obj->column_info($col);
73
74Returns the column metadata hashref for a column. For a description of
75the various types of column data in this hashref, see
76L<DBIx::Class::ResultSource/add_column>
77
78=cut
cda04c3a 79
d7156e50 80=head2 columns
81
988bf309 82 my @column_names = $obj->columns;
83
84=cut
cda04c3a 85
cda04c3a 861;
87
88=head1 AUTHORS
89
90Matt S. Trout <mst@shadowcatsystems.co.uk>
91
92=head1 LICENSE
93
94You may distribute this code under the same terms as Perl itself.
95
96=cut
97