Updated main docs, altered mail address in POD for 0.01
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Table.pm
index 511f19b..ba79341 100644 (file)
@@ -3,102 +3,36 @@ package DBIx::Class::Table;
 use strict;
 use warnings;
 
-use base qw/Class::Data::Inheritable Class::Accessor DBIx::Class::SQL/;
+use DBIx::Class::ResultSet;
+
+use base qw/Class::Data::Inheritable/;
 
 __PACKAGE__->mk_classdata('_columns' => {});
 
 __PACKAGE__->mk_classdata('_table_name');
 
-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($k => $v);
-    }
-  }
-  $new->{_dirty_columns} = {};
-  return $new;
-}
+__PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
 
-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;
-  $self->{_dirty_columns} = {};
-  return $self;
-}
+__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet');
 
-sub create {
-  my ($class, $attrs) = @_;
-  die "create needs a hashref" unless ref $attrs eq 'HASH';
-  return $class->new($attrs)->insert;
-}
+sub iterator_class { shift->_resultset_class(@_) }
 
-sub update {
-  my ($self) = @_;
-  die "Not in database" unless $self->{_in_database};
-  my @to_update = keys %{$self->{_dirty_columns} || {}};
-  return -1 unless @to_update;
-  my $sth = $self->_get_sth('update', \@to_update,
-                              $self->_table_name, $self->_ident_cond);
-  my $rows = $sth->execute( (map { $self->{_column_data}{$_} } @to_update),
-                  $self->_ident_values );
-  if ($rows == 0) {
-    die "Can't update $self: row not found";
-  } elsif ($rows > 1) {
-    die "Can't update $self: updated more than one row";
-  }
-  $self->{_dirty_columns} = {};
-  return $self;
-}
+=head1 NAME 
 
-sub delete {
-  my $self = shift;
-  if (ref $self) {
-    my $sth = $self->_get_sth('delete', undef,
-                                $self->_table_name, $self->_ident_cond);
-    $sth->execute($self->_ident_values);
-    $sth->finish;
-    delete $self->{_in_database};
-  } else {
-    my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_});
-    my ($cond, $param) = $self->_where_from_hash($query);
-    my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
-    $sth->execute(@$param);
-    $sth->finish;
-  }
-  return $self;
-}
+DBIx::Class::Table - Basic table methods
 
-sub discard_changes {
-  my ($self) = @_;
-  $_[0] = $self->retrieve($self->id);
-}
+=head1 SYNOPSIS
 
-sub get {
-  my ($self, $column) = @_;
-  die "Can't fetch data as class method" unless ref $self;
-  #die "No such column '${column}'" unless $self->_columns->{$column};
-  return $self->{_column_data}{$column} if $self->_columns->{$column};
-  return shift->SUPER::get(@_);
-}
+=head1 DESCRIPTION
 
