Updated main docs, altered mail address in POD for 0.01
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Table.pm
index 71f41cb..ba79341 100644 (file)
@@ -3,7 +3,7 @@ package DBIx::Class::Table;
 use strict;
 use warnings;
 
-use DBIx::Class::Cursor;
+use DBIx::Class::ResultSet;
 
 use base qw/Class::Data::Inheritable/;
 
@@ -13,9 +13,9 @@ __PACKAGE__->mk_classdata('_table_name');
 
 __PACKAGE__->mk_classdata('table_alias'); # FIXME: Doesn't actually do anything yet!
 
-__PACKAGE__->mk_classdata('_cursor_class' => 'DBIx::Class::Cursor');
+__PACKAGE__->mk_classdata('_resultset_class' => 'DBIx::Class::ResultSet');
 
-sub iterator_class { shift->_cursor_class(@_) }
+sub iterator_class { shift->_resultset_class(@_) }
 
 =head1 NAME 
 
@@ -32,193 +32,8 @@ L<DBIx::Class> objects.
 
 =over 4
 
-=item new
-
-  my $obj = My::Class->new($attrs);
-
-Creates a new object from column => value mappings passed as a hash ref
-
-=cut
-
-sub new {
-  my ($class, $attrs) = @_;
-  $class = ref $class if ref $class;
-  my $new = bless({ _column_data => { } }, $class);
-  if ($attrs) {
-    $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH';
-    while (my ($k, $v) = each %{$attrs}) {
-      $new->store_column($k => $v);
-    }
-  }
-  return $new;
-}
-
-=item insert
-
-  $obj->insert;
-
-Inserts an object into the database if it isn't already in there. Returns
-the object itself.
-
-=cut
-
-sub insert {
-  my ($self) = @_;
-  return $self if $self->in_database;
-  #use Data::Dumper; warn Dumper($self);
-  my $sth = $self->_get_sth('insert', [ keys %{$self->{_column_data}} ],
-                              $self->_table_name, undef);
-  $sth->execute(values %{$self->{_column_data}});
-  $sth->finish;
-  $self->in_database(1);
-  $self->{_dirty_columns} = {};
-  return $self;
-}
-
-=item in_database
-
-  $obj->in_database; # Get value
-  $obj->in_database(1); # Set value
-
-Indicated whether the object exists as a row in the database or not
-
-=cut
-
-sub in_database {
-  my ($self, $val) = @_;
-  $self->{_in_database} = $val if @_ > 1;
-  return $self->{_in_database};
-}
-
-=item create
-
-  my $new = My::Class->create($attrs);
-
-A shortcut for My::Class->new($attrs)->insert;
-
-=cut
-
-sub create {
-  my ($class, $attrs) = @_;
-  $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH';
-  return $class->new($attrs)->insert;
-}
-
-=item update
-
-  $obj->update;
-
-Must be run on an object that is already in the database; issues an SQL
-UPDATE query to commit any changes to the object to the db if required.
-
-=cut
-
-sub update {
-  my ($self) = @_;
-  $self->throw( "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 );
-  $sth->finish;
-  if ($rows == 0) {
-    $self->throw( "Can't update $self: row not found" );
-  } elsif ($rows > 1) {
-    $self->throw("Can't update $self: updated more than one row");
-  }
-  $self->{_dirty_columns} = {};
-  return $self;
-}
-
-=item delete
-
-  $obj->delete
-
-Deletes the object from the database. The object is still perfectly usable
-accessor-wise etc. but ->in_database will now return 0 and the object must
-be re ->insert'ed before it can be ->update'ed
-
-=cut
-
-sub delete {
-  my $self = shift;
-  if (ref $self) {
-    $self->throw( "Not in database" ) unless $self->in_database;
-    #warn $self->_ident_cond.' '.join(', ', $self->_ident_values);
-    my $sth = $self->_get_sth('delete', undef,
-                                $self->_table_name, $self->_ident_cond);
-    $sth->execute($self->_ident_values);
-    $sth->finish;
-    $self->in_database(undef);
-      # Should probably also arrange to trash PK if auto
-  } else {
-    my $attrs = { };
-    if (@_ > 1 && ref $_[$#_] eq 'HASH') {
-      $attrs = { %{ pop(@_) } };
-    }
-    my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_});
-    my ($cond, @param) = $self->_cond_resolve($query, $attrs);
-    my $sth = $self->_get_sth('delete', undef, $self->_table_name, $cond);
-    $sth->execute(@param);
-    $sth->finish;
-  }
-  return $self;
-}
-
-=item get_column
-
-  my $val = $obj->get_column($col);
-
-Fetches a column value
-
-=cut
-
-sub get_column {
-  my ($self, $column) = @_;
-  $self->throw( "Can't fetch data as class method" ) unless ref $self;
-  $self->throw( "No such column '${column}'" ) unless $self->_columns->{$column};
-  return $self->{_column_data}{$column}
-    if exists $self->{_column_data}{$column};
-  return undef;
-}
-
-=item set_column
-
-  $obj->set_column($col => $val);
-
-Sets a column value; if the new value is different to the old the column
-is marked as dirty for when you next call $obj->update
-
 =cut
 
