Explicit exception clarifying that $rsrc->from() is not a setter
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSource / Table.pm
1 package DBIx::Class::ResultSource::Table;
2
3 use strict;
4 use warnings;
5
6 use DBIx::Class::ResultSet;
7
8 use base qw/DBIx::Class/;
9 __PACKAGE__->load_components(qw/ResultSource/);
10
11 =head1 NAME
12
13 DBIx::Class::ResultSource::Table - Table object
14
15 =head1 SYNOPSIS
16
17 =head1 DESCRIPTION
18
19 Table object that inherits from L<DBIx::Class::ResultSource>.
20
21 =head1 METHODS
22
23 =head2 from
24
25 Returns the FROM entry for the table (i.e. the table name)
26
27 =cut
28
29 sub from {
30   $_[0]->throw_exception('from() is not a setter method') if @_ > 1;
31   $_[0]->name;
32 }
33
34 =head1 FURTHER QUESTIONS?
35
36 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
37
38 =head1 COPYRIGHT AND LICENSE
39
40 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
41 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
42 redistribute it and/or modify it under the same terms as the
43 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
44
45 =cut
46
47 1;