-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;
-  if ($self->_columns->{$column}) {
-    $self->{_dirty_columns}{$column} = 1;
-    return $self->{_column_data}{$column} = $value;
-  }
-  return shift->SUPER::set(@_);
-}
+This class is responsible for defining and doing basic operations on 
+L<DBIx::Class> objects.
+
+=head1 METHODS
+
+=over 4
+
+=cut
 
 sub _register_columns {
   my ($class, @cols) = @_;
@@ -109,66 +43,149 @@ sub _register_columns {
 
 sub _mk_column_accessors {
   my ($class, @cols) = @_;
-  $class->mk_accessors(@cols);
+  $class->mk_group_accessors('column' => @cols);
 }
 
-sub set_columns {
+=item add_columns
+
+  __PACKAGE__->add_columns(qw/col1 col2 col3/);
+
+Adds columns to the current package, and creates accessors for them
+
+=cut
+
+sub add_columns {
   my ($class, @cols) = @_;
   $class->_register_columns(@cols);
   $class->_mk_column_accessors(@cols);
 }
 
-sub retrieve_from_sql {
+=item search_literal
+
+  my @obj    = $class->search_literal($literal_where_cond, @bind);
+  my $cursor = $class->search_literal($literal_where_cond, @bind);
+
+=cut
+
+sub search_literal {
   my ($class, $cond, @vals) = @_;
   $cond =~ s/^\s*WHERE//i;
-  my @cols = $class->_select_columns;
-  my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
-  $sth->execute(@vals);
-  my @found;
-  while (my @row = $sth->fetchrow_array) {
-    my $new = $class->new;
-    $new->set($_, shift @row) for @cols;
-    $new->{_in_database} = 1;
-    $new->{_dirty_columns} = {};
-    push(@found, $new);
-  }
-  return @found;
+  my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
+  $attrs->{bind} = \@vals;
+  return $class->search(\$cond, $attrs);
+}
+
+=item count_literal
+
+  my $count = $class->count_literal($literal_where_cond);
+
+=cut
+
+sub count_literal {
+  my $class = shift;
+  return $class->search_literal(@_)->count;
+}
+
+=item count
+
+  my $count = $class->count({ foo => 3 });
+
+=cut
+
+sub count {
+  my $class = shift;
+  return $class->search(@_)->count;
 }
 
+=item search 
+
+  my @obj    = $class->search({ foo => 3 });
+  my $cursor = $class->search({ foo => 3 });
+
+=cut
+
 sub search {
-  my $class    = shift;
-  my $where    = ref $_[0] eq "HASH" ? shift: {@_};
-  my ($cond, $param)  = $class->_where_from_hash($where);
-  return $class->retrieve_from_sql($cond, @{$param});
+  my $class = shift;
+  #warn "@_";
+  my $attrs = { };
+  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+    $attrs = { %{ pop(@_) } };
+  }
+  $attrs->{where} = (@_ == 1 || ref $_[0] eq "HASH" ? shift: {@_});
+
+  my $rs = $class->resultset($attrs);
+
+  return (wantarray ? $rs->all : $rs);
+}
+
+sub resultset {
+  my $class = shift;
+
+  my $rs_class = $class->_resultset_class;
+  eval "use $rs_class;";
+  my $rs = $rs_class->new($class, @_);
 }
 
+=item search_like
+
+Identical to search except defaults to 'LIKE' instead of '=' in condition
+
+=cut
+
 sub search_like {
   my $class    = shift;
-  my $where    = ref $_[0] eq "HASH" ? shift: {@_};
-  my ($cond, $param)  = $class->_where_from_hash($where, { cmp => 'like' });
-  return $class->retrieve_from_sql($cond, @{$param});
+  my $attrs = { };
+  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
+    $attrs = pop(@_);
+  }
+  my $query    = ref $_[0] eq "HASH" ? { %{shift()} }: {@_};
+  $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
+  return $class->search($query, { %$attrs });
 }
 
 sub _select_columns {
   return keys %{$_[0]->_columns};
 }
 
-sub copy {
-  my ($self, $changes) = @_;
-  my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
-  $new->set($_ => $changes->{$_}) for keys %$changes;
-  return $new->insert;
+=item table
+
+  __PACKAGE__->table('tbl_name');
+
+=cut
+
+sub table {
+  shift->_table_name(@_);
 }
 
-sub _where_from_hash {
-  my ($self, $query, $opts) = @_;
-  my $op = $opts->{'cmp'} || '=';
-  my $cond = join(' AND ',
-               map { (defined $query->{$_}
-                       ? "$_ $op ?"
-                       : (do { delete $query->{$_}; "$_ IS NULL"; }));
-                   } keys %$query);
-  return ($cond, [ values %$query ]);
+=item find_or_create
+
+  $class->find_or_create({ key => $val, ... });
+
+Searches for a record matching the search condition; if it doesn't find one,
+creates one and returns that instead
+
+=cut
+
+sub find_or_create {
+  my $class    = shift;
+  my $hash     = ref $_[0] eq "HASH" ? shift: {@_};
+  my ($exists) = $class->search($hash);
+  return defined($exists) ? $exists : $class->create($hash);
 }
 
+sub columns { return keys %{shift->_columns}; }
+
 1;
+
+=back
+
+=head1 AUTHORS
+
+Matt S. Trout <mst@shadowcatsystems.co.uk>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
+
+=cut
+