-sub set_column {
-  my $self = shift;
-  my ($column) = @_;
-  my $old = $self->get_column($column);
-  my $ret = $self->store_column(@_);
-  $self->{_dirty_columns}{$column} = 1 unless defined $old && $old eq $ret;
-  return $ret;
-}
-
-=item store_column
-
-  $obj->store_column($col => $val);
-
-Sets a column value without marking it as dirty
-
-=cut
-
-sub store_column {
-  my ($self, $column, $value) = @_;
-  $self->throw( "No such column '${column}'" ) 
-    unless $self->_columns->{$column};
-  $self->throw( "set_column called for ${column} without value" ) 
-    if @_ < 3;
-  return $self->{_column_data}{$column} = $value;
-}
-
 sub _register_columns {
   my ($class, @cols) = @_;
   my $names = { %{$class->_columns} };
@@ -245,40 +60,30 @@ sub add_columns {
   $class->_mk_column_accessors(@cols);
 }
 
-=item retrieve_from_sql
+=item search_literal
 
-  my @obj    = $class->retrieve_from_sql($sql_where_cond, @bind);
-  my $cursor = $class->retrieve_from_sql($sql_where_cond, @bind);
+  my @obj    = $class->search_literal($literal_where_cond, @bind);
+  my $cursor = $class->search_literal($literal_where_cond, @bind);
 
 =cut
 
-sub retrieve_from_sql {
+sub search_literal {
   my ($class, $cond, @vals) = @_;
   $cond =~ s/^\s*WHERE//i;
-  my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
-  my @cols = $class->_select_columns($attrs);
-  my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
-  #warn "$cond @vals";
-  return $class->sth_to_objects($sth, \@vals, \@cols, { where => $cond });
+  my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
+  $attrs->{bind} = \@vals;
+  return $class->search(\$cond, $attrs);
 }
 
-=item count_from_sql
+=item count_literal
 
-  my $count = $class->count($sql_where_cond);
+  my $count = $class->count_literal($literal_where_cond);
 
 =cut
 
-sub count_from_sql {
-  my ($class, $cond, @vals) = @_;
-  $cond =~ s/^\s*WHERE//i;
-  my $attrs = (ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
-  my @cols = 'COUNT(*)';
-  my $sth = $class->_get_sth( 'select', \@cols, $class->_table_name, $cond);
-  #warn "$cond @vals";
-  $sth->execute(@vals);
-  my ($count) = $sth->fetchrow_array;
-  $sth->finish;
-  return $count;
+sub count_literal {
+  my $class = shift;
+  return $class->search_literal(@_)->count;
 }
 
 =item count
@@ -289,38 +94,7 @@ sub count_from_sql {
 
 sub count {
   my $class = shift;
-  my $attrs = { };
-  if (@_ > 1 && ref $_[$#_] eq 'HASH') {
-    $attrs = { %{ pop(@_) } };
-  }
-  my $query    = ref $_[0] eq "HASH" ? shift: {@_};
-  my ($cond, @param)  = $class->_cond_resolve($query, $attrs);
-  return $class->count_from_sql($cond, @param, $attrs);
-}
-
-=item sth_to_objects
-
-  my @obj    = $class->sth_to_objects($sth, \@bind, \@columns, $attrs);
-  my $cursor = $class->sth_to_objects($sth, \@bind, \@columns, $attrs);
-
-=cut
-
-sub sth_to_objects {
-  my ($class, $sth, $args, $cols, $attrs) = @_;
-  my @cols = ((ref $cols eq 'ARRAY') ? @$cols : @{$sth->{NAME_lc}} );
-  my @args = map { ref $_ ? ''.$_ : $_ } @$args; # Stringify objects
-  my $cursor_class = $class->_cursor_class;
-  eval "use $cursor_class;";
-  my $cursor = $cursor_class->new($class, $sth, \@args, \@cols, $attrs);
-  return (wantarray ? $cursor->all : $cursor);
-}
-
-sub _row_to_object { # WARNING: Destructive to @$row
-  my ($class, $cols, $row) = @_;
-  my $new = $class->new;
-  $new->store_column($_, shift @$row) for @$cols;
-  $new->in_database(1);
-  return $new;
+  return $class->search(@_)->count;
 }
 
 =item search 
@@ -332,13 +106,24 @@ sub _row_to_object { # WARNING: Destructive to @$row
 
 sub search {
   my $class = shift;
+  #warn "@_";
   my $attrs = { };
   if (@_ > 1 && ref $_[$#_] eq 'HASH') {
     $attrs = { %{ pop(@_) } };
   }
-  my $query    = ref $_[0] eq "HASH" ? shift: {@_};
-  my ($cond, @param)  = $class->_cond_resolve($query, $attrs);
-  return $class->retrieve_from_sql($cond, @param, $attrs);
+  $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
@@ -353,38 +138,15 @@ sub search_like {
   if (@_ > 1 && ref $_[$#_] eq 'HASH') {
     $attrs = pop(@_);
   }
-  return $class->search(@_, { %$attrs, cmp => 'LIKE' });
+  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};
 }
 
-=item copy
-
-  my $copy = $orig->copy({ change => $to, ... });
-
-=cut
-
-sub copy {
-  my ($self, $changes) = @_;
-  my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self);
-  $new->set_column($_ => $changes->{$_}) for keys %$changes;
-  return $new->insert;
-}
-
-#sub _cond_resolve {
-#  my ($self, $query, $attrs) = @_;
-#  return '1 = 1' unless keys %$query;
-#  my $op = $attrs->{'cmp'} || '=';
-#  my $cond = join(' AND ',
-#               map { (defined $query->{$_}
-#                       ? "$_ $op ?"
-#                       : (do { delete $query->{$_}; "$_ IS NULL"; }));
-#                   } keys %$query);
-#  return ($cond, values %$query);
-#}
-
 =item table
 
   __PACKAGE__->table('tbl_name');
@@ -411,39 +173,7 @@ sub find_or_create {
   return defined($exists) ? $exists : $class->create($hash);
 }
 
-=item insert_or_update
-
-  $obj->insert_or_update
-
-Updates the object if it's already in the db, else inserts it
-
-=cut
-
-sub insert_or_update {
-  my $self = shift;
-  return ($self->in_database ? $self->update : $self->insert);
-}
-
-=item retrieve_all
-
-  my @all = $class->retrieve_all;
-
-=cut
-
-sub retrieve_all {
-  my ($class) = @_;
-  return $class->retrieve_from_sql( '1' );
-}
-
-=item is_changed
-
-  my @changed_col_names = $obj->is_changed
-
-=cut
-
-sub is_changed {
-  return keys %{shift->{_dirty_columns} || {}};
-}
+sub columns { return keys %{shift->_columns}; }
 
 1;
 
@@ -451,7 +181,7 @@ sub is_changed {
 
 =head1 AUTHORS
 
-Matt S. Trout <perl-stuff@trout.me.uk>
+Matt S. Trout <mst@shadowcatsystems.co.uk>
 
 =head1 LICENSE