X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FTable.pm;h=d824b0adb4c173d9f80101008563c1adffc8fd41;hb=d7156e507aaffa832df977118f015e0833bc87ff;hp=9556eb911a87435ac7ee2c7e2510883658a6e05b;hpb=ea2e61bf5bb7187dc5e56513cd66c272d71d5074;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm index 9556eb9..d824b0a 100644 --- a/lib/DBIx/Class/Table.pm +++ b/lib/DBIx/Class/Table.pm @@ -3,96 +3,149 @@ package DBIx::Class::Table; use strict; use warnings; -use base qw/Class::Data::Inheritable Class::Accessor DBIx::Class::SQL/; +use DBIx::Class::ResultSet; -__PACKAGE__->mk_classdata('_columns' => {}); +use Carp qw/croak/; -__PACKAGE__->mk_classdata('_primaries' => {}); +use base qw/DBIx::Class/; +__PACKAGE__->load_components(qw/AccessorGroup/); -__PACKAGE__->mk_classdata('_table_name'); +__PACKAGE__->mk_group_accessors('simple' => + qw/_columns _primaries name resultset_class result_class storage/); + +=head1 NAME + +DBIx::Class::Table - Table object + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +This class is responsible for defining and doing table-level operations on +L classes. + +=head1 METHODS + +=cut sub new { my ($class, $attrs) = @_; $class = ref $class if ref $class; - my $new = bless({ _column_data => { } }, $class); - if ($attrs) { - die "Attrs must be a hashref" unless ref($attrs) eq 'HASH'; - while (my ($k, $v) = each %{$attrs}) { - $new->set_column($k => $v); - } - } + my $new = bless({ %{$attrs || {}} }, $class); + $new->{resultset_class} ||= 'DBIx::Class::ResultSet'; + $new->{_columns} ||= {}; + $new->{name} ||= "!!NAME NOT SET!!"; + return $new; } -sub insert { - my ($self) = @_; - return if $self->{_in_database}; - my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ], - $self->_table_name, undef); - $sth->execute(values %{$self->{_column_data}}); - $self->{_in_database} = 1; - return $self; +sub add_columns { + my ($self, @cols) = @_; + while (my $col = shift @cols) { + $self->_columns->{$col} = (ref $cols[0] ? shift : {}); + } } -sub create { - my ($class, $attrs) = @_; - return $class->new($attrs)->insert; -} +*add_column = \&add_columns; -sub update { - my ($self) = @_; - die "Not in database" unless $self->{_in_database}; - my @to_update = keys %{$self->{_dirty_columns} || {}}; - my $sth = $self->_get_sth('update', \@to_update, - $self->_table_name, $self->_ident_cond); - $sth->execute( (map { $self->{_column_data}{$_} } @to_update), - $self->_ident_values ); - $self->{_dirty_columns} = {}; - return $self; -} +=head2 add_columns + + $table->add_columns(qw/col1 col2 col3/); + + $table->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...); + +Adds columns to the table object. If supplied key => hashref pairs uses +the hashref as the column_info for that column. + +=head2 add_column + + $table->add_column('col' => \%info?); -sub delete { - my ($self) = @_; - my $sth = $self->_get_sth('delete', undef, - $self->_table_name, $self->_ident_cond); - $sth->execute($self->_ident_values); - delete $self->{_in_database}; - return $self; +Convenience alias to add_columns + +=cut + +sub resultset { + my $self = shift; + my $rs_class = $self->resultset_class; + eval "use $rs_class;"; + return $rs_class->new($self); } -sub get { +=head2 has_column + + if ($obj->has_column($col)) { ... } + +Returns 1 if the table has a column of this name, 0 otherwise. + +=cut + +sub has_column { my ($self, $column) = @_; - die "No such column '${column}'" unless $self->_columns->{$column}; - return $self->{_column_data}{$column}; + return exists $self->_columns->{$column}; } -sub set { - my ($self, $column, $value) = @_; - die "No such column '${column}'" unless $self->_columns->{$column}; - die "set_column called for ${column} without value" if @_ < 3; - $self->{_dirty_columns}{$column} = 1; - return $self->{_column_data}{$column} = $value; -} +=head2 column_info + + my $info = $obj->column_info($col); + +Returns the column metadata hashref for a column. + +=cut -sub _ident_cond { - my ($class) = @_; - return join(" AND ", map { "$_ = ?" } keys %{$class->_primaries}); +sub column_info { + my ($self, $column) = @_; + croak "No such column $column" unless exists $self->_columns->{$column}; + return $self->_columns->{$column}; } -sub _ident_values { - my ($self) = @_; - return (map { $self->{_column_data}{$_} } keys %{$self->_primaries}); +=head2 columns + + my @column_names = $obj->columns; + +=cut + +sub columns { + croak "columns() is a read-only accessor, did you mean add_columns()?" if (@_ > 1); + return keys %{shift->_columns}; } -sub _register_columns { - my ($class, @cols) = @_; - my $names = { %{$class->_columns} }; - $names->{$_} ||= {} for @cols; - $class->_columns($names); +=head2 set_primary_key(@cols) + +Defines one or more columns as primary key for this table. Should be +called after C. + +=cut + +sub set_primary_key { + my ($self, @cols) = @_; + # check if primary key columns are valid columns + for (@cols) { + $self->throw("No such column $_ on table ".$self->name) + unless $self->has_column($_); + } + $self->_primaries(\@cols); } -sub _mk_column_accessors { - my ($class, @cols) = @_; - $class->mk_accessors(@cols); +=head2 primary_columns + +Read-only accessor which returns the list of primary keys. + +=cut + +sub primary_columns { + return @{shift->_primaries||[]}; } + 1; + +=head1 AUTHORS + +Matt S. Trout + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut +